florianfederspiel
8c458f4953
All checks were successful
Build and Push Docker Images / verify-docs-sync (push) Successful in 9s
Build and Push Docker Images / build-backend (push) Successful in 14s
Build and Push Docker Images / build-frontend (push) Successful in 13s
Build and Push Docker Images / build-docs (push) Successful in 1m47s
1.1 KiB
1.1 KiB
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.mdergänzen, falls ein neuer Bereich entsteht - Neue Doku-Version in
docs/versionen/docs-versionen.mdeintragen - 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.