Seminar MkDocs – Mehrsprachige Dokumentation und Lokalisierung

Mehrsprachigkeit betrifft nicht nur übersetzte Fließtexte. Navigation, URLs, Suche, Theme-Texte, Metadaten, Medien, Freigaben und die Synchronität zwischen Sprachständen müssen gemeinsam geplant werden.

Inhaltsübersicht

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

Zielsetzung

Ein zweisprachiger Prototyp wird mit klarer Quellen- und URL-Strategie aufgebaut. Übersetzungsstatus, Fallbacks, Reviews und automatisierte Synchronitätsprüfungen werden in einen nachvollziehbaren Workflow überführt.

Zielgruppe

Technische Redaktionen, Lokalisierungsverantwortliche, Produktteams, Informationsarchitekten und Plattformadministratoren.

Voraussetzungen

Grundkenntnisse in MkDocs, Markdown und YAML; Erfahrung mit Übersetzungsprozessen ist hilfreich.

Seminarinhalte

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

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.

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.

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

• Eine Sprach- und URL-Strategie für ein bestehendes Portal festlegen
• Sprachspezifische Navigation, Metadaten und Suche konfigurieren
• Übersetzungsstatus und Synchronitätsprüfung in einen Review-Prozess integrieren

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.