1.6 KiB
1.6 KiB
ID: EPIC_000012 | Version: 0.2.3 | Status: Done By: Codex (GPT-5)
EPIC_000012: Dokumentations-Overhaul
Beschreibung
Komplette, konsistente Dokumentation fuer Einsteiger, Admins und Entwickler, inkl. Archivierung veralteter Inhalte und einer klaren Doku-Struktur.
Ziel / Business Value
Schnelleres Onboarding, weniger Fehlkonfigurationen und klare Betriebsvorgaenge.
Mission Statement
Stelle eine professionelle, konsistente und vollstaendige Doku bereit, die sich direkt am Code und den Skripten orientiert.
Business Value & Metriken
- Onboarding ohne Rueckfragen fuer neue Entwickler.
- Betriebssicherheit durch klare Runbooks.
- Erfolgsmetrik: 0 offene Doku-Abweichungen im Audit.
In-Scope (Kiddo Team)
- Neue Doku-Struktur und konsistente Inhalte.
- README auf Einsteigerpfad + Links auf neue Dokus.
- Altdokumente archivieren, nicht loeschen.
Out-of-Scope
- Funktionale Code-Aenderungen (nur Doku).
- Neue Automatisierungen/CI-Pipelines.
High-Level Akzeptanzkriterien
- README erfuellt definierte Anforderungen.
- Doku-Struktur gem. Ziel (GETTING_STARTED/USAGE/CONFIGURATION/ARCHITECTURE/DEVELOPMENT/DEPLOYMENT/FAQ/TROUBLESHOOTING).
- Altdoku in docs/_archive/ mit Archiv-Header.
- Interne Links funktionieren und keine inhaltlichen Widersprueche.
Technische Constraints & Risiken
- Keine spekulativen Inhalte; nur dokumentieren, was im Repo belegt ist.
- Sprachvorgabe: Deutsch, ASCII wo moeglich.
Zugeordnete User Stories
- US_000040: Doku-Struktur und Inhalte erstellen
- US_000041: Einbindung externer Services dokumentieren
- US_000042: Consumer-Perspektive und Audience-Split ergaenzen