Seminar Material for MkDocs – Barrierefreiheit, UX und responsive Dokumentation

Zugängliche Dokumentation entsteht nicht durch eine nachträgliche Einzelprüfung, sondern durch klare Struktur, robuste Komponenten und wiederholbare Qualitätskontrollen. Das Seminar verbindet Bedienbarkeit, semantisches HTML, responsive Darstellung, Druck- und Offline-Anforderungen zu einem durchgängigen Prüfverfahren.

Inhaltsübersicht

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

Zielsetzung

Es entsteht ein belastbarer Prüfkatalog, mit dem typische Dokumentationsseiten schrittweise bewertet, verbessert und für die redaktionelle sowie technische Abnahme vorbereitet werden.

Zielgruppe

Technische Redaktionen, UX-Verantwortliche, Webentwickler, Qualitätsmanager und Betreiber von Dokumentationsportalen.

Voraussetzungen

Grundkenntnisse in Markdown und im Aufbau statischer Dokumentationsseiten; HTML- und CSS-Grundlagen sind hilfreich.

Seminarinhalte

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

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.

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.

HTML-, Barriere- und Regressionstests

1. Schritt 1: Erzeugte Seiten auf erwartete Titel, Metadaten und Navigation prüfen.
2. Schritt 2: Semantische HTML-Struktur, eindeutige IDs und Alternativtexte kontrollieren.
3. Schritt 3: Kritische Seitentypen und Bildschirmgrößen für visuelle Vergleiche auswählen.
4. Schritt 4: Beabsichtigte und fehlerhafte Darstellungsänderungen nachvollziehbar unterscheiden.

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 bestehende Seite semantisch und per Tastatur prüfen
• Eine komplexe Tabelle und einen Codeblock für kleine Displays überarbeiten
• Einen kombinierten manuellen und automatisierten Abnahmeplan erstellen

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.