tegwick
fe4cfe22c9
Add quality_doc/dor/dod recording convention, quality-debt CLI, promote-intake and C-34 soft warnings, agent protocol notes, and DoD policy badge language. Mark STATE-WP-0077 finished.
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
# Workplan Definition of Done (DoD)
|
|
|
|
**applies_to:** `workplan`
|
|
**Assessment outcomes:** `unassessed` | `DoD-Ok` | `DoD-Failed`
|
|
**Policy key:** `workstream-dod` (filename legacy; product term is **workplan**)
|
|
|
|
A workplan may be assessed **DoD-Ok** when implementation quality is complete
|
|
per the checklist below. Lifecycle **`status=finished` is not the same as
|
|
DoD-Ok** — finishing without DoD-Ok is allowed quality debt (see
|
|
`docs/work-record-quality-gates.md`).
|
|
|
|
Record assessments with frontmatter:
|
|
|
|
```yaml
|
|
quality_dod: DoD-Ok # or DoD-Failed
|
|
quality_dod_at: "YYYY-MM-DD"
|
|
quality_dod_by: "agent-or-human"
|
|
# quality_dod_note: "optional"
|
|
```
|
|
|
|
Related: DoR (`policies/work-item-dor.md`), DoC (`policies/intake-doc.md`).
|
|
|
|
---
|
|
|
|
## Checklist
|
|
|
|
A workplan is considered **DoD-Ok** when:
|
|
|
|
- [ ] All tasks in the workplan have been finished, found unnecessary, or been
|
|
transferred to another workplan
|
|
- [ ] All referenced requirements have been addressed with nothing relevant
|
|
missing, or documented as out of scope with a stated reason
|
|
- [ ] Relevant use cases have been captured in automated tests so that future
|
|
changes can be tested to not break prior functionality unintentionally
|
|
- [ ] The repo README and other documentation have been updated to optimize
|
|
reusability for agents and humans
|
|
- [ ] All tests can be run successfully
|
|
- [ ] Everything is properly checked in
|
|
|
|
If assessed and any item fails, record **DoD-Failed** with a short note.
|