Skip to content

Commit 36477b8

Browse files
committed
feat: add definition of ready and done policies
Add bundled Definition of Ready and Definition of Done policy files, include them in the shared agent prompt, and reflect them in task and subtask templates with lightweight readiness, completion, and per-AC verification mapping checklists.
1 parent bf62fb4 commit 36477b8

7 files changed

Lines changed: 120 additions & 0 deletions

File tree

Agents_Common.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ That document defines:
5555

5656
* **Documentation Reading:** Whenever reading any file under `docs/` or `tasks/`, the file MUST be read fully to ensure complete understanding of the context and requirements.
5757
* **Role-Specific Guidelines:** Every agent is responsible for reading the core guidance and any applicable repository policy includes that are part of their prompt.
58+
* **Definition Of Ready / Done:** All execution should follow the repository's active Definition of Ready and Definition of Done policies.
5859
* **Signed Agent Messages:** Agent-to-agent interactions must begin with a signed first message that clearly identifies the sending and receiving agents. Use this exact format on the first line: `[Agent Message] From: <agent_name> To: <agent_name>`. Example: `[Agent Message] From: product_manager To: tech_lead`. If a message does not begin with an agent signature, agents should assume they are speaking directly with the user.
5960
* **Pre-task Clarification:** Before starting any task, thoroughly review requirements. If anything is missing, ambiguous, or insufficient, immediately stop and clearly state what is needed, requesting clarification from the manager agent. Do not proceed until all requirements are clear.
6061
* **CodeMap-First Navigation:** Before broad repository search, agents should consult the most relevant `codemap.yml` chain for the area they are trying to understand. Use local, parent, root, or explicitly targeted module CodeMaps as the first navigation pass. If no suitable CodeMap exists or it is insufficient, agents may then expand into direct search and source inspection.
@@ -95,5 +96,7 @@ All documentation updates must follow the repository's documentation policy for:
9596
- documentation ownership, naming, and layout conventions
9697

9798
<include:plugin:docs/core/role_contracts.md>
99+
<include:policy:definition-of-ready.md>
100+
<include:policy:definition-of-done.md>
98101
<include:policy:documentation-guidelines.md>
99102
<include:plugin:docs/core/task_model.md>

docs/domains/task-lifecycle/OVERVIEW.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This domain includes:
1313
- task classification by `tiny`, `standard`, and `complex`
1414
- task routing by `implementation`, `investigation`, and `spec`
1515
- slice-based task planning using `foundation`, `core`, `logic`, `ui`, `polish`, `qa`, and `docs`
16+
- definition-of-ready and definition-of-done expectations for task execution
1617
- pre-sync quorum rules
1718
- task execution flow and handoff expectations
1819
- verification and archiving expectations
@@ -61,6 +62,8 @@ This domain does not include:
6162

6263
- `docs/core/task_model.md`
6364
- `docs/core/agent_orchestration.md`
65+
- `.nomadworks/policies/definition-of-ready.md`
66+
- `.nomadworks/policies/definition-of-done.md`
6467
- `tasks/task-template.md`
6568
- `tasks/subtask-template.md`
6669
- `docs/core/documentation_structure.md`

policies/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ Files under `.nomadworks/generated/policies/` are reference copies only. They ar
2525
- Documentation layout, naming, ownership, and update expectations.
2626
- Used by all agents through the shared prompt.
2727

28+
- `definition-of-ready.md`
29+
- Canonical readiness criteria before execution begins.
30+
- Used by all agents through the shared prompt and reflected in task templates.
31+
32+
- `definition-of-done.md`
33+
- Canonical completion criteria before closure.
34+
- Used by all agents through the shared prompt and reflected in task templates.
35+
2836
- `git-commit-messaging.md`
2937
- Commit subject and body rules.
3038
- Used by: `tech_lead`, `workflow_runner`

policies/definition-of-done.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Definition Of Done
2+
3+
A task is done only when the implementation, verification, documentation, and workflow closure requirements are all complete.
4+
5+
## Completion Criteria
6+
7+
- All in-scope acceptance criteria are satisfied or explicitly marked blocked with documented reason.
8+
- Required tests, builds, and other verification commands pass according to the repository testing policy.
9+
- Required evidence and verification artifacts are recorded.
10+
- Product and technical documentation impact is resolved according to the repository documentation policy.
11+
- Relevant CodeMap updates are completed when the changed code affects entrypoints, wiring, or maintained source structure.
12+
- Task files, discussion references, and workflow registries are updated as needed.
13+
- The authorized review and closure roles have completed their required checks.
14+
- The final committed state includes all required code, documentation, and registry updates for closure.
15+
16+
## Not Done Conditions
17+
18+
- Any required test or build fails.
19+
- Evidence is missing for claimed verification.
20+
- Documentation or CodeMap impact remains unresolved.
21+
- Acceptance criteria are incomplete, unclear, or unverified.
22+
- Required finalization or archiving steps are missing.
23+
24+
## Operational Rule
25+
26+
A task must not be marked complete while any Definition of Done item remains open.

