tooling: make .junie/.gemini docs-first (remove legacy guidelines)
This commit is contained in:
+17
-8
@@ -6,14 +6,14 @@ Die Dokumentation wird nach dem **"Docs-as-Code"**-Prinzip gepflegt: Sie liegt n
|
||||
|
||||
## Struktur der Dokumentation
|
||||
|
||||
* **/01_Architecture**: Enthält **Architecture Decision Records (ADRs)**. Jede wichtige Architekturentscheidung (z.B. "Warum nutzen wir ein API-Gateway?") wird hier in einer eigenen Datei festgehalten.
|
||||
* **/02_Onboarding**: Anleitungen für den schnellen Einstieg in das Projekt. Enthält `Getting_Started.md` für das lokale Setup.
|
||||
* **/03_Agents**: Definitionen und spezifische Anleitungen für die im Projekt eingesetzten KI-Agenten.
|
||||
* `AGENTS.md`: Definiert die Rollen, Verantwortlichkeiten und Regeln für jeden Agenten.
|
||||
* `Gemini/`, `Junie/`: Ablageorte für finalisierte Berichte und Analysen der jeweiligen KI-Assistenten.
|
||||
* **/04_Backend**: Dokumentation, die sich speziell auf die Backend-Services bezieht.
|
||||
* **/05_Frontend**: Dokumentation für das KMP-Frontend ("Meldestelle Portal").
|
||||
* **/06_Infrastructure**: Anleitungen und Konfigurationsdetails zur Infrastruktur (Docker, Keycloak, Consul, etc.).
|
||||
* **/01_Architecture**: Architektur (ADRs, C4/Diagramme, Architektur-Referenzen).
|
||||
* **/02_Onboarding**: Einstieg & Entwickler-Workflow (lokales Setup, PR-Workflow, Style-Guides).
|
||||
* **/03_Agents**: Agent Operating Model (AOM) + Playbooks für Junie/Gemini und weitere KI-Unterstützungen.
|
||||
* **/04_Backend**: Backend-spezifische Dokumentation (Services, Datenmodelle, Integrationen).
|
||||
* **/05_Frontend**: Frontend-spezifische Dokumentation (KMP/Compose, Offline/Synchronisierung).
|
||||
* **/06_Infrastructure**: Betrieb & Infrastruktur (Docker, Keycloak, Observability, Ports/URLs, Runbooks).
|
||||
* **/90_Reports**: Berichte/Analysen/Status-Reports (zeitlich geordnet, nicht zwingend „verbindliche Regeln“).
|
||||
* **/99_Journal**: Kurzprotokolle pro Session (Anti-Wissensverlust, Nachvollziehbarkeit).
|
||||
|
||||
## Wie man diese Dokumentation pflegt
|
||||
|
||||
@@ -24,3 +24,12 @@ Jeder Entwickler und jeder KI-Agent ist dafür verantwortlich, die Dokumentation
|
||||
* **Bei Änderungen am Setup:** Passe die Anleitungen im `Onboarding`- oder `Infrastructure`-Verzeichnis an.
|
||||
|
||||
Änderungen an der Dokumentation sollten Teil derselben Pull Request/Commit sein wie die zugehörigen Code-Änderungen.
|
||||
|
||||
### Wichtigste Einstiege
|
||||
|
||||
* Agenten/Arbeitsmodus: `docs/03_Agents/`
|
||||
* Lokales Setup/Workflow: `docs/02_Onboarding/`
|
||||
* Architekturentscheidungen: `docs/01_Architecture/adr/`
|
||||
* Backend (pro Service): `docs/04_Backend/Services/`
|
||||
* Ping-Service (Startpunkt): `docs/04_Backend/Services/ping-service.md`
|
||||
* Ping-Service Implementierungs-Report (Historie): `docs/90_Reports/Ping-Service_Impl_01-2026.md`
|
||||
|
||||
Reference in New Issue
Block a user