docs: overhaul repository documentation

This commit is contained in:
2026-01-15 08:54:52 +01:00
parent c41482a7b3
commit 10ec58f744
22 changed files with 575 additions and 108 deletions

View File

@ -19,6 +19,7 @@ Sicheres, remote steuerbares System zum Sperren/Entsperren lokaler Nutzerkonten.
|---|---|---|
| 28.12.2025 | 🏗️ Planning | Anforderungen als Epics und Stories dokumentiert. |
| 15.01.2026 | 📝 Req | Doku und ENV-Beispiele an Code-Stand angepasst. |
| 15.01.2026 | 📝 Req | Doku-Overhaul mit neuer Struktur und Archivierung. |
## Epic-Backlog (Uebersicht)
### EPIC_000001: Legacy CLI Account Control (sk.sh)
@ -122,6 +123,11 @@ Sicheres, remote steuerbares System zum Sperren/Entsperren lokaler Nutzerkonten.
- [x] US_000039: Doku-Audit fuer verbleibende Abweichungen
- [x] TASK_000042: Doku-Audit verbleibender Dateien
### EPIC_000012: Dokumentations-Overhaul
- [x] US_000040: Doku-Struktur und Inhalte erstellen
- [x] TASK_000043: Neue Doku-Dateien erstellen und verlinken
- [x] TASK_000044: Altdoku archivieren
## Offene Risiken / Abhaengigkeiten
- Betrieb erfordert Root/sudo und lokale System-Tools (notify-send, sound player, uvicorn).
- OIDC-Validierung blockiert bis IdP bereit und Service laeuft.

View 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

View 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

View 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.

View 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.