5c6a2e78cf
Register all active platform services and base features in core DB so admin can manage them, add delivery/hospitality/sports-center backend phases, update apps catalog and production deploy tooling. Co-authored-by: Cursor <cursoragent@cursor.com>
3.3 KiB
3.3 KiB
Documentation Template
How documentation must be updated after every phase.
Principle
Code and documentation ship together. A phase that changes behavior without docs is incomplete (project-principles.md). Enterprise completeness requires documentation completeness (enterprise-completeness.md).
Update Checklist
Always
- Phase document created/updated (from phase-template.md) including Enterprise Phase Discovery Record, Business Analysis, and Domain Model
- phase-handover.md sections filled (or equivalent in phase doc) including Discovery summary, Enterprise Completeness Sign-Off, and Definition of Done
- progress.md — completed work only
- next-steps.md — immediate next milestone only
- module-registry.md — version, phase, events, permissions, migration
- phase-manifest.yaml — status / dependencies
- service-manifest.yaml — version / phase / APIs / events if service changed
- OpenAPI reflects new/changed routes (for API phases)
When Applicable
- roadmap.md — only if future sequencing changed
- provider-registry.md — new/changed providers
- glossary.md — new canonical terms
- ADR created/updated under architecture/adr/
- Architecture docs if boundaries/topology changed (never silently)
- reference/api-reference.md
- reference/services-contracts.md
- reference/event-catalog.md
- reference/database-schema.md
- Service README under
backend/services/<name>/ - Phase area README under phases/
- Frontend docs under frontend/ if UI shipped
- Mandatory artifact N/A justifications recorded
Never
- Do not put future work into
progress.md - Do not overwrite accepted ADRs
- Do not duplicate master-prompt.md / DoD / completeness rules into phase prompts
- Do not leave broken links or undocumented public surfaces for the phase
- Do not mark Complete while documenting missing current-phase artifacts as “limitations”
Cross-Link Requirements
Every new phase doc must link at least:
- Architecture overview or relevant architecture leaf
- Related ADR(s)
- Module registry entry
- Development standards (principles / testing) as needed
- AI/Enterprise framework: Discovery, loop, gates, DoD (when AI-implemented)
- Progress / next-steps
Validation
Before completion, run Documentation + Cross Reference + Broken Link validation from quality-gates.md, and confirm Enterprise Completeness documentation dimension.
Related Documents
- docs/README.md
- Phase Template
- Phase Handover
- Definition of Done
- Enterprise Phase Discovery
- Enterprise Completeness
- templates/ (registry-oriented short templates)