Seminar MkDocs – Intensivseminar Autoren, Redaktion und Informationsarchitektur

Das Intensivformat bündelt die redaktionellen und konzeptionellen Themen für hochwertige technische Dokumentation. Von Markdown und Seitentypen über Informationsarchitektur, Navigation und Komponenten bis zu Suche, Metadaten, Mehrsprachigkeit, Barrierefreiheit und Governance entsteht ein vollständiger Redaktionsprozess.

Inhaltsübersicht

• Zielsetzung
• Zielgruppe
• Voraussetzungen
• Seminarinhalte
• Praxisübungen
• Methodik

Zielsetzung

Ein umfangreicher Beispielbestand wird analysiert, neu strukturiert, redaktionell überarbeitet und als nutzerorientiertes Material-for-MkDocs-Portal umgesetzt. Qualitäts-, Review- und Pflegeprozesse werden direkt in das Projekt integriert.

Zielgruppe

Technische Redaktionen, Informationsarchitekten, Wissensmanager, Trainer, Supportteams und redaktionelle Projektleitungen.

Voraussetzungen

Grundkenntnisse in Markdown und technischer Dokumentation; erste Git- oder MkDocs-Erfahrung ist hilfreich.

Seminarinhalte

Die Themen werden in einer festen Arbeitsfolge aus Analyse, Einrichtung, Umsetzung und Prüfung bearbeitet.

Technisches Markdown und Seitentypen

1. Schritt 1: Überschriften, Listen, Links, Bilder, Tabellen und Code semantisch korrekt einsetzen.
2. Schritt 2: Anleitungen mit Voraussetzungen, nummerierten Schritten und Prüfergebnis strukturieren.
3. Schritt 3: Konzepte, Referenzen, Tutorials und Fehlerbehebungen klar unterscheiden.
4. Schritt 4: Interne Verweise und Medienpfade relativ, stabil und wartbar aufbauen.

Informationsarchitektur und Taxonomie

1. Schritt 1: Zielgruppen, Aufgaben und fachliche Inhaltsarten voneinander trennen.
2. Schritt 2: Bestand inventarisieren sowie Dubletten, Lücken und veraltete Inhalte markieren.
3. Schritt 3: Taxonomie, Terminologie und kontrollierte Metadaten entwickeln.
4. Schritt 4: Zielstruktur mit Karten-Sortierung und Nutzungsszenarien validieren.

Navigation und Benutzerführung

1. Schritt 1: Nutzeraufgaben, Einstiegspunkte und erwartete Informationswege erfassen.
2. Schritt 2: Explizite Navigation mit sinnvoller Tiefe, Gruppierung und Reihenfolge aufbauen.
3. Schritt 3: Seitennavigation, Inhaltsverzeichnis, Tabs und Abschnittsübersichten abstimmen.
4. Schritt 4: Navigation anhand realer Such- und Arbeitsaufgaben überprüfen.

Erweiterte Inhaltskomponenten

1. Schritt 1: Hinweise, Details, Tabs, Grids und Annotationen nach fachlichem Zweck auswählen.
2. Schritt 2: Codeblöcke mit Sprache, Markierung, Zeilennummern und erklärenden Anmerkungen gestalten.
3. Schritt 3: Tabellen, Aufgabenlisten, Definitionen und Fußnoten konsistent einsetzen.
4. Schritt 4: Komponentenregeln gegen Überladung und uneinheitliche Verwendung formulieren.

Wiederverwendung und Snippets

1. Schritt 1: Wiederkehrende Inhalte und gemeinsame Warnhinweise identifizieren.
2. Schritt 2: Bausteine in nachvollziehbare Snippet-Dateien auslagern und benennen.
3. Schritt 3: Varianten ohne unübersichtliche Einbindungsketten organisieren.
4. Schritt 4: Änderungen an gemeinsam genutzten Bausteinen mit Referenzseiten absichern.

Suche und Auffindbarkeit

1. Schritt 1: Fachbegriffe, Synonyme, Fehlvarianten und zentrale Suchaufgaben erfassen.
2. Schritt 2: Suchsprache, Indexierung, Gewichtung und Ausschlüsse passend konfigurieren.
3. Schritt 3: Seitentitel, Überschriften und Metadaten auf Suchrelevanz prüfen.
4. Schritt 4: Suchqualität mit einem wiederholbaren Testkatalog messen.

Tags und Metadatenmodell

1. Schritt 1: Pflichtfelder für Status, Zielgruppe, Produkt, Version und Verantwortung festlegen.
2. Schritt 2: Erlaubte Werte, Fallbacks und Pflegeverantwortung dokumentieren.
3. Schritt 3: Ein kontrolliertes Tag-Vokabular statt freier Schlagwortsammlungen aufbauen.
4. Schritt 4: Metadaten in Übersichten, Suche, Templates und Qualitätsprüfungen nutzen.

