Seminar Material for MkDocs – Suche, Tags, Blog und Metadaten

Mit wachsendem Umfang reichen Navigation und Volltextsuche allein nicht mehr aus. Suchkonfiguration, kontrollierte Tags, strukturierte Metadaten und zeitbezogene Blog-Inhalte müssen gemeinsam geplant werden, damit relevante Informationen auffindbar und pflegbar bleiben.

Inhaltsübersicht

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

Zielsetzung

Es entsteht ein abgestimmtes Modell für Suche, Tags, Seitenmetadaten und redaktionelle Veröffentlichungen. Suchqualität und Metadatenpflege werden mit einem wiederholbaren Testverfahren abgesichert.

Zielgruppe

Technische Redaktionen, Wissensmanager, Informationsarchitekten, Produktkommunikation und Portalverantwortliche.

Voraussetzungen

Grundkenntnisse in MkDocs und YAML; Erfahrung mit redaktionellen Workflows ist hilfreich.

Seminarinhalte

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

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.

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.

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.

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

• Ein kontrolliertes Tag- und Metadatenmodell entwerfen
• Blog, Archive und Kategorien für einen Veröffentlichungsprozess konfigurieren
• Suchaufgaben definieren und Trefferqualität systematisch bewerten

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.