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
parent 7d71ca9a48
commit a454e6c97a
66 changed files with 881 additions and 693 deletions
@@ -0,0 +1,39 @@
+# 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](../01_Architecture/adr/0012-domain-documentation-structure.md)** 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.
@@ -0,0 +1,39 @@
+# TODO-Liste: Finale Bereinigung der Dokumentation
+
+*   **Datum:** 2026-01-14
+*   **Autor:** Documentation & Knowledge Curator
+*   **Status:** Offen
+
+## Kontext
+
+Nach der großen Dokumentations-Restrukturierung sind beim Commit-Prozess Linting-Fehler und Link-Warnungen aufgetaucht. Diese Liste dient als Plan, um diese letzten Probleme in der nächsten Session zu beheben.
+
+---
+
+## Offene Punkte
+
+### 1. "Broken Links" in Tech-Stack-Referenzen beheben
+
+*   **Problem:** Die aus dem Web kopierten Dokumente (`Gradle_Kotlin_DSL_Primer.md`, `Kotlin_2-3-0_ReleaseNotes.md`) in `docs/02_Reference/Tech_Stack/` enthalten hunderte ungültige, relative Links, die von den Original-Webseiten stammen.
+*   **Aktion:**
+    *   Öffne beide Dateien.
+    *   Entferne die kompletten Navigations-Sidebars und alle anderen internen Links, die Fehler verursachen.
+    *   Reduziere die Dateien auf ihren reinen Inhalts-Kern. Der Link zur Original-Quelle am Anfang jeder Datei ist ausreichend.
+
+### 2. Ungültiges HTML in Legacy-Spezifikation korrigieren
+
+*   **Problem:** Die Datei `docs/03_Domain/02_Reference/Legacy_Specs/OETO-2026_Meldestelle_Erweiterung-Schnittstelle_2014.md` enthält ungültige XML/HTML-Tags.
+*   **Aktion:**
+    *   Öffne die Datei.
+    *   Formatiere den Inhalt als Markdown-Code-Block mit dem Typ `xml`, um die Struktur zu erhalten, ohne dass der Parser Fehler meldet.
+
+### 3. Fehlende `README.md`-Dateien im `docs`-Verzeichnis erstellen
+
+*   **Problem:** Die Wegweiser-READMEs in den Modulen `backend`, `core` und `contracts` zeigen auf nicht-existente Zieldateien.
+*   **Aktion:** Erstelle die folgenden Platzhalter-Dateien, um die Links gültig zu machen:
+    *   `docs/05_Backend/README.md` (mit einem kurzen Platzhaltertext)
+    *   `docs/03_Domain/01_Core_Model/README.md` (mit einem kurzen Platzhaltertext)
+
+---
+
+Nach Abarbeitung dieser Liste sollte das Projekt frei von Dokumentations-Warnungen sein.