Seminar Docusaurus – Intensivseminar: Content Operations und Redaktion

Inhaltsübersicht

1. Zielsetzung
2. Schritt 1: Plattformmodell und Projektbasis verstehen
3. Schritt 2: Informationsarchitektur und Content-Modell entwickeln
4. Schritt 3: Markdown, MDX und Komponenten beherrschen
5. Schritt 4: Docs-as-Code-Workflow und Governance aufbauen
6. Schritt 5: Versionen und Release-Kommunikation steuern
7. Schritt 6: Sprachen und Übersetzungsprozesse koordinieren
8. Schritt 7: API- und strukturierte Inhalte integrieren
9. Schritt 8: Branding, Custom Pages und Interaktion einordnen
10. Schritt 9: Suche, Metadaten und Barrierefreiheit verbessern
11. Schritt 10: Sicherheit und Datenschutz kontrollieren
12. Schritt 11: Qualität, Performance und CI/CD verbinden
13. Schritt 12: Migration, Wartung und Architekturentscheidungen steuern
14. Praxisphasen
15. Zielgruppe und Voraussetzungen

Zielsetzung

Das viertägige Intensivseminar fasst das gesamte Docusaurus-Portfolio aus Sicht von Content Operations, technischer Redaktion und Plattformkoordination zusammen. Neben Content Engineering und Governance werden die technischen Grundlagen von Architektur, Komponenten, Plugins, Versionen, Sprachen, Suche, Qualität, Sicherheit, Deployment, Performance, Migration und Betrieb praktisch vermittelt.

• Docusaurus fachlich, redaktionell und technisch als Gesamtplattform steuern
• Content-Modelle, Workflows und Governance mit der Systemarchitektur verbinden
• Versionen, Sprachen, Suche, API-Inhalte und Komponenten kontrolliert betreiben
• Qualität, Sicherheit, CI/CD, Wartung und Weiterentwicklung in einem gemeinsamen Betriebsmodell verankern

Seminarinhalte

Schritt 1: Plattformmodell und Projektbasis verstehen

Docusaurus wird als statisch generierte, React-basierte Content-Plattform eingeordnet. Projektstruktur, Konfiguration, Plugins, Themes, Build und Hosting werden soweit vertieft, dass redaktionelle und technische Entscheidungen sicher abgestimmt werden können.

• Systemgrenzen und Rollenmodell definieren
• Projektstruktur und zentrale Konfiguration lesen
• Build- und Veröffentlichungsweg nachvollziehen

Schritt 2: Informationsarchitektur und Content-Modell entwickeln

Zielgruppen, Aufgaben, Inhaltstypen, Taxonomie, IDs, Slugs und Sidebars werden zu einer stabilen Struktur verbunden. Landingpages und Querverweise unterstützen klar definierte Nutzungspfade.

• Zielgruppen- und Aufgabenmatrix erstellen
• Inhaltstypen und Metadaten standardisieren
• Navigation und Sidebars kuratieren

Schritt 3: Markdown, MDX und Komponenten beherrschen

Redaktionell verständliches Markdown wird mit gezielt eingesetzten MDX-Komponenten kombiniert. Komponentenverträge, Props, statische Ausgabe, Zugänglichkeit und Freigaberegeln verhindern unwartbare Sonderlösungen.

• strukturierte technische Inhalte erstellen
• Komponenten sicher importieren und verwenden
• zulässige Bausteine in einem Katalog dokumentieren

Schritt 4: Docs-as-Code-Workflow und Governance aufbauen

Issue, Branch, Vorschau, Review, Freigabe und Veröffentlichung bilden einen durchgängigen Prozess. Rollen, Eigentümerschaft, Aktualitätsfristen und Änderungstypen werden verbindlich geregelt.

• Workflow- und Review-Matrix entwerfen
• Vorlagen und Definition-of-Done erstellen
• Pflege- und Eskalationsregeln festlegen

Schritt 5: Versionen und Release-Kommunikation steuern

Produktstände, Dokumentations-Snapshots, Release Notes und zeitbezogene Mitteilungen werden nach Zweck und Supportdauer organisiert. Korrekturen und Ablösung älterer Stände erhalten nachvollziehbare Regeln.

• Versionsstrategie und Snapshot-Prozess definieren
• Release Notes mit dauerhaften Inhalten verbinden
• Archivierung und Weiterleitungen planen

