39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# Documentatiekaart
|
|
|
|
De documentatie is opgesplitst per beslisniveau zodat een mens of coding agent alleen de relevante context hoeft te laden.
|
|
|
|
## Startpunten
|
|
|
|
- `../CODEX_START_HERE.md` — autonome projectoverdracht;
|
|
- `ai/PROJECT_STATE.md` — huidige uitvoeringsstatus;
|
|
- `ai/BACKLOG.yaml` — machineleesbare resterende taken;
|
|
- `product/PRODUCT_REQUIREMENTS.md` — wat het product moet doen;
|
|
- `architecture/SYSTEM_ARCHITECTURE.md` — hoe het systeem is opgebouwd;
|
|
- `design/UX_SPEC.md` — gebruikerservaring en schermgedrag;
|
|
- `operations/UNRAID_DEPLOYMENT.md` — productie-installatie;
|
|
- `quality/DEFINITION_OF_DONE.md` — afrondingsnorm.
|
|
- `../VERIFICATION_REPORT.md` — bewezen baseline en expliciete verificatiebeperkingen.
|
|
|
|
## Documenthiërarchie
|
|
|
|
Bij conflict geldt, van hoog naar laag:
|
|
|
|
1. security- en juridische grenzen in `SECURITY.md` en het bronbeleid;
|
|
2. expliciete ADR's in `architecture/adrs/`;
|
|
3. product requirements en acceptatiecriteria;
|
|
4. architectuur-, API- en UX-specificaties;
|
|
5. taakacceptatiecriteria in `ai/BACKLOG.yaml`;
|
|
6. oorspronkelijke referentiedocumentatie in `reference/`.
|
|
|
|
Een afgeleid document mag een oorspronkelijke formulering verfijnen, maar niet stilzwijgend een veiligheidsgrens versoepelen.
|
|
|
|
## Onderhoud
|
|
|
|
Gedragswijzigingen vereisen een update van minimaal:
|
|
|
|
- relevante specificatie;
|
|
- tests;
|
|
- `quality/TRACEABILITY_MATRIX.md`;
|
|
- `ai/PROJECT_STATE.md`;
|
|
- taakstatus of changelog.
|