Documentation Impact Report Template¶
Change Metadata¶
- Change ID:
- Title:
- Owner:
- Risk tier and checkpoint:
- Base and head revisions:
- Affected versions and maturity:
Changed Surface¶
- Implementation files:
- Tests:
- Schemas and contracts:
- Infrastructure and dependencies:
- User-facing behavior:
Documentation Obligations¶
| Obligation | Criticality | Affected documents | Status | Evidence or not-applicable rationale |
|---|---|---|---|---|
| Canonical guidance | Critical/Important/Standard | |||
| Generated reference | ||||
| Architecture and diagrams | ||||
| Security, privacy, and trust | ||||
| API, schema, and compatibility | ||||
| Examples, tutorials, and troubleshooting | ||||
| Migration, rollback, and operations | ||||
| Changelog, release, and version history | ||||
| Accessibility and visual evidence |
Validation¶
- Documentation impact command:
- Documentation and governance validation:
- Example and tutorial verification:
- Link, spelling, diagram, and site validation:
- Hosted CI evidence:
Decision¶
- Decision:
ready,hold, orreject - Blockers:
- Approved waivers and expiry:
- Approvers and timestamps:
- Follow-up debt with owner and deadline: