mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
83954dfbba
meldestelle/docs
History
Stefan Mogeritsch 83954dfbba Standardize documentation with headers and archive old files 
Applied a unified header format to all documentation files for better status identification, referencing, and ownership tracking. Archived outdated roadmaps, reports, and journal entries. Updated playbooks with new responsibilities, lifecycle rules, and consistent handover formats to align with the new archiving strategy.
2026-01-16 13:20:36 +01:00
..
01_Architecture Standardize documentation with headers and archive old files 2026-01-16 13:20:36 +01:00
02_Onboarding docs: restructure domain documentation and update references 2026-01-15 13:44:49 +01:00
02_Reference/Tech_Stack docs: add new documentation for API Gateway, core model, and backend structure 2026-01-15 13:53:56 +01:00
03_Domain docs: add core domain SQL schema draft and enhance domain glossary 2026-01-16 11:32:53 +01:00
04_Agents Standardize documentation with headers and archive old files 2026-01-16 12:17:47 +01:00
05_Backend Standardize documentation with headers and archive old files 2026-01-16 12:17:47 +01:00
06_Frontend Standardize documentation with headers and archive old files 2026-01-16 12:17:47 +01:00
07_Infrastructure Standardize documentation with headers and archive old files 2026-01-16 12:17:47 +01:00
90_Reports Standardize documentation with headers and archive old files 2026-01-16 12:17:47 +01:00
99_Journal Standardize documentation with headers and archive old files 2026-01-16 13:20:36 +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 docs: restructure domain documentation and update references 2026-01-15 13:44: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_Domain: Fachliche Domäne (Kern-Modell, Referenzen, Analyse).
  • /04_Agents: Agent Operating Model (AOM) + Playbooks für KI-Unterstützung.
  • /05_Backend: Backend-spezifische Dokumentation (Services, Datenmodelle, Integrationen).
  • /06_Frontend: Frontend-spezifische Dokumentation (KMP/Compose, Offline/Synchronisierung).
  • /07_Infrastructure: Betrieb & Infrastruktur (Docker, Keycloak, Observability, 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

  • Lokales Setup/Workflow: docs/02_Onboarding/
  • Fachliches Modell: docs/03_Domain/
  • Agenten/Arbeitsmodus: docs/04_Agents/
  • Architekturentscheidungen: docs/01_Architecture/adr/
  • Backend (pro Service): docs/05_Backend/Services/
  • Ping-Service (Startpunkt): docs/05_Backend/Services/ping-service.md
  • Ping-Service Implementierungs-Report (Historie): docs/90_Reports/Ping-Service_Impl_01-2026.md