mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
33a6a96ec6
meldestelle/docs
History
Stefan Mogeritsch 33a6a96ec6 docs: fix incorrect relative links in ADRs and frontend documentation 
Corrected relative links in architectural decision records and the frontend README to ensure proper navigation and consistency across documentation.
2026-01-13 16:04:25 +01:00
..
01_Architecture docs: fix incorrect relative links in ADRs and frontend documentation 2026-01-13 16:04:25 +01:00
02_Onboarding/Development docs(frontend): add detailed offline-first architecture and web setup documentation 2026-01-13 15:59:25 +01:00
03_Agents docs: establish AOM + per-system technical truth (ping-service) 2026-01-13 14:33:45 +01:00
04_Backend/Services tooling: make .junie/.gemini docs-first (remove legacy guidelines) 2026-01-13 14:32:49 +01:00
05_Frontend docs: fix incorrect relative links in ADRs and frontend documentation 2026-01-13 16:04:25 +01:00
06_Infrastructure/Reference docs: establish AOM + per-system technical truth (ping-service) 2026-01-13 14:33:45 +01:00
90_Reports tooling: make .junie/.gemini docs-first (remove legacy guidelines) 2026-01-13 14:32:49 +01:00
99_Journal docs(frontend): add detailed offline-first architecture and web setup documentation 2026-01-13 15:59:25 +01:00
.frontmatter.schema.json Fix: Test-Commit für VCS-Integration (MP-8) (#15) 2025-11-07 12:26:33 +01:00
README.md tooling: make .junie/.gemini docs-first (remove legacy guidelines) 2026-01-13 14:32:49 +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: 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

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.

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