50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
# Documentation Completion Checklist
|
|
|
|
Use this checklist for every task that changes code, API contracts, auth, or operations.
|
|
|
|
## Required Artifacts
|
|
|
|
- [ ] `docs/PRD.md` or `docs/PRD.json` exists and is current
|
|
- [ ] `docs/USER-GUIDE/` updated as needed
|
|
- [ ] `docs/ADMIN-GUIDE/` updated as needed
|
|
- [ ] `docs/DEVELOPER-GUIDE/` updated as needed
|
|
- [ ] `docs/API/OPENAPI.yaml` (or `.json`) updated for API changes
|
|
- [ ] `docs/API/ENDPOINTS.md` updated for API changes
|
|
- [ ] `docs/SITEMAP.md` updated for navigation changes
|
|
|
|
## API Coverage
|
|
|
|
- [ ] All public endpoints are documented
|
|
- [ ] All private/internal endpoints are documented
|
|
- [ ] All API input schemas are documented
|
|
- [ ] All API output schemas are documented
|
|
- [ ] All endpoint auth/permission requirements are documented
|
|
- [ ] Error codes and failure behavior are documented
|
|
|
|
## Structural Standards (Book/Chapter/Page)
|
|
|
|
- [ ] `docs/USER-GUIDE/README.md` indexes user chapters/pages
|
|
- [ ] `docs/ADMIN-GUIDE/README.md` indexes admin chapters/pages
|
|
- [ ] `docs/DEVELOPER-GUIDE/README.md` indexes developer chapters/pages
|
|
|
|
## Docs Root Hygiene
|
|
|
|
- [ ] `docs/` root is clean and only contains canonical root docs (PRD, TASKS when active, SITEMAP, optional README) plus category directories
|
|
- [ ] Reports are under `docs/reports/<category>/` (not `docs/` root)
|
|
- [ ] Deferred findings are under `docs/reports/deferred/`
|
|
- [ ] Orchestrator learnings are under `docs/tasks/orchestrator-learnings.json`
|
|
- [ ] Release notes are under `docs/releases/`
|
|
- [ ] Archived task snapshots are under `docs/tasks/`
|
|
- [ ] Scratchpads are under `docs/scratchpads/`
|
|
|
|
## Review Gate
|
|
|
|
- [ ] Documentation changes are in the same logical change set as code/API changes
|
|
- [ ] Code review verified documentation completeness
|
|
- [ ] Missing docs were treated as blocker findings
|
|
|
|
## Publishing
|
|
|
|
- [ ] Publishing target was confirmed with user if unspecified
|
|
- [ ] Canonical source remains in-repo unless user explicitly declares otherwise
|