Workflow & Prozess¶

Überblick¶

Die Dokumentation durchläuft einen strukturierten Prozess vom ersten Entwurf bis zur Veröffentlichung. Dies stellt sicher, dass alle Inhalte geprüft und qualitätsgesichert sind.

Important

Kernprinzip: Vier-Augen-Prinzip

Keine Änderung geht direkt live - jeder Beitrag wird vor der Veröffentlichung geprüft.

Der gesamte Workflow im Überblick¶

Der Prozess läuft in vier Hauptschritten ab:

Erstellung: Autor erstellt Inhalt (beliebiges Format)
Aufbereitung: Doku-Team formatiert und strukturiert
Prüfung: Reviewer prüft inhaltliche Korrektheit
Veröffentlichung: Finale Freigabe und Live-Gehen

Rollen und Verantwortlichkeiten¶

Autor (Jeder Feuerwehrangehörige)

Erstellt Inhalte in beliebigem Format
Teilt Wissen und Erfahrungen
Keine technischen Kenntnisse erforderlich

Doku-Team-Mitglied (Technisch versierte Mitglieder)

Konvertiert Inhalte nach Markdown/RST
Kümmert sich um Formatierung
Pflegt Struktur der Dokumentation

Reviewer (Fachlich versierte Mitglieder)

Prüft Inhalte auf Richtigkeit
Gibt fachliches Feedback
Stellt Qualität sicher

Doku-Team-Koordinator (Wehrführung)

Finale Freigabe
Strategische Ausrichtung
Konfliktlösung

Detaillierte Prozessschritte¶

1. Ideensammlung und Planung¶

Woher kommen die Inhalte?

Aus dem Einsatzdienst: Best Practices, Lessons Learned
Aus der Ausbildung: Schulungsunterlagen, Übungskonzepte
Aus der Verwaltung: Neue Regelungen, Updates
Aus der Technik: Fahrzeug- und Gerätebeschreibungen

Eingabekanäle für Ideen

Ideen können eingereicht werden über:

E-Mail an das Doku-Team
Persönliche Ansprache
Dienstbesprechungen
Feedback-Formular

2. Inhaltserstellung¶

Optionen für Autoren (in der Reihenfolge der Präferenz):

Format	Verwendung	Aufwand für Doku-Team
Markdown	Strukturierte Texte, Listen, Tabellen	Minimal ⚡
RST (reStructuredText)	Komplexe Layouts, Querverweise	Minimal ⚡
Word/PDF	Bestehende Dokumente	Mittel 🔨
PowerPoint	Präsentationen, Grafiken	Mittel-Hoch 🔨🔨
Handschriftlich	Notizen, Skizzen	Hoch 🔨🔨🔨

Tip

Für Einsteiger empfohlen: Markdown

Markdown ist einfach zu lernen und benötigt nur einen Texteditor. Das Doku-Team stellt Vorlagen bereit!

3. Einreichung¶

Der Autor reicht den Inhalt ein:

E-Mail: Einfachste Methode - einfach an Doku-Team senden
Datei-Ablage: In gemeinsamen Ordner hochladen
GitLab: Für technisch Versierte - direkt als Merge Request
Persönlich: Bei Diensten oder Übungen übergeben

4. Formatierung und Überprüfung¶

Das Doku-Team übernimmt:

Inhalt sichten: Format und Struktur prüfen
Ggf. konvertieren: Word/PDF zu Markdown/RST umwandeln
Struktur einfügen: Überschriften, Listen, Verweise
Integrieren: In Dokumentation einordnen

5. Review-Prozess¶

Technischer Review (Doku-Team)

Rechtschreibung und Grammatik
Formatierung und Layout
Links und Verweise
Bilder und Diagramme

Fachlicher Review (Fachexperte)

Inhaltliche Korrektheit
Vollständigkeit
Aktualität
Verständlichkeit

6. Finale Freigabe¶

Der Chefredakteur (in der Regel die Wehrführung):

Prüft die finale Version
Stellt sicher, dass alle Vorgaben eingehalten sind
Gibt frei oder fordert letzte Anpassungen

Note

Die finale Freigabe kann auch an erfahrene Redakteure delegiert werden, z.B. bei routinemäßigen Updates oder kleineren Ergänzungen.

7. Veröffentlichung¶

Automatischer Prozess:

Änderungen werden in den Hauptbranch merged
Automatischer Build startet (Sphinx)
HTML-Seiten werden generiert
Webserver wird aktualisiert
Dokumentation ist live

Nach der Veröffentlichung:

Automatische Benachrichtigung an alle Beteiligten
Eintrag im Changelog
Archivierung der alten Version

8. Feedback und Iteration¶

Die Dokumentation wird kontinuierlich verbessert:

Nutzer lesen die Dokumentation
Nutzer geben Feedback (Unklarheiten, Fehler, Ideen)
Feedback wird im Doku-Team-Backlog gesammelt
Priorisierung der Änderungen
Überarbeitung und Review
Veröffentlichung der Verbesserungen

Git-Workflow (für technisch Versierte)

Für Redakteure, die direkt mit Git arbeiten:

Feature Branch erstellen
Änderungen committen
Merge Request erstellen
Review & Genehmigung einholen
In Main mergen
Automatischer Deploy startet

Branch-Namenskonventionen:

feature/beschreibung - Neue Inhalte
fix/beschreibung - Fehlerkorrekturen
update/beschreibung - Aktualisierungen

Qualitätskriterien¶

Jeder Beitrag sollte erfüllen:

Korrektheit: Fachlich richtig und aktuell
Verständlichkeit: Auch für Neue verständlich
Vollständigkeit: Alle relevanten Infos enthalten
Formatierung: Einheitliche Struktur
Rechtschreibung: Keine Tipp- oder Grammatikfehler
Verlinkung: Relevante Querverweise gesetzt

Typische Bearbeitungszeiten¶

Art der Änderung	Bearbeitungszeit	Review-Zeit
Kleiner Textfehler	5 Minuten	10 Minuten
Neue Seite (Markdown)	1-2 Stunden	30 Minuten
Konvertierung Word → Markdown	2-4 Stunden	45 Minuten
Komplexe Fahrzeugdoku	4-8 Stunden	1-2 Stunden
Neues Kapitel	1-2 Tage	2-4 Stunden

Note

Dies sind Richtwerte - die tatsächliche Dauer hängt von Umfang und Komplexität ab.

Kommunikation im Team¶

Regelmäßige Abstimmung

Monatliches Doku-Team-Treffen
Bei Bedarf: Ad-hoc Absprachen
Slack/E-Mail für schnelle Rückfragen

Dokumentation von Entscheidungen

Wichtige Entscheidungen werden dokumentiert:

Warum wurde Inhalt X auf diese Weise strukturiert?
Welche Namenskonventionen gelten?
Welche Abkürzungen sind erlaubt?

Hilfe und Unterstützung¶

Für Autoren

Vorlagen für häufige Inhaltstypen
Schulungen zu Markdown
Persönliche Unterstützung durch Doku-Team

Für Redakteure

Technische Dokumentation (Git, Sphinx)
Tools und Skripte für Konvertierung
Erfahrungsaustausch im Team