mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
a454e6c97a
meldestelle/docs/99_Journal/2026-01-14_Konsolidierung_Dokumentationsstruktur.md
Stefan Mogeritsch a454e6c97a docs: restructure domain documentation and update references 
Implemented a standardized folder structure for domain documentation to improve clarity and maintainability. Migrated existing files to the new structure, updated links in related documentation, and added README files for navigation and guidance.
2026-01-15 13:44:49 +01:00

2.8 KiB
Raw Blame History

Journal: Umfassende Konsolidierung der Dokumentationsstruktur

  • Datum: 2026-01-14
  • Autor: Documentation & Knowledge Curator
  • Thema: Eine tiefgreifende Restrukturierung und Bereinigung der gesamten Projektdokumentation, um die "Single Source of Truth"-Regel konsequent durchzusetzen.

Zusammenfassung

In dieser Session wurde eine Reihe von Inkonsistenzen und Redundanzen in der Projektdokumentation identifiziert und systematisch beseitigt. Ziel war es, eine klare, wartbare und leicht navigierbare Struktur zu schaffen, die dem "Docs-as-Code"-Prinzip vollständig entspricht.

Durchgeführte Maßnahmen

  1. Strukturierung der Domänen-Dokumentation (docs/03_Domain):

    • Gemäß ADR-0012 wurde eine neue, nach Reifegrad getrennte Ordnerstruktur eingeführt (00_Glossary, 01_Core_Model, 02_Reference, 03_Analysis).
    • Bestehende Dokumente (Regelwerke, Kern-Entitäten, "Geschichten") wurden in diese neue Struktur migriert.
    • Technische Anleitungen wurden aus dem Domänen-Ordner in den 02_Onboarding-Bereich verschoben.

  2. Behebung der Nummerierungs-Inkonsistenz im docs-Verzeichnis:

    • Die doppelte Verwendung der Nummer 02_ wurde behoben, indem die Verzeichnisse linear von 01 bis 07 umbenannt wurden.
    • Die zentrale docs/README.md wurde entsprechend aktualisiert, um die neue, logische Reihenfolge widerzuspiegeln.

  3. Zentralisierung der Agenten-Playbooks:

    • Die System-Prompts der KI-Agenten wurden aus der AGENTS.md extrahiert und in dedizierte Playbook-Dateien unter docs/04_Agents/Playbooks/ verschoben.
    • Die AGENTS.md dient nun als reine Übersichts- und Einstiegsseite mit Links zu den Playbooks.
    • Die .gemini/README.md wurde korrigiert und vereinfacht.

  4. Standardisierung der Modul-READMEs:

    • Die README.md-Dateien in allen Haupt-Modulen (platform, frontend, backend, core, contracts) wurden vereinheitlicht.
    • Sie dienen nun ausschließlich als Wegweiser zur zentralen Dokumentation im docs-Verzeichnis und enthalten keine redundanten Informationen mehr.

  5. Bereinigung der Root-README.md:

    • Die README.md im Projekt-Root wurde radikal gekürzt. Sie dient jetzt als minimalistische "Visitenkarte" mit den wichtigsten Links zur Dokumentation und zum Quick-Start.

  6. Archivierung veralteter Berichte:

    • Alte Berichte aus den Verzeichnissen JunieBerichte und GeminiBerichte wurden analysiert und als Referenz- oder Analyse-Dokumente in das docs-Verzeichnis (90_Reports oder 02_Reference) überführt.

Ergebnis

Das Projekt verfügt nun über eine hochgradig konsistente, redundanzfreie und wartbare Dokumentationsstruktur. Die Gefahr von "Dokumentations-Drift" wurde signifikant reduziert.