Seminar MkDocs – Informationsarchitektur und große Dokumentationsportale

Große Portale scheitern selten am Markdown-Format, sondern an unklaren Zielgruppen, gewachsenen Strukturen, Dubletten und fehlender Verantwortung. Das Seminar verbindet Bestandsanalyse, Taxonomie, Navigation, modulare Quellen und Governance.

Inhaltsübersicht

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

Zielsetzung

Für einen umfangreichen Beispielbestand wird eine belastbare Zielarchitektur entwickelt. Dazu gehören Inhaltsinventar, Seitentypen, Taxonomie, Navigationsmodell, Repository-Grenzen, Migrationsschritte und Pflegeverantwortung.

Zielgruppe

Informationsarchitekten, technische Redaktionsleitungen, Wissensmanager, Produktverantwortliche und Plattformteams mit umfangreichen Dokumentationsbeständen.

Voraussetzungen

Erfahrung mit technischer Dokumentation und grundlegendes Verständnis von MkDocs-Projekten; keine Programmierkenntnisse erforderlich.

Seminarinhalte

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

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.

Große Portale und modulare Quellen

1. Schritt 1: Repository-Grenzen, Verzeichnisse und Eigentümerschaft für mehrere Teams festlegen.
2. Schritt 2: Gemeinsame Inhalte, Produktvarianten und Medien kontrolliert voneinander trennen.
3. Schritt 3: Navigation und Konfiguration für große Bestände wartbar modularisieren.
4. Schritt 4: Pilotmigration und schrittweisen Umbau mit stabilen Pfaden planen.

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.

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.

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.

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.

Migrationsentscheidung, Pilot und Umschaltung

1. Schritt 1: Weiterbetrieb, Upgrade und Plattformwechsel anhand gewichteter Kriterien vergleichen.
2. Schritt 2: Repräsentativen Pilotbereich mit begrenztem Risiko auswählen.
3. Schritt 3: Inhalte, Konfiguration, Theme, Plugins und Pipeline als getrennte Stränge behandeln.
4. Schritt 4: Parallelbetrieb, Umschaltung, Rollback und nächsten Entscheidungstermin dokumentieren.

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.

Praxisübungen

• Einen heterogenen Bestand inventarisieren und nach Seitentypen klassifizieren
• Taxonomie und Zielnavigation anhand von Nutzeraufgaben entwerfen
• Eine schrittweise Migration mit Eigentümerschaft und Qualitäts-Gates planen

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.