Schritt 6: Sprachen und Übersetzungsprozesse koordinieren

Locale-Konfiguration, Theme-Texte, Dokumente, Navigation und sprachspezifische Builds werden als gemeinsamer Prozess betrachtet. Übersetzungsstatus und Versionierung bleiben transparent.

• Locale-Strategie und Geltungsbereich festlegen
• Übersetzungsworkflow und Qualitätsgates definieren
• Version-Locale-Matrix pflegen

Schritt 7: API- und strukturierte Inhalte integrieren

Generierte API-Beschreibungen werden mit Aufgabenanleitungen, Konzepten und Beispielen verbunden. Stabile IDs, klare Quellverantwortung und automatisierte Prüfungen sichern Aktualität und Verständlichkeit.

• Quellen und Generierungsgrenzen bestimmen
• API-Inhalte in Navigation und Versionen einordnen
• Freigabe und Datenschutz für Beispiele regeln

Schritt 8: Branding, Custom Pages und Interaktion einordnen

Design-Tokens, CSS, Theme-Anpassungen, freie Seiten und interaktive Komponenten werden nach Nutzen und Wartungsrisiko bewertet. Wrapping und kleine Komponenten werden riskanten Kopien vorgezogen.

• Branding über zentrale Tokens umsetzen
• Custom Pages und Client-Grenzen verstehen
• Swizzle-Entscheidungen dokumentieren

Schritt 9: Suche, Metadaten und Barrierefreiheit verbessern

Auffindbarkeit und zugängliche Nutzung werden bereits im Content-Modell verankert. Titel, Beschreibungen, Sitemap, Suchtests, Semantik, Tastatur und Kontrast erhalten gemeinsame Qualitätskriterien.

• Suchkatalog und Metadatenregeln erstellen
• kritische Nutzerpfade auf Barrieren prüfen
• redaktionelle Checklisten integrieren

Schritt 10: Sicherheit und Datenschutz kontrollieren

Inhaltsklassifikation, Geheimnisse, Vorschauen, Drittkomponenten und statisches Hosting werden anhand eines einfachen Bedrohungsmodells bewertet. Technische und organisatorische Kontrollen werden gemeinsam dokumentiert.

• Daten- und Komponenteninventar erstellen
• Freigabe für Drittkomponenten definieren
• Vorschau- und Veröffentlichungsregeln absichern

Schritt 11: Qualität, Performance und CI/CD verbinden

Linting, Links, Build, Suchtests und Content-Gates laufen in einer reproduzierbaren Pipeline. Build-Zeit und Artefaktgröße werden beobachtet, ohne redaktionelle Prozesse unnötig zu verlangsamen.

• Prüfkette und Schweregrade festlegen
• Vorschau und unveränderliches Artefakt einsetzen
• Performance-Budgets und Rollback definieren

Schritt 12: Migration, Wartung und Architekturentscheidungen steuern

Upgrades, Monorepo-Fragen, mehrere Docs-Bereiche, Plugins und Skalierung werden anhand eines Entscheidungsrahmens behandelt. Ein Betriebsleitfaden verbindet Aktualisierung, Fehleranalyse und Weiterentwicklung.

• Upgrade- und Troubleshooting-Checkliste erstellen
• Architektur- und Erweiterungsentscheidungen dokumentieren
• Roadmap und Review-Zeitpunkte festlegen

Praxisphasen

Die einzelnen Arbeitsschritte werden an einer durchgängigen Übungsplattform umgesetzt. Konfigurationen, Inhalte und Prüfungen werden schrittweise erweitert und jeweils mit einem produktionsnahen Build kontrolliert.

• Entwicklung eines vollständigen Content-Operations-Modells mit Struktur, Rollen, Workflow und Qualitätsgates
• Aufbau einer mehrsprachigen, versionierten Übungssite mit Komponenten, Suche, Metadaten und API-Bereich
• Entwurf einer CI/CD-, Sicherheits-, Wartungs- und Weiterentwicklungsroadmap für den produktiven Betrieb

Zielgruppe und Voraussetzungen

Zielgruppe: Technische Redaktionen, Documentation Manager, Content Operations, Product Owner, Plattformkoordinatoren und Documentation Engineers

Voraussetzungen: Grundkenntnisse in Markdown und Git; technische Grundlagen zu Docusaurus oder statischen Sites sind hilfreich, werden jedoch im Seminar konsolidiert