Seminar MkDocs – Diagramme, Mathematik und technische Visualisierung

Technische Zusammenhänge lassen sich mit Diagrammen und Formeln oft präziser vermitteln als mit langen Textpassagen. Entscheidend sind eine geeignete Darstellungsform, versionierbare Quellen und eine robuste Ausgabe auf unterschiedlichen Geräten.

Inhaltsübersicht

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

Zielsetzung

An einem kompakten Übungsprojekt werden textbasierte Diagramme, mathematische Ausdrücke, Beschriftungen und alternative Erklärungen erstellt und in den Build integriert.

Zielgruppe

Technische Redakteure, Entwickler, Architekten, Trainer und Autoren wissenschaftlich-technischer Inhalte.

Voraussetzungen

Grundkenntnisse in Markdown und MkDocs; keine vertieften Grafikkenntnisse erforderlich.

Seminarinhalte

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

Diagramme, Formeln und technische Visualisierung

1. Schritt 1: Visualisierungsform nach Informationsziel und Zielgruppe auswählen.
2. Schritt 2: Textbasierte Diagramme und mathematische Formeln kontrolliert integrieren.
3. Schritt 3: Beschriftungen, Legenden und Alternativinformationen bereitstellen.
4. Schritt 4: Responsive Darstellung, Versionsverwaltung und Build-Prüfung absichern.

Technisches Markdown und Seitentypen

1. Schritt 1: Überschriften, Listen, Links, Bilder, Tabellen und Code semantisch korrekt einsetzen.
2. Schritt 2: Anleitungen mit Voraussetzungen, nummerierten Schritten und Prüfergebnis strukturieren.
3. Schritt 3: Konzepte, Referenzen, Tutorials und Fehlerbehebungen klar unterscheiden.
4. Schritt 4: Interne Verweise und Medienpfade relativ, stabil und wartbar aufbauen.

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.

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.

Praxisübungen

• Ein Ablauf- und ein Architekturdiagramm aus Textquellen erstellen
• Formeln und erklärenden Fließtext zugänglich kombinieren
• Darstellung auf Bildschirm, Mobilgerät und in der Druckansicht prüfen

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.