docs: overhaul repository documentation
This commit is contained in:
42
project-management/requirements/epics/EPIC_000012.md
Normal file
42
project-management/requirements/epics/EPIC_000012.md
Normal file
@ -0,0 +1,42 @@
|
||||
ID: EPIC_000012 | Version: 0.2.1 | 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
|
||||
19
project-management/requirements/stories/US_000040.md
Normal file
19
project-management/requirements/stories/US_000040.md
Normal file
@ -0,0 +1,19 @@
|
||||
ID: US_000040 | Version: 0.2.1 | Status: Done
|
||||
By: Codex (GPT-5)
|
||||
|
||||
# US_000040: Doku-Struktur und Inhalte erstellen
|
||||
|
||||
Als Nutzer moechte ich eine klare, vollstaendige Dokumentation, damit Einsteiger,
|
||||
Admins und Entwickler das System ohne Rueckfragen verstehen und betreiben koennen.
|
||||
|
||||
## Akzeptanzkriterien
|
||||
- Given die Zielstruktur ist definiert
|
||||
- When die Dokumentation erstellt wird
|
||||
- Then existieren alle Ziel-Dokumente mit korrekten Inhalten
|
||||
- And README enthaelt Quickstart, Zielgruppen, Features und Links
|
||||
- And alle Inhalte basieren auf Code/Skripten ohne Spekulation
|
||||
- And Altdokumente sind archiviert statt geloescht
|
||||
|
||||
## Task-Platzhalter
|
||||
- TASK_000043: Neue Doku-Dateien erstellen und verlinken
|
||||
- TASK_000044: Altdoku archivieren und Hinweise einfuegen
|
||||
20
project-management/requirements/tasks/TASK_000043.md
Normal file
20
project-management/requirements/tasks/TASK_000043.md
Normal file
@ -0,0 +1,20 @@
|
||||
ID: TASK_000043 | Version: 0.2.1 | Status: Done
|
||||
By: Codex (GPT-5)
|
||||
|
||||
# TASK_000043: Neue Doku-Dateien erstellen und verlinken
|
||||
|
||||
## Outcome
|
||||
Komplette neue Doku-Struktur mit konsistenten Inhalten und funktionierenden Links.
|
||||
|
||||
## Story-Bezug
|
||||
US_000040
|
||||
|
||||
## Beschreibung
|
||||
- README neu strukturieren und Links auf Doku-Dateien setzen.
|
||||
- GETTING_STARTED/USAGE/CONFIGURATION/ARCHITECTURE/DEVELOPMENT/DEPLOYMENT/FAQ/TROUBLESHOOTING erstellen.
|
||||
- Inhalte auf Basis von Code/Skripten verifizieren.
|
||||
|
||||
## Definition of Done (DoD)
|
||||
- Alle Ziel-Dokumente existieren und sind vollstaendig.
|
||||
- Keine widerspruechlichen Inhalte gegenueber Code.
|
||||
- Interne Links funktionieren.
|
||||
20
project-management/requirements/tasks/TASK_000044.md
Normal file
20
project-management/requirements/tasks/TASK_000044.md
Normal file
@ -0,0 +1,20 @@
|
||||
ID: TASK_000044 | Version: 0.2.1 | Status: Done
|
||||
By: Codex (GPT-5)
|
||||
|
||||
# TASK_000044: Altdoku archivieren
|
||||
|
||||
## Outcome
|
||||
Veraltete Dokumente sind in docs/_archive/ verschoben und klar als archiviert markiert.
|
||||
|
||||
## Story-Bezug
|
||||
US_000040
|
||||
|
||||
## Beschreibung
|
||||
- Altdokumente identifizieren.
|
||||
- In docs/_archive/ verschieben.
|
||||
- Archiv-Header einfuegen.
|
||||
|
||||
## Definition of Done (DoD)
|
||||
- Keine Loeschung alter Dokus.
|
||||
- Archiv-Header vorhanden.
|
||||
- Neue Dokus referenzieren nur aktuelle Dateien.
|
||||
Reference in New Issue
Block a user