Ersetze Docusaurus vollständig durch Nuxt-Content-Docs-App
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

This commit is contained in:
2026-04-22 18:16:00 +02:00
parent d704e343fc
commit 8c458f4953
28 changed files with 837 additions and 233 deletions

View File

@@ -0,0 +1,35 @@
# Dokumentationsprozess
## Zweck
Dieser Prozess stellt sicher, dass die Funktionsdokumentation bei jeder Änderung aktuell bleibt.
## Verbindlicher Ablauf bei Funktionsänderungen
1. Funktion implementieren oder ändern
2. Technische Doku synchronisieren:
```bash
node docs/scripts/sync-funktionsdoku.mjs
```
3. Fachliche Beschreibung in `docs/funktionen/uebersicht.md` ergänzen, falls ein neuer Bereich entsteht
4. Neue Doku-Version in `docs/versionen/docs-versionen.md` eintragen
5. 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.