meldestelle/docs

Meldestelle - Dokumentation

📚 Single Source of Truth: YouTrack

Die Hauptdokumentation befindet sich in der YouTrack Wissensdatenbank:

👉 Meldestelle Command Center

Was du in YouTrack findest

• 🏗️ Bounded Context Dokumentation (Members, Horses, Events, Masterdata)
• 📡 API-Referenz (automatisch aus KDoc generiert)
• 🚀 Deployment-Guides (Proxmox, Cloudflare, Nginx)
• 🔐 Sicherheit-Konfigurationen (Keycloak, GitHub Secrets)
• 💡 Roadmap & Visionen
• 📊 Architektur-Diagramme (interaktiv)

---

📂 Was im Repository bleibt

1. Architecture Decision Records (ADRs)

Architekturentscheidungen sind Teil der Code-Historie und werden im Repository versioniert:

• ADR Übersicht
• ADR-0001: Modulare Architektur
• ADR-0002: Domain-Driven Design
• ADR-0003: Microservices
• ADR-0004: Event-Driven Communication
• ADR-0005: Polyglot Persistence
• ADR-0006: Authentication & Authorization (Keycloak)
• ADR-0007: API Gateway Pattern
• ADR-0008: Multiplatform Client Applications
• ADR-0009: Final KMP Architecture

2. C4-Diagramme (PlantUML-Quellen)

Versionierte Diagramm-Quellen für Architekturdokumentation:

• C4 Context
• C4 Container
• C4 Component - Events Service

3. Developer Guides

Minimale Anleitungen für lokale Entwicklung:

• Lokales Setup – Projekt in 5 Minuten starten
• KDoc Style Guide – Documentations-Konventionen im Code
• Branch-Schutz & PR-Workflow – Git-Workflow

---

🔄 Automatische Synchronisation

Das Projekt nutzt automatisierte Workflows für Konsistenz:

• KDoc → YouTrack: docs-kdoc-sync.yml – Synchronisiert API-Dokumentation aus Code-Kommentaren nach YouTrack
• Docker SSoT: ssot-guard.yml – Validiert Docker-Versionskonsistenz
• CI Pipeline: ci-main.yml – Hauptpipeline für Build, Tests, Validierung

---

📋 Documentations-Workflow

Für Code-Änderungen

1. KDoc im Code schreiben
2. PR erstellen → CI validiert
3. Nach Merge → KDoc-Sync pusht automatisch nach YouTrack

Für Architektur-Entscheidungen

1. ADR in docs/adr/ erstellen
2. PR mit ADR-Review
3. Nach Merge → Zusammenfassung in YouTrack verlinken

Für Infrastruktur/Konfiguration

1. Dokumentation direkt in YouTrack erstellen
2. Bei Code-relevanten Änderungen → im Commit-Message auf YouTrack-Artikel verweisen

---

❓ Fragen & Support

• Technische Fragen: GitHub Discussions
• Bugs: GitHub Issues
• Architektur-Diskussionen: YouTrack
• Projekt-Dokumentation: YouTrack Wissensdatenbank

---

Hinweis: Diese README wurde am 8. Dezember 2025 aktualisiert im Rahmen der Dokumentations-Migration nach YouTrack (siehe ADR-0009).