Seminar MkDocs und Material for MkDocs

Das Schulungsprogramm verbindet technische Redaktion, Informationsarchitektur, Gestaltung, Entwicklung und Betrieb zu einem abgestuften Qualifizierungsangebot. Einzelthemen lassen sich gezielt auswählen; Kompakt- und Intensivformate bündeln mehrere Bereiche in einem zusammenhängenden Projekt.

Inhaltsübersicht

• Portfolio und Schwerpunkte
• Empfohlene Reihenfolge
• Lernpfad Redaktion und Informationsarchitektur
• Lernpfad Administration und Automatisierung
• Lernpfad Entwicklung und Gestaltung
• Kompakt- und Intensivformate
• Auswahlkriterien

Portfolio und Schwerpunkte

Das Angebot umfasst Grundlagen, Docs-as-Code, Konfiguration, redaktionelle Komponenten, Suche und Metadaten, Informationsarchitektur, Mehrsprachigkeit, Barrierefreiheit, Qualitätssicherung, API-Dokumentation, Plugin- und Theme-Entwicklung, CI/CD, Betrieb, Sicherheit, Versionierung sowie Lebenszyklus- und Migrationsplanung.

Empfohlene Reihenfolge

1. Einstieg: MkDocs – Grundlagen, Installation und Projektstart (2 Tage)
2. Zusammenarbeit: MkDocs – Docs-as-Code mit Git (2 Tage)
3. Struktur: MkDocs – Konfiguration, Navigation und Projektstruktur (2 Tage)
4. Rollenbezogene Vertiefung: Material for MkDocs – Erweiterte Markdown-Komponenten (2 Tage)
5. Produktionsreife: MkDocs – Qualitätssicherung, Tests und Linkprüfung (2 Tage)
6. Langfristiger Betrieb: MkDocs – Lebenszyklus, Upgrade und Migrationsplanung (2 Tage)

Lernpfad Redaktion und Informationsarchitektur

1. Material for MkDocs – Erweiterte Markdown-Komponenten
2. Material for MkDocs – Design, Navigation und Benutzerführung
3. MkDocs – Informationsarchitektur und große Dokumentationsportale
4. Material for MkDocs – Suche, Tags, Blog und Metadaten
5. MkDocs – Mehrsprachige Dokumentation und Lokalisierung
6. Material for MkDocs – Barrierefreiheit, UX und responsive Dokumentation

Lernpfad Administration und Automatisierung

1. MkDocs – CI/CD, Build und Deployment
2. MkDocs – Betrieb, Fehleranalyse und Wartung
3. MkDocs – Sicherheit, Datenschutz und Compliance
4. MkDocs – Versionierte Dokumentation und Release-Portale
5. MkDocs – Lebenszyklus, Upgrade und Migrationsplanung

Lernpfad Entwicklung und Gestaltung

1. MkDocs – API-Dokumentation und Code-Referenzen
2. MkDocs – Eigene Plugins mit Python entwickeln
3. MkDocs – Eigene Themes mit Jinja2 entwickeln
4. Material for MkDocs – Branding, CSS, JavaScript und Theme Overrides

Kompakt- und Intensivformate

Das dreitägige Kompaktseminar vermittelt den produktionsnahen Kernworkflow. Drei fünftägige Intensivseminare bündeln die redaktionelle Perspektive, die technische Plattformperspektive und den vollständigen End-to-End-Überblick. Spezialseminare bleiben für Themen vorgesehen, die in den verdichteten Formaten nicht mit gleicher Tiefe behandelt werden können.

Auswahlkriterien

• Vorwissen und Rollenprofil
• Umfang und Reifegrad des vorhandenen Dokumentationsbestands
• Bedarf an Redaktion, Gestaltung, Entwicklung oder Betrieb
• Erforderliche Automatisierung und Qualitätsstufe
• Geplante Versions-, Upgrade- oder Migrationsvorhaben