Dokumentation

Dokumenttyp: Developer Playbook
Status: Draft v0.1
Stand: 2026-06-29

Ziel

Dokumentation als festen Bestandteil des Projekts etablieren.

Grundsatz

Dokumentation wird parallel zur Entwicklung gepflegt.

Typen

• Projektvision
• Setup
• Architektur
• Berechnungsmodell
• API
• Journal
• Changelog
• ADRs

Praxisbeispiel Immohai

Immohai nutzt MkDocs Material zur Darstellung der Dokumentation im Browser.

Best Practices

• Dokumentation in Markdown.
• Navigation in mkdocs.yml.
• Kleine, thematische Dateien.
• Nach jeder Session Journal ergänzen.

Checkliste

• [ ] docs-Ordner vorhanden
• [ ] mkdocs.yml vorhanden
• [ ] Navigation funktioniert
• [ ] Journal eingeführt