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.
1.7 KiB
1.7 KiB
Plan zur Strukturierung der Domänen-Dokumentation
- Datum: 2026-01-14
- Autor: Documentation & Knowledge Curator
- Status: Entwurf
Ausgangslage
Das Verzeichnis docs/02_Domain enthält wertvolle, aber zunehmend unübersichtliche Informationen.
Es gibt eine Mischung aus:
- Destilliertem Wissen (
01_Core_Entities.md) - Referenz-Material (
Reference/FEI...,Reference/OETO...) - Entwicklungs-Infos (
Development/) - Implizitem Wissen (
Reference/Geschichten)
Zielbild
Gemäß ADR-0012 (Proposed) soll eine strikte Trennung nach Reifegrad eingeführt werden.
Migrations-Schritte
-
Verzeichnisse erstellen:
docs/02_Domain/01_Core_Model/Entitiesdocs/02_Domain/01_Core_Model/Processesdocs/02_Domain/01_Core_Model/Rulesdocs/02_Domain/03_Analysis/Scenarios
-
Dateien verschieben & umbenennen:
01_Core_Entities.md->01_Core_Model/Entities/Overview.md(oder aufsplitten)Reference/Geschichten->03_Analysis/ScenariosReference/FEI_01-2026->02_Reference/FEI_RegelwerkReference/OETO_01-2026->02_Reference/OETO_Regelwerk
-
Development-Ordner auflösen:
- Die Inhalte von
docs/02_Domain/Development(kdoc-style.md,start-local.md,branchschutz...) gehören nicht in die Domäne. start-local.md->docs/02_Onboarding/branchschutz...->docs/02_Onboarding/kdoc-style.md->docs/02_Onboarding/CodingGuidelines/
- Die Inhalte von
-
Glossar anlegen:
- Erstellung von
docs/02_Domain/00_Glossary.mdals leere Hülle für den Start.
- Erstellung von
Nächste Schritte für den User
- Bestätigung des ADR-0012.
- Freigabe zur Durchführung der Datei-Operationen (Verschieben/Umbenennen).