StefanMoCoAt
ef234747bc
Some checks failed
Desktop CI — Headless Tests & Build / Compose Desktop — Tests (headless) & Build (push) Has been cancelled
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
# 📚 Projektdokumentation "Meldestelle"
|
||
|
||
Willkommen im "Gehirn" des Projekts. Dieses Verzeichnis ist die **Single Source of Truth**.
|
||
|
||
## 📂 Struktur
|
||
|
||
### 🏗️ Core
|
||
* **[`01_Architecture`](01_Architecture)**: Der Masterplan. ADRs, Roadmaps und C4-Modelle.
|
||
* *Start hier:* [`MASTER_ROADMAP.md`](01_Architecture/MASTER_ROADMAP.md)
|
||
* **[`02_Guides`](02_Guides)**: Guides für neue Entwickler (Setup, Guidelines).
|
||
* **[`03_Domain`](03_Domain)**: Fachlichkeit (Turnierregeln, Entities).
|
||
|
||
### 🛠️ Tech Stack
|
||
* **[`05_Backend`](05_Backend)**: Spring Boot Services, API-Specs, DB-Schema.
|
||
* **[`06_Frontend`](06_Frontend)**: Kotlin Multiplatform, Compose UI, State Management.
|
||
* **[`07_Infrastructure`](07_Infrastructure)**: Docker, Keycloak, CI/CD, Zora-Architektur.
|
||
* *Referenz:* [`Zora_System_Architektur.md`](07_Infrastructure/Zora_System_Architektur.md)
|
||
|
||
### 🤖 Process
|
||
* **[`04_Agents`](04_Agents)**: Playbooks für unsere KI-Mitarbeiter.
|
||
* **[`90_Reports`](90_Reports)**: Statusberichte und Meilenstein-Analysen.
|
||
* **[`99_Journal`](99_Journal)**: Tägliche Session-Logs.
|
||
|
||
---
|
||
|
||
## 📝 Regeln für die Dokumentation
|
||
|
||
1. **Docs-as-Code:** Doku liegt beim Code und wird im selben PR aktualisiert.
|
||
2. **Frontmatter:** Jede Markdown-Datei muss einen YAML-Header haben:
|
||
```yaml
|
||
---
|
||
type: [ADR, Guide, Reference, Report, Journal]
|
||
status: [DRAFT, ACTIVE, DEPRECATED, ARCHIVED]
|
||
owner: [Rolle]
|
||
---
|
||
```
|
||
3. **Archivierung:** Lösche nichts. Verschiebe veraltetes Wissen in `_archive` Ordner oder markiere es als `ARCHIVED`.
|
||
|
||
---
|
||
|
||
## 🚀 Quick Links
|
||
* [Master Roadmap](01_Architecture/MASTER_ROADMAP.md)
|
||
* [Agent Playbooks](04_Agents)
|
||
* [Zora Infrastruktur](07_Infrastructure/Zora_System_Architektur.md)
|
||
* [C-3 Proposal: Docs-Unterordner-Struktur](01_Architecture/Proposals/C-3_Docs-Strukturvorschlag.md)
|
||
|
||
---
|
||
|
||
## 📦 Hinweis zur Reorganisation (C-3)
|
||
Im Rahmen von C-3 wird eine Konsolidierung von Medien/Binärartefakten unter `docs/80_Assets/` sowie eine feinere Gliederung von Reports/Journals vorgeschlagen. Aktuell finden keine Verschiebungen statt – Details siehe Proposal oben.
|