policies/definition-of-ready.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Definition Of Ready
2+
3+
A task is ready to begin only when the repository has enough information to execute safely and efficiently without inventing scope.
4+
5+
## Readiness Criteria
6+
7+
- Scope is clear, bounded, and appropriate for the task's declared complexity.
8+
- The task objective is specific enough that the next responsible agent can act without guessing intent.
9+
- Acceptance criteria are present, testable, and aligned with the stated scope.
10+
- Complexity, track, and slice are set correctly for the work being requested.
11+
- Required dependencies, assumptions, blockers, and open questions are either resolved or explicitly recorded.
12+
- Required pre-sync specialists have reviewed the task definition according to the active task model.
13+
- An approved SCR exists whenever the workflow requires one.
14+
- The relevant repository areas are identified well enough to begin safe investigation, design, or implementation.
15+
16+
## Not Ready Conditions
17+
18+
- Requirements are ambiguous or contradictory.
19+
- Acceptance criteria are missing or too vague to verify.
20+
- The task is larger or riskier than its current routing metadata suggests.
21+
- Required specialist review has not happened yet.
22+
- A required SCR is missing or not approved.
23+
- Critical blockers or dependencies are unknown or unrecorded.
24+
25+
## Operational Rule
26+
27+
If the task fails the Definition of Ready, execution should pause until the missing information is resolved or explicitly recorded for follow-up.

tasks/subtask-template.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,31 @@ parent: TASK-[PARENT]
1515
### Task
1616
* [ ] [Assigned Agent]: [Action]
1717

18+
### Definition Of Ready Check
19+
- [ ] Parent task, assigned slice, and local scope are clear.
20+
- [ ] Local acceptance criteria or expected outcome is clear.
21+
- [ ] Dependencies, blockers, and assumptions are known or recorded.
22+
1823
### Acceptance Criteria
1924
* [Criterion 1]
2025

26+
### Acceptance Criteria Verification Map
27+
- [ ] AC-1
28+
- **Method:** `[unit test | integration test | e2e | manual check | doc review]`
29+
- **Owner:** `[agent_name]`
30+
- **Evidence:** `[optional path or note]`
31+
32+
Use this section to record the verification method for each local acceptance criterion. Evidence links are optional and should be added only when they materially improve traceability.
33+
2134
### Assigned To: [Primary Agent]
2235
### Status: [todo / in_progress / review / done / blocked]
2336

37+
### Definition Of Done Check
38+
- [ ] Assigned outcome is complete.
39+
- [ ] Relevant verification for this subtask is complete.
40+
- [ ] Evidence or notes are recorded in the parent task when required.
41+
- [ ] Parent task is updated with the subtask outcome.
42+
2443
# Reviews
2544
## [Reviewing Agent]:
2645
- [Comments]

tasks/task-template.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,37 @@ reopened_count: 0
2727
- **Assigned To:** `[product_manager | business_analyst | tech_lead | technical_architect | developer | qa_engineer | ui_ux_designer | workflow_runner]`
2828
- **Handoff From:** `[agent_name or null]`
2929

30+
## Definition Of Ready Check
31+
- [ ] Scope is clear, bounded, and appropriate for the task's declared complexity.
32+
- [ ] Acceptance criteria are present, testable, and aligned with the objective.
33+
- [ ] Complexity, track, and slice are set correctly.
34+
- [ ] Required dependencies, assumptions, blockers, and open questions are resolved or explicitly recorded.
35+
- [ ] Required pre-sync specialist review is complete.
36+
- [ ] Required SCR exists and is approved when the workflow requires it.
37+
3038
## Acceptance Criteria
3139
- [ ] AC-1: [Primary behavioral or task outcome]
3240
- [ ] AC-2: [Secondary outcome, validation, or edge-case requirement]
3341
- [ ] AC-3: Relevant verification is completed and evidence is recorded against each acceptance criterion.
3442
- [ ] AC-4: Product documentation reflects the latest state of the application for this change, or this task explicitly records that no product-truth update was required.
3543
- [ ] AC-5: Technical documentation reflects any architectural or implementation-significant change, or this task explicitly records that no technical-truth update was required.
3644

45+
## Acceptance Criteria Verification Map
46+
- [ ] AC-1
47+
- **Method:** `[unit test | integration test | e2e | manual check | doc review]`
48+
- **Owner:** `[agent_name]`
49+
- **Evidence:** `[optional path or note]`
50+
- [ ] AC-2
51+
- **Method:** `[unit test | integration test | e2e | manual check | doc review]`
52+
- **Owner:** `[agent_name]`
53+
- **Evidence:** `[optional path or note]`
54+
- [ ] AC-3
55+
- **Method:** `[unit test | integration test | e2e | manual check | doc review]`
56+
- **Owner:** `[agent_name]`
57+
- **Evidence:** `[optional path or note]`
58+
59+
Use this section to record how each acceptance criterion will be verified. Evidence links are optional and should be added when they materially improve traceability. Shared evidence may cover multiple acceptance criteria.
60+
3761
### Source Authority (MANDATORY)
3862
* **Spec Reference:** [Commit Hash or SCR ID from documentation update]
3963
* **Documentation:** [Link to updated SPECIFICATION.md or FEATURES_LIST.md]
@@ -100,6 +124,16 @@ Use this section when a task that was thought to be done must be resumed using t
100124
* [ ] Product Manager: Acceptance Criteria and Evidence Coverage Verification
101125
* [ ] User: Final Approval
102126

127+
## Definition Of Done Check
128+
- [ ] All in-scope acceptance criteria are satisfied or explicitly marked blocked with reason.
129+
- [ ] Required tests, builds, and verification commands pass.
130+
- [ ] Required evidence and verification artifacts are recorded.
131+
- [ ] Documentation impact is resolved according to repository policy.
132+
- [ ] Relevant CodeMap updates are complete when needed.
133+
- [ ] Task files and workflow registries are updated.
134+
- [ ] Authorized review and closure checks are complete.
135+
- [ ] Final committed state contains all required code, documentation, and registry updates.
136+
103137
### Finalization
104138
* [ ] [Assigned Agent]: CodeMap Update (Update `codemap.yml` if entrypoints/wiring changed)
105139
* [ ] [Assigned Agent]: Documentation Update (Update relevant docs in `docs/`)

0 commit comments

Comments
 (0)