EPIC_000011: Documentation and Configuration Alignment

Beschreibung

Konsolidierung der Dokumentation, Beispiel-Konfigurationen und Ops-Hinweise mit dem aktuellen Code-Stand, inklusive Version-Synchronisierung mit der zentralen VERSION.

Ziel / Business Value

Reduziert Integrationsfehler, sorgt fuer konsistente Bedienung und verringert Support-Aufwand.

Mission Statement

Stelle sicher, dass Dokumente, Beispiele und Automationshinweise den realen API- und Konfigurationsstand widerspiegeln.

Business Value & Metriken

Weniger Fehlkonfigurationen durch korrekte ENV-Keys und Auth-Header.
Erfolgsmetrik: 0 bekannte Abweichungen zwischen Code und Doku in den Update/Health-Flows.

In-Scope (Kiddo Team)

Doku-Versionen auf VERSION ziehen.
Update-API Doku inkl. /update/enroll und Response-Feldern aktualisieren.
ENV-Beispiele und Makefile-Healthcheck auf aktuelle Auth-Mechanik angleichen.

Out-of-Scope

Funktionale Aenderungen am Auth-Flow im Backend.
Erweiterte Validierung durch Integrationstests.

High-Level Akzeptanzkriterien

Doku-Header nutzen die aktuelle VERSION.
Update-API-Doku listet alle implementierten Update-Endpunkte.
ENV-Beispiele nutzen die im Code verwendeten Update-Variablen.
Healthcheck-Beispiel nutzt Authorization: Bearer.

Technische Constraints & Risiken

Dokumentation darf keine falschen Defaults oder veraltete Endpunkte nennen.
Audit kann weitere Abweichungen aufdecken und Folgetickets noetig machen.

Zugeordnete User Stories

US_000036: Doku-Versionen auf VERSION synchronisieren
US_000037: Update-API-Doku mit /update/enroll und Response-Feldern abgleichen
US_000038: ENV-Beispiele und Makefile-Healthcheck an Auth/Update-Config angleichen

1.8 KiB Raw Blame History