Blog, Kategorien und redaktioneller Workflow

1. Schritt 1: Dauerhafte Dokumentation und zeitbezogene Meldungen eindeutig trennen.
2. Schritt 2: Blog-Verzeichnis, Beiträge, Kategorien, Archive und Pagination konfigurieren.
3. Schritt 3: Entwurf, Review, Freigabe, Veröffentlichung und Archivierung als Statusmodell abbilden.
4. Schritt 4: Publikationsrhythmus und Verantwortlichkeit für laufende Inhalte festlegen.

Lokalisierung und Sprachvarianten

1. Schritt 1: Locale, Zielsprache, URL-Struktur und Fallback-Verhalten festlegen.
2. Schritt 2: Sprachspezifische Navigation und Theme-Texte vollständig abbilden.
3. Schritt 3: Übersetzbare Zeichenketten, Terminologie und Metadaten kontrolliert pflegen.
4. Schritt 4: Sprachvarianten mit getrennten Builds und Referenztests prüfen.

Übersetzungsworkflow und Synchronität

1. Schritt 1: Quell- und Zielseiten eindeutig einander zuordnen.
2. Schritt 2: Status für neu, in Übersetzung, geprüft und veraltet definieren.
3. Schritt 3: Fachliche, sprachliche und technische Freigabe getrennt organisieren.
4. Schritt 4: Fehlende oder veraltete Übersetzungen automatisiert erkennen.

Barrierefreiheit und zugängliche Struktur

1. Schritt 1: Überschriften, Listen, Tabellen und Landmarken semantisch korrekt strukturieren.
2. Schritt 2: Tastaturwege, Fokusreihenfolge und verständliche Interaktionen prüfen.
3. Schritt 3: Kontraste, Typografie, Zoomverhalten und nichtfarbliche Kennzeichnung bewerten.
4. Schritt 4: Automatisierte Prüfungen mit manueller Abnahme kombinieren.

Responsive, Druck- und Offline-Nutzung

1. Schritt 1: Kritische Seitentypen auf kleinen, mittleren und breiten Ansichten prüfen.
2. Schritt 2: Tabellen, Codeblöcke, Navigation und Diagramme für schmale Displays anpassen.
3. Schritt 3: Druckansicht und offline nutzbare Such- sowie Asset-Strukturen kontrollieren.
4. Schritt 4: Abweichungen nach Schweregrad und Reichweite priorisieren.

Qualitätsmodell und Prüfstrategie

1. Schritt 1: Inhaltliche, strukturelle, technische, visuelle und betriebliche Fehler unterscheiden.
2. Schritt 2: Fehler nach Auswirkung, Erkennbarkeit und Korrekturaufwand priorisieren.
3. Schritt 3: Lokale Prüfung, Review-Gate und vollständige Pipeline-Prüfung trennen.
4. Schritt 4: Akzeptanzkriterien und zeitlich begrenzte Ausnahmen dokumentieren.

Branches, Review und Konfliktlösung

1. Schritt 1: Branches nach Zweck und begrenzter Lebensdauer verwenden.
2. Schritt 2: Reviews für Inhalt, Technik, Terminologie und Darstellung getrennt durchführen.
3. Schritt 3: Konflikte in Navigation und Text fachlich vor der technischen Auflösung klären.
4. Schritt 4: Nach dem Zusammenführen Build, Links und Seitendarstellung erneut prüfen.

Governance und Pflegeprozess

1. Schritt 1: Eigentümerschaft, Review-Intervall und Freigabestufe pro Bereich festlegen.
2. Schritt 2: Verfallsdaten, Archivierung und Kennzeichnung veralteter Inhalte definieren.
3. Schritt 3: Änderungsprozesse zwischen Redaktion, Entwicklung und Betrieb koordinieren.
4. Schritt 4: Kennzahlen und regelmäßige Bestandsbereinigung etablieren.

Praxisübungen

• Einen Bestand inventarisieren und eine aufgabenorientierte Zielstruktur entwickeln
• Mehrere Seitentypen mit verbindlichen Komponenten- und Metadatenregeln erstellen
• Review, Übersetzung, Qualitätssicherung und laufende Pflege als Prozess abbilden

Methodik

Fachliche Einführung, nachvollziehbare Demonstration, angeleitete Umsetzung, selbstständige Übungsphasen, strukturierte Fehleranalyse und gemeinsame Qualitätskontrolle wechseln einander ab. Alle Arbeitsschritte werden an einem zusammenhängenden Beispielprojekt durchgeführt.