docs: add consumer audience split and external deps

This commit is contained in:
2026-01-15 09:09:59 +01:00
parent 10ec58f744
commit a732a5afc4
19 changed files with 327 additions and 16 deletions

View File

@ -20,6 +20,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. |
| 15.01.2026 | 📝 Req | Externe Service-Links in der Doku ergaenzt. |
## Epic-Backlog (Uebersicht)
### EPIC_000001: Legacy CLI Account Control (sk.sh)
@ -127,6 +128,12 @@ Sicheres, remote steuerbares System zum Sperren/Entsperren lokaler Nutzerkonten.
- [x] US_000040: Doku-Struktur und Inhalte erstellen
- [x] TASK_000043: Neue Doku-Dateien erstellen und verlinken
- [x] TASK_000044: Altdoku archivieren
- [x] US_000041: Einbindung externer Services dokumentieren
- [x] TASK_000045: Einbindung externer Services dokumentieren
- [x] US_000042: Consumer-Perspektive und Audience-Split ergaenzen
- [x] TASK_000046: Consumer-Doku erstellen (FOR_USERS.md)
- [x] TASK_000047: README und Audience-Split anpassen
- [x] TASK_000048: External Dependencies und Audience-Ergaenzungen
## Offene Risiken / Abhaengigkeiten
- Betrieb erfordert Root/sudo und lokale System-Tools (notify-send, sound player, uvicorn).

View File

@ -40,3 +40,5 @@ Code und den Skripten orientiert.
## Zugeordnete User Stories
- US_000040: Doku-Struktur und Inhalte erstellen
- US_000041: Einbindung externer Services dokumentieren
- US_000042: Consumer-Perspektive und Audience-Split ergaenzen

View File

@ -0,0 +1,16 @@
ID: US_000041 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000041: Einbindung externer Services dokumentieren
Als Operator moechte ich klare Schritte zur Einbindung des Update- und OIDC-Services,
damit die Schnittstellen korrekt konfiguriert und betrieben werden koennen.
## Akzeptanzkriterien
- Given die Update- und OIDC-Services sind bekannt
- When die Doku gelesen wird
- Then sind Einbindungsschritte beschrieben (ENV, Enrollment, OIDC-Setup)
- And die Quellen der Services sind verlinkt
## Task-Platzhalter
- TASK_000045: Einbindungsschritte in Doku ergaenzen

View File

@ -0,0 +1,19 @@
ID: US_000042 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000042: Consumer-Perspektive und Audience-Split ergaenzen
Als Produktteam moechten wir eine klare Trennung der Zielgruppen,
damit Endnutzer, Einsteiger, Power-User und Entwickler passende Einstiege haben.
## Akzeptanzkriterien
- Given die Zielgruppen sind definiert
- When die Doku erstellt wird
- Then existiert eine Consumer-Doku ohne technische Inhalte
- And README benennt alle Zielgruppen und gruppiert die Links
- And External Dependencies sind mit offiziellen Links und Begruendung dokumentiert
## Task-Platzhalter
- TASK_000046: Consumer-Doku erstellen (FOR_USERS.md)
- TASK_000047: README und Audience-spezifische Links/Sections anpassen
- TASK_000048: External Dependencies und Power-User/Beginner-Ergaenzungen einpflegen

View File

@ -0,0 +1,19 @@
ID: TASK_000045 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000045: Einbindung externer Services dokumentieren
## Outcome
Die Doku erklaert die Einbindung von Update-Service und OIDC-Service mit konkreten Schritten.
## Story-Bezug
US_000041
## Beschreibung
- Update-Service: ENV, Enrollment-Optionen, Token-Handling.
- OIDC-Service: Issuer, DCR-Registration, Redirect-URI, ENV-Keys.
- Links zu den internen Repos.
## Definition of Done (DoD)
- Doku ergaenzt in CONFIGURATION/DEPLOYMENT/ARCHITECTURE.
- Links zu Update- und OIDC-Service vorhanden.

View File

@ -0,0 +1,17 @@
ID: TASK_000046 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000046: Consumer-Doku erstellen (FOR_USERS.md)
## Outcome
Endnutzer erhalten eine nicht-technische Anleitung zur Nutzung und Fehlerbehandlung.
## Story-Bezug
US_000042
## Beschreibung
- FOR_USERS.md erstellen.
- Keine technischen Begriffe, keine Installation, kein Code.
## Definition of Done (DoD)
- Consumer-Doku vorhanden und klar abgegrenzt.

View File

@ -0,0 +1,18 @@
ID: TASK_000047 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000047: README und Audience-Split anpassen
## Outcome
README nennt Zielgruppen, grenzt das Projekt ab und verlinkt Doku je Zielgruppe.
## Story-Bezug
US_000042
## Beschreibung
- Audience-Split explizit nennen.
- "Was es NICHT ist" ergaenzen.
- Links nach Zielgruppe gruppieren.
## Definition of Done (DoD)
- README erfuellt erweiterte Anforderungen.

View File

@ -0,0 +1,18 @@
ID: TASK_000048 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000048: External Dependencies und Audience-Ergaenzungen
## Outcome
External Dependencies sind dokumentiert, Beginner-Fehler und Power-User-Use-Cases ergaenzt.
## Story-Bezug
US_000042
## Beschreibung
- External Dependencies mit offiziellen Links + Begruendung dokumentieren.
- GETTING_STARTED (Beginner mistakes) ergaenzen.
- USAGE/CONFIGURATION (Power-User Automation/Performance) ergaenzen.
## Definition of Done (DoD)
- Doku erfuellt Consumer/Beginner/Power-User/Developer Split.