mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
696c2e0bd8
meldestelle/docs
History
Stefan Mogeritsch 696c2e0bd8 docs: implement "Docs-as-Code" strategy, refine agent definitions, and update documentation structure 
Introduced the "Docs-as-Code" approach across the project to ensure maintainable and versioned documentation. Updated agent role definitions and responsibilities in `AGENTS.md`. Reorganized and expanded the `/docs` directory for better alignment with project workflows and architecture.
2026-01-13 10:23:38 +01:00
..
adr chore(MP-30): final docs cleanup, adr consolidation & legacy removal 2025-12-08 18:04:44 +01:00
c4 Versuche 2025-12-08 20:46:47 +01:00
how-to Versuche 2025-12-31 00:20:29 +01:00
reference Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00
.frontmatter.schema.json Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00
Analyse_Build-Tooling-Integrität_01-2026.md chore(build, dependencies): add Room support with KSP integration and optimize testing dependencies 2026-01-08 23:45:35 +01:00
ARCHITECTURE.md chore(MP-30): final docs cleanup, adr consolidation & legacy removal 2025-12-08 18:04:44 +01:00
ArchitektonischeEvaluierungImplementierungsstrategieOffline-FähigkeitKMP_Web-Desktop_SQLDelight_2-2-1_01-2026.md migrate(local-db): replace Room with SQLDelight for JS/WASM compatibility 2026-01-09 12:32:12 +01:00
Backend_Status_Report_01-2026.md refactor(build): enable Wasm by default and refactor modules for improved KMP compatibility 2026-01-09 14:36:10 +01:00
Frontend_Status_Report_01-2026.md migrate(local-db): replace Room with SQLDelight for JS/WASM compatibility 2026-01-09 12:32:12 +01:00
Kompatibilitätsanalyse_01-2026.md chore(docs): add comprehensive compatibility and architecture reports for 2026 technology stack 2026-01-08 00:34:27 +01:00
Ping-Service_Impl_01-2026.md refactor(ping-service): remove CORS configuration from code, restructure modules, and update Gradle dependencies 2026-01-12 13:12:20 +01:00
README.md docs: implement "Docs-as-Code" strategy, refine agent definitions, and update documentation structure 2026-01-13 10:23:38 +01:00
RoomJetpackAndroidDevelopers.md chore(build, dependencies): add Room support with KSP integration and optimize testing dependencies 2026-01-08 23:45:35 +01:00
Technischer_Kompatibilitäs-Architektur_KMP-2-3-0_Ökosystem.md chore(docs): add comprehensive compatibility and architecture reports for 2026 technology stack 2026-01-08 00:34:27 +01:00

README.md

Projektdokumentation "Meldestelle"

Willkommen zur zentralen Projektdokumentation. Dieses Verzeichnis ist die "Single Source of Truth" für alle architektonischen Entscheidungen, Anleitungen und Implementierungsdetails.

Die Dokumentation wird nach dem "Docs-as-Code"-Prinzip gepflegt: Sie liegt neben dem Code, wird mit Git versioniert und von allen Teammitgliedern (Mensch und KI) aktuell gehalten.

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.).

Wie man diese Dokumentation pflegt

Jeder Entwickler und jeder KI-Agent ist dafür verantwortlich, die Dokumentation, die seinen Arbeitsbereich betrifft, zu aktualisieren.

  • Bei neuen Features: Erstelle oder aktualisiere die entsprechende Implementierungs-Doku.
  • Bei Architektur-Änderungen: Erstelle ein neues ADR oder aktualisiere ein bestehendes.
  • 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.