Dokumentationsprozess

Zweck

Dieser Prozess stellt sicher, dass die Funktionsdokumentation bei jeder Änderung aktuell bleibt.

Verbindlicher Ablauf bei Funktionsänderungen

Funktion implementieren oder ändern
Technische Doku synchronisieren:

node docs/scripts/sync-funktionsdoku.mjs

Fachliche Beschreibung in docs/funktionen/uebersicht.md ergänzen, falls ein neuer Bereich entsteht
Neue Doku-Version in docs/versionen/docs-versionen.md eintragen
Code und Doku gemeinsam committen

Was als Funktionsänderung gilt

Neue API-Route oder geänderte API-Route
Neue Web-Seite oder geänderte Seitenstruktur
Neuer Mobile-Screen oder geänderte Navigationsstruktur
Größere fachliche Änderung in bestehenden Modulen

Qualitätsregeln

Automatisch erzeugte Dateien nicht manuell pflegen
Fachliche Begriffe konsistent halten
Jede Doku-Version erhält Datum, Änderungszusammenfassung und Bezug zu Commits

CI-Empfehlung

Optional kann in CI geprüft werden, ob die generierten Doku-Dateien aktuell sind (z. B. per Diff nach Skriptlauf), damit keine Funktionsänderung ohne Doku-Update gemerged wird.

1.1 KiB Raw Blame History