@brucewaynedecoy/make-docs 1.0.0-rc.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -201
- package/README.md +36 -27
- package/dist/backup-73HQNKMC.js +20 -0
- package/dist/backup-73HQNKMC.js.map +1 -0
- package/dist/chunk-3BAJQXGH.js +1575 -0
- package/dist/chunk-3BAJQXGH.js.map +1 -0
- package/dist/chunk-64CTKJO7.js +4136 -0
- package/dist/chunk-64CTKJO7.js.map +1 -0
- package/dist/chunk-BENO4IH5.js +875 -0
- package/dist/chunk-BENO4IH5.js.map +1 -0
- package/dist/chunk-D4HDZEJT.js +37 -0
- package/dist/chunk-D4HDZEJT.js.map +1 -0
- package/dist/chunk-G5EF63GG.js +1291 -0
- package/dist/chunk-G5EF63GG.js.map +1 -0
- package/dist/chunk-GNP6HRVP.js +523 -0
- package/dist/chunk-GNP6HRVP.js.map +1 -0
- package/dist/chunk-HJYIQTMD.js +204 -0
- package/dist/chunk-HJYIQTMD.js.map +1 -0
- package/dist/chunk-LQ5NSWCJ.js +39 -0
- package/dist/chunk-LQ5NSWCJ.js.map +1 -0
- package/dist/chunk-LRVV7UDD.js +2340 -0
- package/dist/chunk-LRVV7UDD.js.map +1 -0
- package/dist/chunk-LVQSJF63.js +24674 -0
- package/dist/chunk-LVQSJF63.js.map +1 -0
- package/dist/chunk-MXBHCHSM.js +13995 -0
- package/dist/chunk-MXBHCHSM.js.map +1 -0
- package/dist/chunk-Z5K4FHYP.js +922 -0
- package/dist/chunk-Z5K4FHYP.js.map +1 -0
- package/dist/index.js +3798 -250
- package/dist/index.js.map +1 -1
- package/dist/self-YYXOLDKU.js +653 -0
- package/dist/self-YYXOLDKU.js.map +1 -0
- package/dist/server-O2ZELIMX.js +512 -0
- package/dist/server-O2ZELIMX.js.map +1 -0
- package/dist/setup-system-HZROFNMP.js +544 -0
- package/dist/setup-system-HZROFNMP.js.map +1 -0
- package/dist/{skills-command-3ESCZ75U.js → skills-command-MGGHY7HU.js} +190 -32
- package/dist/skills-command-MGGHY7HU.js.map +1 -0
- package/dist/uninstall-3UXXXNFO.js +223 -0
- package/dist/uninstall-3UXXXNFO.js.map +1 -0
- package/dist/virtual_make-docs-first-party-skills-ZII74YOB.js +11 -0
- package/dist/virtual_make-docs-first-party-skills-ZII74YOB.js.map +1 -0
- package/package.json +9 -6
- package/skill-registry.json +328 -125
- package/skill-registry.schema.json +221 -45
- package/template/.make-docs/AGENTS.md +18 -0
- package/template/.make-docs/CLAUDE.md +18 -0
- package/template/.make-docs/archive/AGENTS.md +11 -0
- package/template/.make-docs/archive/CLAUDE.md +11 -0
- package/template/.make-docs/system/AGENTS.md +12 -0
- package/template/.make-docs/system/CLAUDE.md +12 -0
- package/template/.make-docs/system/contracts/AGENTS.md +13 -0
- package/template/.make-docs/system/contracts/CLAUDE.md +13 -0
- package/template/{docs/assets/references → .make-docs/system/contracts}/commit-message-convention.md +4 -4
- package/template/.make-docs/system/contracts/coverage-pass-contract.md +198 -0
- package/template/.make-docs/system/contracts/deferred-obligation-contract.md +128 -0
- package/template/{docs/assets/references → .make-docs/system/contracts}/design-contract.md +7 -2
- package/template/{docs/assets/references → .make-docs/system/contracts}/guide-contract.md +21 -19
- package/template/{docs/assets/references → .make-docs/system/contracts}/history-record-contract.md +17 -11
- package/template/.make-docs/system/contracts/human-experience-contract.md +134 -0
- package/template/.make-docs/system/contracts/naive-uat-contract.md +231 -0
- package/template/.make-docs/system/contracts/output-contract.md +277 -0
- package/template/.make-docs/system/contracts/performance-evidence-governance.md +257 -0
- package/template/.make-docs/system/contracts/system-resource-contract.md +93 -0
- package/template/.make-docs/system/prompts/AGENTS.md +12 -0
- package/template/.make-docs/system/prompts/CLAUDE.md +12 -0
- package/template/.make-docs/system/prompts/coverage-pass-maintainer-guide.prompt.md +20 -0
- package/template/.make-docs/system/prompts/coverage-pass-prd-reconciliation.prompt.md +18 -0
- package/template/.make-docs/system/prompts/coverage-pass-testing-uat.prompt.md +46 -0
- package/template/.make-docs/system/prompts/coverage-pass-user-guide.prompt.md +20 -0
- package/template/.make-docs/system/prompts/designs-to-plan-change.prompt.md +18 -0
- package/template/.make-docs/system/prompts/designs-to-plan.prompt.md +14 -0
- package/template/.make-docs/system/prompts/docs-path-hygiene-cleanup.prompt.md +29 -0
- package/template/.make-docs/system/prompts/naive-uat-facilitator.prompt.md +28 -0
- package/template/.make-docs/system/prompts/naive-uat-tester.prompt.md +20 -0
- package/template/.make-docs/system/prompts/performance-coverage.prompt.md +63 -0
- package/template/.make-docs/system/prompts/plan-to-prd-change.prompt.md +12 -0
- package/template/.make-docs/system/prompts/plan-to-prd-green-field.prompt.md +10 -0
- package/template/.make-docs/system/prompts/prd-change-to-work.prompt.md +14 -0
- package/template/.make-docs/system/prompts/prd-to-work-full-prd.prompt.md +10 -0
- package/template/.make-docs/system/prompts/prd-to-work-prd-feature.prompt.md +10 -0
- package/template/.make-docs/system/prompts/request-to-design.prompt.md +20 -0
- package/template/.make-docs/system/prompts/session-to-history-record.prompt.md +23 -0
- package/template/{docs/assets → .make-docs/system}/prompts/work-to-commit-message.prompt.md +2 -2
- package/template/.make-docs/system/prompts/work-to-guides.prompt.md +22 -0
- package/template/.make-docs/system/references/AGENTS.md +14 -0
- package/template/.make-docs/system/references/CLAUDE.md +14 -0
- package/template/{docs/assets → .make-docs/system}/references/design-workflow.md +15 -2
- package/template/.make-docs/system/references/execution-workflow.md +189 -0
- package/template/.make-docs/system/references/human-experience.md +138 -0
- package/template/.make-docs/system/references/lifecycle.md +153 -0
- package/template/.make-docs/system/references/naive-uat-validation.md +65 -0
- package/template/.make-docs/system/references/naive-uat-workflow.md +64 -0
- package/template/.make-docs/system/references/path-and-link-hygiene.md +101 -0
- package/template/.make-docs/system/references/performance-evidence.md +114 -0
- package/template/.make-docs/system/references/planning-workflow.md +209 -0
- package/template/.make-docs/system/references/prd-change-management.md +165 -0
- package/template/{docs/assets → .make-docs/system}/references/wave-model.md +10 -8
- package/template/.make-docs/system/templates/AGENTS.md +12 -0
- package/template/.make-docs/system/templates/CLAUDE.md +12 -0
- package/template/.make-docs/system/templates/design.md +79 -0
- package/template/{docs/assets/templates/guide-developer.md → .make-docs/system/templates/guide-maintainer.md} +7 -3
- package/template/{docs/assets → .make-docs/system}/templates/guide-user.md +6 -2
- package/template/{docs/assets → .make-docs/system}/templates/history-record.md +6 -3
- package/template/.make-docs/system/templates/naive-uat-scenario.md +91 -0
- package/template/.make-docs/system/templates/performance-evidence-profile.md +252 -0
- package/template/.make-docs/system/templates/plan-overview.md +76 -0
- package/template/.make-docs/system/templates/plan-prd-change.md +155 -0
- package/template/{docs/assets → .make-docs/system}/templates/plan-prd-decompose.md +10 -0
- package/template/{docs/assets → .make-docs/system}/templates/plan-prd.md +28 -2
- package/template/{docs/assets → .make-docs/system}/templates/prd-architecture.md +13 -0
- package/template/.make-docs/system/templates/prd-glossary.md +28 -0
- package/template/.make-docs/system/templates/prd-index.md +70 -0
- package/template/{docs/assets → .make-docs/system}/templates/prd-overview.md +13 -0
- package/template/.make-docs/system/templates/prd-reference.md +30 -0
- package/template/{docs/assets → .make-docs/system}/templates/prd-risk-register.md +16 -1
- package/template/{docs/assets → .make-docs/system}/templates/prd-subsystem.md +15 -0
- package/template/.make-docs/system/templates/work-index.md +58 -0
- package/template/.make-docs/system/templates/work-phase.md +107 -0
- package/template/.make-docs/system-resources.catalog.json +91 -0
- package/template/.make-docs/system-resources.schema.json +204 -0
- package/template/AGENTS.md +8 -1
- package/template/CLAUDE.md +8 -1
- package/template/docs/AGENTS.codex-only.md +22 -0
- package/template/docs/AGENTS.md +21 -13
- package/template/docs/CLAUDE.claude-only.md +22 -0
- package/template/docs/CLAUDE.md +21 -13
- package/template/docs/assets/AGENTS.md +11 -7
- package/template/docs/assets/CLAUDE.md +11 -7
- package/template/docs/designs/AGENTS.md +8 -3
- package/template/docs/designs/CLAUDE.md +8 -3
- package/template/docs/plans/AGENTS.md +10 -3
- package/template/docs/plans/CLAUDE.md +10 -3
- package/template/docs/prd/AGENTS.md +14 -4
- package/template/docs/prd/CLAUDE.md +14 -4
- package/template/docs/work/AGENTS.md +10 -3
- package/template/docs/work/CLAUDE.md +10 -3
- package/dist/chunk-HP3HBG7F.js +0 -626
- package/dist/chunk-HP3HBG7F.js.map +0 -1
- package/dist/chunk-QRFH4J6H.js +0 -1194
- package/dist/chunk-QRFH4J6H.js.map +0 -1
- package/dist/chunk-WM3OXYTW.js +0 -2630
- package/dist/chunk-WM3OXYTW.js.map +0 -1
- package/dist/skills-command-3ESCZ75U.js.map +0 -1
- package/dist/uninstall-GQE4SJF2.js +0 -150
- package/dist/uninstall-GQE4SJF2.js.map +0 -1
- package/template/.make-docs/scripts/check_path_hygiene.py +0 -435
- package/template/docs/assets/archive/AGENTS.md +0 -20
- package/template/docs/assets/archive/CLAUDE.md +0 -20
- package/template/docs/assets/history/AGENTS.md +0 -12
- package/template/docs/assets/history/CLAUDE.md +0 -12
- package/template/docs/assets/prompts/AGENTS.md +0 -8
- package/template/docs/assets/prompts/CLAUDE.md +0 -8
- package/template/docs/assets/prompts/designs-to-plan-change.prompt.md +0 -14
- package/template/docs/assets/prompts/designs-to-plan.prompt.md +0 -10
- package/template/docs/assets/prompts/docs-path-hygiene-cleanup.prompt.md +0 -27
- package/template/docs/assets/prompts/plan-to-prd-change.prompt.md +0 -8
- package/template/docs/assets/prompts/plan-to-prd-green-field.prompt.md +0 -6
- package/template/docs/assets/prompts/prd-change-to-work.prompt.md +0 -10
- package/template/docs/assets/prompts/prd-to-work-full-prd.prompt.md +0 -6
- package/template/docs/assets/prompts/prd-to-work-prd-feature.prompt.md +0 -6
- package/template/docs/assets/prompts/request-to-design.prompt.md +0 -16
- package/template/docs/assets/prompts/session-to-history-record.prompt.md +0 -19
- package/template/docs/assets/prompts/work-to-guides.prompt.md +0 -18
- package/template/docs/assets/references/AGENTS.md +0 -9
- package/template/docs/assets/references/CLAUDE.md +0 -9
- package/template/docs/assets/references/execution-workflow.md +0 -157
- package/template/docs/assets/references/output-contract.md +0 -221
- package/template/docs/assets/references/path-and-link-hygiene.md +0 -49
- package/template/docs/assets/references/planning-workflow.md +0 -160
- package/template/docs/assets/references/prd-change-management.md +0 -129
- package/template/docs/assets/templates/AGENTS.md +0 -8
- package/template/docs/assets/templates/CLAUDE.md +0 -8
- package/template/docs/assets/templates/design.md +0 -30
- package/template/docs/assets/templates/plan-overview.md +0 -32
- package/template/docs/assets/templates/plan-prd-change.md +0 -99
- package/template/docs/assets/templates/prd-change-addition.md +0 -45
- package/template/docs/assets/templates/prd-change-revision.md +0 -45
- package/template/docs/assets/templates/prd-glossary.md +0 -15
- package/template/docs/assets/templates/prd-index.md +0 -45
- package/template/docs/assets/templates/prd-reference.md +0 -17
- package/template/docs/assets/templates/work-index.md +0 -21
- package/template/docs/assets/templates/work-phase.md +0 -34
- package/template/docs/guides/AGENTS.md +0 -15
- package/template/docs/guides/CLAUDE.md +0 -15
- /package/template/{docs/assets → .make-docs/system}/prompts/update-readme-green-field.prompt.md +0 -0
- /package/template/{docs/assets → .make-docs/system}/references/harness-capability-matrix.md +0 -0
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "PRD Authority Maintenance Plan"
|
|
3
|
+
kind: "plan"
|
|
4
|
+
status: "draft"
|
|
5
|
+
coordinate: "W{{W}} R{{R}}"
|
|
6
|
+
# source:
|
|
7
|
+
# type: "design"
|
|
8
|
+
# path: "{{SOURCE_PATH}}"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# PRD Authority Maintenance Plan
|
|
12
|
+
|
|
13
|
+
> In v2, plans are directories. Use this template as the shape of the `00-overview.md` file in the plan directory; split additional detail into `0N-<phase>.md` files as needed.
|
|
14
|
+
|
|
15
|
+
**Date:** {{DATE}}
|
|
16
|
+
|
|
17
|
+
**Repository:** `{{REPO_ROOT}}`
|
|
18
|
+
|
|
19
|
+
**Purpose:** Produce a reviewable plan for keeping the active PRD set aligned with the current authoritative shape of the product.
|
|
20
|
+
|
|
21
|
+
## Objective
|
|
22
|
+
|
|
23
|
+
State what product authority may change, why maintenance is needed, who the outputs are for, and what counts as completion.
|
|
24
|
+
|
|
25
|
+
## Governing Invariant
|
|
26
|
+
|
|
27
|
+
> `docs/prd/` describes the current authoritative shape of the product. It must never describe the editorial operation used to change that authority.
|
|
28
|
+
|
|
29
|
+
Implementation sequencing, migration actions, reconciliation work, and editorial language stay in this plan, downstream work backlogs, and history records.
|
|
30
|
+
|
|
31
|
+
## Coordinate Decision
|
|
32
|
+
|
|
33
|
+
- Coordinate: `W{{W}} R{{R}}`
|
|
34
|
+
- Classification: `new-wave` or `revision`
|
|
35
|
+
- Evidence: Explain the explicit user guidance, design handoff, source lineage, prior plan/work/history records, or highest-wave fallback used to choose this coordinate.
|
|
36
|
+
|
|
37
|
+
The coordinate identifies this maintenance plan. Product PRDs do not use W/R/P as document identity; carry the coordinate into requirement-history entries and source links only.
|
|
38
|
+
|
|
39
|
+
## Maintenance Inputs
|
|
40
|
+
|
|
41
|
+
List every source of truth that feeds into the maintenance plan. Each entry should note its format, location, and confidence level.
|
|
42
|
+
|
|
43
|
+
| Input | Format | Location | Confidence |
|
|
44
|
+
| --- | --- | --- | --- |
|
|
45
|
+
| {{INPUT_NAME}} | {{FORMAT}} | {{LOCATION}} | {{CONFIDENCE}} |
|
|
46
|
+
|
|
47
|
+
Open questions or ambiguities should be captured here and promoted into `docs/prd/03-open-questions-and-risk-register.md` during execution when appropriate.
|
|
48
|
+
|
|
49
|
+
## Human Experience Propagation
|
|
50
|
+
|
|
51
|
+
Use `.make-docs/system/contracts/human-experience-contract.md` as authority and `.make-docs/system/references/human-experience.md` for examples. Link to the source design or accepted change authority. Do not copy the standard into this plan.
|
|
52
|
+
|
|
53
|
+
For `direct` or `indirect` impact, map each accepted promise:
|
|
54
|
+
|
|
55
|
+
| Promise | Existing or planned owning PRD | Human-facing surface or indirect effect | Work phase | Evidence source or selected testing type | Accepted obligation, if any |
|
|
56
|
+
| --- | --- | --- | --- | --- | --- |
|
|
57
|
+
| {{PROMISE}} | {{PRD_AUTHORITY}} | {{SURFACE_OR_EFFECT}} | {{WORK_PHASE}} | {{EVIDENCE_OR_TESTING_TYPE}} | {{O_REF_OR_NONE}} |
|
|
58
|
+
|
|
59
|
+
For `none`, replace the table with the preserved human boundary and the evidence that will prove it unchanged.
|
|
60
|
+
|
|
61
|
+
## Active Authority Baseline
|
|
62
|
+
|
|
63
|
+
- Active `docs/prd/` status: {{ACTIVE_PRD_STATUS}}
|
|
64
|
+
- Current index: `docs/prd/00-index.md`
|
|
65
|
+
- Discovery pass required: {{DISCOVERY_REQUIRED}} <!-- yes | no -->
|
|
66
|
+
- Discovery scope if required: {{DISCOVERY_SCOPE}}
|
|
67
|
+
- Known noncompliance or legacy editorial PRDs: {{LEGACY_PRD_NOTES}}
|
|
68
|
+
|
|
69
|
+
## Candidate Decision Matrix
|
|
70
|
+
|
|
71
|
+
Assign exactly one decision to every candidate requirement: `update-existing`, `create`, `link-only`, or `none`.
|
|
72
|
+
|
|
73
|
+
| Candidate | Decision | Owning PRD or new product subject | Reason | Evidence |
|
|
74
|
+
| --- | --- | --- | --- | --- |
|
|
75
|
+
| {{CANDIDATE}} | {{DECISION}} | {{OWNER_OR_SUBJECT}} | {{REASON}} | {{EVIDENCE}} |
|
|
76
|
+
|
|
77
|
+
## Existing PRDs To Update
|
|
78
|
+
|
|
79
|
+
List existing product authorities whose subject already owns the changed requirement. Changes must be surgical: current normative text is updated inline and unrelated material is preserved.
|
|
80
|
+
|
|
81
|
+
| Existing PRD | Owning sections | Current normative update | Preserved surrounding authority |
|
|
82
|
+
| --- | --- | --- | --- |
|
|
83
|
+
| `{{PRD_PATH}}` | {{SECTIONS}} | {{CURRENT_UPDATE}} | {{PRESERVATION_NOTES}} |
|
|
84
|
+
|
|
85
|
+
## Genuinely New Product PRDs
|
|
86
|
+
|
|
87
|
+
List only coherent, wholesale new capabilities, subsystems, or product boundaries with no suitable existing owner. If none are warranted, record `none` and the reason.
|
|
88
|
+
|
|
89
|
+
| New PRD | Product-oriented kind | Coherent subject | Why no existing owner is suitable |
|
|
90
|
+
| --- | --- | --- | --- |
|
|
91
|
+
| `docs/prd/{{NEXT_NUMBER}}-{{PRODUCT_SUBJECT_SLUG}}.md` | {{KIND}} | {{PRODUCT_SUBJECT}} | {{RATIONALE}} |
|
|
92
|
+
|
|
93
|
+
Do not plan PRDs whose filenames, titles, kinds, or subjects describe additions, enhancements, revisions, removals, migrations, or reconciliation.
|
|
94
|
+
|
|
95
|
+
## Requirement History Entries
|
|
96
|
+
|
|
97
|
+
List material prior contracts that should be preserved after the current normative requirement is updated. Requirement history is non-normative and never replaces the current body.
|
|
98
|
+
|
|
99
|
+
| Owning PRD | Date / coordinate | Affected requirement or section | Previous contract | Replacement contract | Rationale | Source |
|
|
100
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
101
|
+
| `{{PRD_PATH}}` | {{DATE_AND_COORDINATE}} | {{REQUIREMENT_OR_SECTION}} | {{PREVIOUS_CONTRACT}} | {{REPLACEMENT_CONTRACT}} | {{RATIONALE}} | {{SOURCE}} |
|
|
102
|
+
|
|
103
|
+
## Affected Links, Risks, Plans, And Work
|
|
104
|
+
|
|
105
|
+
| Surface | Artifact | Required maintenance | Authority role |
|
|
106
|
+
| --- | --- | --- | --- |
|
|
107
|
+
| Links and index | {{INDEX_OR_LINK_PATH}} | {{LINK_UPDATE}} | Navigation only |
|
|
108
|
+
| Risks and decisions | `docs/prd/03-open-questions-and-risk-register.md` | {{RISK_UPDATE}} | Living risk and decision register |
|
|
109
|
+
| Plans | {{PLAN_PATHS}} | {{PLAN_UPDATE}} | Sequencing and rationale |
|
|
110
|
+
| Work | {{WORK_PATHS}} | {{WORK_UPDATE}} | Implementation queue |
|
|
111
|
+
| History | {{HISTORY_PATHS}} | {{HISTORY_UPDATE}} | Execution provenance |
|
|
112
|
+
|
|
113
|
+
## Output Contract
|
|
114
|
+
|
|
115
|
+
- Plan directory: `docs/plans/{{DATE}}-w{{W}}-r{{R}}-{{MAINTENANCE_SLUG}}/`
|
|
116
|
+
- entry point: `docs/plans/{{DATE}}-w{{W}}-r{{R}}-{{MAINTENANCE_SLUG}}/00-overview.md`
|
|
117
|
+
- phase files: `docs/plans/{{DATE}}-w{{W}}-r{{R}}-{{MAINTENANCE_SLUG}}/0N-<phase>.md`
|
|
118
|
+
- Existing authoritative PRDs to update: {{EXISTING_PRD_TARGETS}}
|
|
119
|
+
- Genuinely new authoritative PRDs, if any: {{NEW_PRD_TARGETS}}
|
|
120
|
+
- Requirement-history entries: {{HISTORY_ENTRY_TARGETS}}
|
|
121
|
+
- Shared PRD surfaces: {{INDEX_AND_RISK_TARGETS}}
|
|
122
|
+
- Delta backlog:
|
|
123
|
+
- `docs/work/{{DATE}}-w{{W}}-r{{R}}-{{MAINTENANCE_SLUG}}/`
|
|
124
|
+
|
|
125
|
+
## Worker Ownership
|
|
126
|
+
|
|
127
|
+
List delegated workers, their scopes, write scopes, dependencies, and deliverables.
|
|
128
|
+
|
|
129
|
+
- Assign every output-writing task to a worker when delegation is available.
|
|
130
|
+
- Keep existing-owner updates, genuinely new product PRDs, shared index/risk maintenance, delta backlog generation, and validation as separate write scopes whenever practical.
|
|
131
|
+
- Include a dedicated validation or fix worker when the harness can support it.
|
|
132
|
+
- The coordinator should not appear as the owner of any document-writing task when delegation is available.
|
|
133
|
+
|
|
134
|
+
| Worker | Scope | Write Scope | Dependencies | Deliverables |
|
|
135
|
+
| --- | --- | --- | --- | --- |
|
|
136
|
+
| {{WORKER_NAME}} | {{SCOPE}} | {{WRITE_SCOPE}} | {{DEPENDENCIES}} | {{DELIVERABLES}} |
|
|
137
|
+
|
|
138
|
+
## MCP Strategy
|
|
139
|
+
|
|
140
|
+
- Preferred servers available: {{MCP_STATUS}}
|
|
141
|
+
- Fallback plan if unavailable: {{FALLBACK_PLAN}}
|
|
142
|
+
|
|
143
|
+
## Validation
|
|
144
|
+
|
|
145
|
+
Explain how execution will validate the outputs. Validation should confirm:
|
|
146
|
+
|
|
147
|
+
- every candidate has one decision and a reason
|
|
148
|
+
- every accepted Human Experience promise reaches its owning capability PRD, work phase, and suitable evidence or an accepted obligation; a `none` decision records and proves its preserved human boundary
|
|
149
|
+
- current normative requirements live inline in their owning PRDs
|
|
150
|
+
- every new PRD is a coherent product authority rather than an editorial record
|
|
151
|
+
- every material prior contract is preserved only in a standardized, non-normative `## Requirement History` entry
|
|
152
|
+
- `docs/prd/00-index.md` uses product-oriented kinds and current-authority links
|
|
153
|
+
- removals and deprecations are expressed as current scope, non-goal, limitation, status, or boundary statements before history is recorded
|
|
154
|
+
- the delta backlog cites updated authoritative PRDs, not retired change records
|
|
155
|
+
- no existing PRD was renumbered or broadly rewritten without an ownership-based reason
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Codebase Decomposition Plan"
|
|
3
|
+
kind: "plan"
|
|
4
|
+
status: "draft"
|
|
5
|
+
coordinate: "W{{W}} R{{R}}"
|
|
6
|
+
# source:
|
|
7
|
+
# type: "manual-request"
|
|
8
|
+
# path: "{{SOURCE_PATH}}"
|
|
9
|
+
---
|
|
10
|
+
|
|
1
11
|
# Codebase Decomposition Plan
|
|
2
12
|
|
|
3
13
|
> In v2, plans are directories. Use this template as the shape of the `00-overview.md` file in the plan directory; split additional detail into `0N-<phase>.md` files as needed.
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "PRD Generation Plan"
|
|
3
|
+
kind: "plan"
|
|
4
|
+
status: "draft"
|
|
5
|
+
coordinate: "W{{W}} R{{R}}"
|
|
6
|
+
# source:
|
|
7
|
+
# type: "design"
|
|
8
|
+
# path: "{{SOURCE_PATH}}"
|
|
9
|
+
---
|
|
10
|
+
|
|
1
11
|
# PRD Generation Plan
|
|
2
12
|
|
|
3
13
|
> In v2, plans are directories. Use this template as the shape of the `00-overview.md` file in the plan directory; split additional detail into `0N-<phase>.md` files as needed.
|
|
@@ -6,11 +16,11 @@
|
|
|
6
16
|
|
|
7
17
|
**Repository:** `{{REPO_ROOT}}`
|
|
8
18
|
|
|
9
|
-
**Purpose:** Produce a reviewable plan for
|
|
19
|
+
**Purpose:** Produce a reviewable plan for a greenfield or first active PRD namespace, or for an explicitly approved full-set replacement, and its implementation backlog.
|
|
10
20
|
|
|
11
21
|
## Objective
|
|
12
22
|
|
|
13
|
-
State what the PRD set should capture, who the outputs are for, and what counts as completion.
|
|
23
|
+
State what the PRD set should capture, who the outputs are for, and what counts as completion. Use this template only for a greenfield or first namespace, or when the owner explicitly approves full-set replacement. If an active namespace exists and the request adds or changes product authority, use `plan-prd-change.md` for authoritative in-place maintenance instead.
|
|
14
24
|
|
|
15
25
|
## Coordinate Decision
|
|
16
26
|
|
|
@@ -28,6 +38,18 @@ List every source of truth that feeds into PRD generation. Each entry should not
|
|
|
28
38
|
|
|
29
39
|
Open questions or ambiguities in the inputs should be captured here and promoted into `03-open-questions-and-risk-register.md` during execution.
|
|
30
40
|
|
|
41
|
+
## Human Experience Propagation
|
|
42
|
+
|
|
43
|
+
Use `.make-docs/system/contracts/human-experience-contract.md` as authority and `.make-docs/system/references/human-experience.md` for examples. Link to the source design. Do not copy the standard into this plan.
|
|
44
|
+
|
|
45
|
+
For `direct` or `indirect` impact, map each accepted promise:
|
|
46
|
+
|
|
47
|
+
| Promise | Owning or planned PRD | Human-facing surface or indirect effect | Work phase | Evidence source or selected testing type | Accepted obligation, if any |
|
|
48
|
+
| --- | --- | --- | --- | --- | --- |
|
|
49
|
+
| {{PROMISE}} | {{PRD_AUTHORITY}} | {{SURFACE_OR_EFFECT}} | {{WORK_PHASE}} | {{EVIDENCE_OR_TESTING_TYPE}} | {{O_REF_OR_NONE}} |
|
|
50
|
+
|
|
51
|
+
For `none`, replace the table with the preserved human boundary and the evidence that will prove it unchanged.
|
|
52
|
+
|
|
31
53
|
## Existing Codebase Context
|
|
32
54
|
|
|
33
55
|
- Codebase status: {{CODEBASE_STATUS}} <!-- greenfield | existing-active | existing-legacy -->
|
|
@@ -53,10 +75,13 @@ Open questions or ambiguities in the inputs should be captured here and promoted
|
|
|
53
75
|
## Existing PRD Handling
|
|
54
76
|
|
|
55
77
|
- Active `docs/prd/` status: {{ACTIVE_PRD_STATUS}}
|
|
78
|
+
- Eligible mode: `first-namespace` or `explicitly-approved-full-set-replacement`
|
|
56
79
|
- Archive step required before execution: {{ARCHIVE_REQUIRED}}
|
|
57
80
|
- Planned archive target if approved: `{{ARCHIVE_TARGET}}`
|
|
58
81
|
- Active root entries to archive: {{ARCHIVE_ENTRIES}}
|
|
59
82
|
|
|
83
|
+
Do not use this template to route an addition into an existing namespace. Without explicit full-set-replacement approval, stop and use the PRD authority-maintenance plan.
|
|
84
|
+
|
|
60
85
|
## Coordinator Policy
|
|
61
86
|
|
|
62
87
|
- Highest intended delegation tier: {{DELEGATION_TIER}}
|
|
@@ -116,6 +141,7 @@ Describe how workers should derive acceptance criteria within each PRD. Criteria
|
|
|
116
141
|
Explain how the execution step will validate the generated outputs. Validation should confirm:
|
|
117
142
|
|
|
118
143
|
- Every design input is accounted for in at least one PRD.
|
|
144
|
+
- Every accepted Human Experience promise is assigned to the PRD that owns the affected capability, a work phase, and suitable evidence or an accepted obligation. A `none` boundary has proof that it stays unchanged.
|
|
119
145
|
- Every adaptive PRD traces back to a design input or a discovered integration need.
|
|
120
146
|
- The implementation backlog covers all PRDs with no orphaned or unreachable items.
|
|
121
147
|
- Open questions are captured and none block backlog generation without explicit acknowledgment.
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "02 Architecture Overview"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
# source:
|
|
6
|
+
# type: "plan"
|
|
7
|
+
# path: "{{SOURCE_PATH}}"
|
|
8
|
+
---
|
|
9
|
+
|
|
1
10
|
# 02 Architecture Overview
|
|
2
11
|
|
|
3
12
|
## Purpose
|
|
@@ -44,6 +53,10 @@ Code anchors:
|
|
|
44
53
|
|
|
45
54
|
- `{{CONFIG_PATHS}}`
|
|
46
55
|
|
|
56
|
+
## Requirement History
|
|
57
|
+
|
|
58
|
+
Optional and non-normative. Omit this section until a material prior contract needs to remain visible. Current requirements above always win. For each entry, record the date, coordinate when known, affected requirement or section, previous contract, replacement contract, rationale, and source using `.make-docs/system/references/prd-change-management.md`.
|
|
59
|
+
|
|
47
60
|
## Source Anchors
|
|
48
61
|
|
|
49
62
|
- `{{ENTRYPOINTS}}`
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "04 Glossary"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
# source:
|
|
6
|
+
# type: "plan"
|
|
7
|
+
# path: "{{SOURCE_PATH}}"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 04 Glossary
|
|
11
|
+
|
|
12
|
+
## Purpose
|
|
13
|
+
|
|
14
|
+
Define the canonical vocabulary used across this PRD set so humans and coding assistants interpret the same terms the same way.
|
|
15
|
+
|
|
16
|
+
## Terms
|
|
17
|
+
|
|
18
|
+
| Term | Definition | Notes |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| `{{TERM}}` | Explain the term in plain English. | Link it back to the subsystem or workflow that uses it. |
|
|
21
|
+
|
|
22
|
+
## Requirement History
|
|
23
|
+
|
|
24
|
+
Optional and non-normative. Omit this section until a material prior terminology contract needs to remain visible. Current definitions above always win. For each entry, record the date, coordinate when known, affected term, previous contract, replacement contract, rationale, and source using `.make-docs/system/references/prd-change-management.md`.
|
|
25
|
+
|
|
26
|
+
## Source Anchors
|
|
27
|
+
|
|
28
|
+
- `{{PRIMARY_FILES}}`
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "{{PRODUCT_NAME}} PRD Index"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
follow_on:
|
|
6
|
+
route: "work-backlog-generation"
|
|
7
|
+
next_prompt: "make-docs://system/prompt/prd-to-work-full-prd.prompt.md"
|
|
8
|
+
why: "The PRD set should become the effective contract before phase-sized implementation work is queued."
|
|
9
|
+
coordinate_handoff: "Carry the plan or source W/R lineage named by this PRD set into docs/work/."
|
|
10
|
+
# source:
|
|
11
|
+
# type: "plan"
|
|
12
|
+
# path: "{{SOURCE_PATH}}"
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# {{PRODUCT_NAME}} PRD Index
|
|
16
|
+
|
|
17
|
+
## Purpose
|
|
18
|
+
|
|
19
|
+
Explain what this PRD set covers, who it is for, and why it exists.
|
|
20
|
+
|
|
21
|
+
This index maps the current authoritative shape of the product. It never catalogs the editorial operations used to change that authority.
|
|
22
|
+
|
|
23
|
+
## Reading Order
|
|
24
|
+
|
|
25
|
+
1. {{PRODUCT_OVERVIEW_LINK}}
|
|
26
|
+
2. {{ARCHITECTURE_OVERVIEW_LINK}}
|
|
27
|
+
3. {{RISK_REGISTER_LINK}}
|
|
28
|
+
4. {{GLOSSARY_LINK}}
|
|
29
|
+
5. Add the adaptive capability, subsystem, and reference authorities here in the order that best rebuilds understanding.
|
|
30
|
+
|
|
31
|
+
## Document Map
|
|
32
|
+
|
|
33
|
+
| Document | Kind | Status | Related Docs | Focus |
|
|
34
|
+
| --- | --- | --- | --- | --- |
|
|
35
|
+
| {{INDEX_LINK}} | `core` | `active` | `—` | Explain the PRD set and how to read it |
|
|
36
|
+
| {{PRODUCT_OVERVIEW_LINK}} | `core` | `active` | `—` | Explain product purpose, users, capabilities, boundaries, and limitations |
|
|
37
|
+
| {{ARCHITECTURE_OVERVIEW_LINK}} | `core` | `active` | `—` | Explain topology, module map, runtime boundaries, data flow, and config surfaces |
|
|
38
|
+
| {{RISK_REGISTER_LINK}} | `core` | `active` | `—` | Capture drift, gaps, and rebuild risks |
|
|
39
|
+
| {{GLOSSARY_LINK}} | `core` | `active` | `—` | Define canonical terms |
|
|
40
|
+
| {{ADAPTIVE_DOC_LINKS}} | `capability`, `subsystem`, or `reference` | Current product-authority status | List related current authorities | Explain the current product subject owned by this PRD |
|
|
41
|
+
|
|
42
|
+
## Source Anchors
|
|
43
|
+
|
|
44
|
+
- `README.md`
|
|
45
|
+
- `package.json`
|
|
46
|
+
- `{{PRIMARY_ENTRYPOINT}}`
|
|
47
|
+
- `{{PRIMARY_DOCS}}`
|
|
48
|
+
|
|
49
|
+
## Audience Paths
|
|
50
|
+
|
|
51
|
+
### New developer
|
|
52
|
+
|
|
53
|
+
List the best reading path for a developer joining the project.
|
|
54
|
+
|
|
55
|
+
### Product or technical lead
|
|
56
|
+
|
|
57
|
+
List the best reading path for product, architecture, or planning review.
|
|
58
|
+
|
|
59
|
+
### AI coding assistant
|
|
60
|
+
|
|
61
|
+
List the fastest path for an assistant that needs safe, code-first context before making changes.
|
|
62
|
+
|
|
63
|
+
## Intended Follow-On
|
|
64
|
+
|
|
65
|
+
This handoff is advisory-default-but-overridable: it is authoritative unless the user explicitly overrides it, and it is not a gate or precondition.
|
|
66
|
+
|
|
67
|
+
- Route: `work-backlog-generation`
|
|
68
|
+
- Next step: Generate or update the work backlog from this PRD set.
|
|
69
|
+
- Why: The PRD set should become the effective contract before phase-sized implementation work is queued.
|
|
70
|
+
- Coordinate Handoff: Carry the plan or source W/R lineage named by this PRD set into `docs/work/`, or resolve the coordinate question before writing the backlog.
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "01 Product Overview"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
# source:
|
|
6
|
+
# type: "plan"
|
|
7
|
+
# path: "{{SOURCE_PATH}}"
|
|
8
|
+
---
|
|
9
|
+
|
|
1
10
|
# 01 Product Overview
|
|
2
11
|
|
|
3
12
|
## Purpose
|
|
@@ -36,6 +45,10 @@ Code anchors:
|
|
|
36
45
|
|
|
37
46
|
- `{{LIMITATION_PATHS}}`
|
|
38
47
|
|
|
48
|
+
## Requirement History
|
|
49
|
+
|
|
50
|
+
Optional and non-normative. Omit this section until a material prior contract needs to remain visible. Current requirements above always win. For each entry, record the date, coordinate when known, affected requirement or section, previous contract, replacement contract, rationale, and source using `.make-docs/system/references/prd-change-management.md`.
|
|
51
|
+
|
|
39
52
|
## Source Anchors
|
|
40
53
|
|
|
41
54
|
- `README.md`
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "{{NUMBER}} {{TITLE}}"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
# source:
|
|
6
|
+
# type: "plan"
|
|
7
|
+
# path: "{{SOURCE_PATH}}"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# {{NUMBER}} {{TITLE}}
|
|
11
|
+
|
|
12
|
+
## Purpose
|
|
13
|
+
|
|
14
|
+
Explain what this reference doc captures and why it should stay separate from subsystem narrative docs.
|
|
15
|
+
|
|
16
|
+
## Reference
|
|
17
|
+
|
|
18
|
+
Capture the schema, API, config, protocol, operational checklist, or other reference material in a table-heavy format.
|
|
19
|
+
|
|
20
|
+
Code anchors:
|
|
21
|
+
|
|
22
|
+
- `{{REFERENCE_PATHS}}`
|
|
23
|
+
|
|
24
|
+
## Requirement History
|
|
25
|
+
|
|
26
|
+
Optional and non-normative. Omit this section until a material prior contract needs to remain visible. Current reference requirements above always win. For each entry, record the date, coordinate when known, affected requirement or section, previous contract, replacement contract, rationale, and source using `.make-docs/system/references/prd-change-management.md`.
|
|
27
|
+
|
|
28
|
+
## Source Anchors
|
|
29
|
+
|
|
30
|
+
- `{{PRIMARY_FILES}}`
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "03 Open Questions and Risk Register"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
# source:
|
|
6
|
+
# type: "plan"
|
|
7
|
+
# path: "{{SOURCE_PATH}}"
|
|
8
|
+
---
|
|
9
|
+
|
|
1
10
|
# 03 Open Questions and Risk Register
|
|
2
11
|
|
|
3
12
|
## Purpose
|
|
@@ -8,7 +17,7 @@ Use this as the active PRD namespace's living register. When agents discover or
|
|
|
8
17
|
|
|
9
18
|
Each item under `## Confirmed Drift`, `## Open Questions`, and `## Rebuild Risks` should use one numbered `###` heading, a state table, and the body fields below. Use `D-001`, `D-002`, etc. under `## Confirmed Drift`; `Q-001`, `Q-002`, etc. under `## Open Questions`; and `R-001`, `R-002`, etc. under `## Rebuild Risks`. Assign the next available number inside the section and never renumber existing items, even when an item moves to `Closed`. Use `Open`, `Confirming`, `Deferred`, or `Closed` for `Status`. Add `Resolution` only when the item is closed.
|
|
10
19
|
|
|
11
|
-
Do not use
|
|
20
|
+
Do not use `## Requirement History` as a substitute for unresolved register state. This register tracks lineage through item IDs, `Decision`, `Follow-Up`, `Recommendation`, `To close`, and optional `Resolution`.
|
|
12
21
|
|
|
13
22
|
```markdown
|
|
14
23
|
### D-001 <Gap, Question, Drift, or Risk Title>
|
|
@@ -50,6 +59,12 @@ Code anchors:
|
|
|
50
59
|
|
|
51
60
|
- `{{RISK_PATHS}}`
|
|
52
61
|
|
|
62
|
+
## Deferred Obligations
|
|
63
|
+
|
|
64
|
+
Use this fixed section only when accepted required future outcomes are active.
|
|
65
|
+
Each record uses a stable heading `### O-### <title>` and includes status, source authority, owner, target coordinate, future trigger, dependencies, and acceptance exit criteria.
|
|
66
|
+
If no obligations are active, state `None currently.`
|
|
67
|
+
|
|
53
68
|
## Source Anchors
|
|
54
69
|
|
|
55
70
|
- `{{PRIMARY_FILES}}`
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "{{NUMBER}} {{TITLE}}"
|
|
3
|
+
kind: "prd"
|
|
4
|
+
status: "active"
|
|
5
|
+
# source:
|
|
6
|
+
# type: "plan"
|
|
7
|
+
# path: "{{SOURCE_PATH}}"
|
|
8
|
+
---
|
|
9
|
+
|
|
1
10
|
# {{NUMBER}} {{TITLE}}
|
|
2
11
|
|
|
3
12
|
## Purpose
|
|
@@ -16,6 +25,8 @@ Code anchors:
|
|
|
16
25
|
|
|
17
26
|
Describe the subsystem's components, modules, or pages and the capabilities they implement.
|
|
18
27
|
|
|
28
|
+
When this PRD owns an observable Human Experience outcome, state it as a current capability requirement here or in the closest owning section. Link to `.make-docs/system/contracts/human-experience-contract.md`. Keep the outcome observable. Do not copy the universal standard, create a separate editorial experience PRD, or add Human Experience frontmatter.
|
|
29
|
+
|
|
19
30
|
Code anchors:
|
|
20
31
|
|
|
21
32
|
- `{{COMPONENT_PATHS}}`
|
|
@@ -44,6 +55,10 @@ Code anchors:
|
|
|
44
55
|
|
|
45
56
|
- `{{REBUILD_PATHS}}`
|
|
46
57
|
|
|
58
|
+
## Requirement History
|
|
59
|
+
|
|
60
|
+
Optional and non-normative. Omit this section until a material prior contract needs to remain visible. Current subsystem requirements above always win. For each entry, record the date, coordinate when known, affected requirement or section, previous contract, replacement contract, rationale, and source using `.make-docs/system/references/prd-change-management.md`.
|
|
61
|
+
|
|
47
62
|
## Source Anchors
|
|
48
63
|
|
|
49
64
|
- `{{PRIMARY_FILES}}`
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "{{TITLE}}"
|
|
3
|
+
kind: "work"
|
|
4
|
+
status: "active"
|
|
5
|
+
coordinate: "W{{W}} R{{R}}"
|
|
6
|
+
follow_on:
|
|
7
|
+
route: "implementation-loop"
|
|
8
|
+
next_prompt: ".make-docs/system/references/execution-workflow.md"
|
|
9
|
+
why: "The backlog is the implementation queue derived from the plan and PRD contract."
|
|
10
|
+
coordinate_handoff: "Carry this backlog's W/R coordinate into phase history records and commits, adding the active P coordinate for each phase."
|
|
11
|
+
# source:
|
|
12
|
+
# type: "prd"
|
|
13
|
+
# path: "{{SOURCE_PATH}}"
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# {{TITLE}}
|
|
17
|
+
|
|
18
|
+
> In v2, work backlogs are directories. This template is the shape of the `00-index.md` entry-point file. Phase detail lives in sibling `0N-<phase>.md` files (see `work-phase.md`). See `.make-docs/system/references/wave-model.md` for W/R semantics.
|
|
19
|
+
|
|
20
|
+
## Purpose
|
|
21
|
+
|
|
22
|
+
Describe what this work directory covers and how to navigate its phase files.
|
|
23
|
+
|
|
24
|
+
## Human Experience Trace
|
|
25
|
+
|
|
26
|
+
Use `.make-docs/system/contracts/human-experience-contract.md` as authority. Retain the source design, plan, owning PRDs, dependency-ordered phase, evidence decision, implementation gate, and accepted obligation for each applicable promise.
|
|
27
|
+
|
|
28
|
+
| Impact or promise | Source design and plan | Owning PRD or preserved boundary | Work phase | Evidence source or selected testing type | Implementation gate | Accepted obligation, if any |
|
|
29
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
30
|
+
| {{IMPACT_OR_PROMISE}} | {{SOURCE_DESIGN_AND_PLAN}} | {{PRD_OR_BOUNDARY}} | {{WORK_PHASE}} | {{EVIDENCE_OR_TESTING_TYPE}} | {{IMPLEMENTATION_GATE}} | {{O_REF_OR_NONE}} |
|
|
31
|
+
|
|
32
|
+
For `none`, state the preserved human boundary and link the proof that it stays unchanged. Do not invent a human flow.
|
|
33
|
+
|
|
34
|
+
## Phase Map
|
|
35
|
+
|
|
36
|
+
| File | Purpose |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| {{PHASE_ONE_LINK}} | {{PHASE_ONE_PURPOSE}} |
|
|
39
|
+
| {{PHASE_TWO_LINK}} | {{PHASE_TWO_PURPOSE}} |
|
|
40
|
+
|
|
41
|
+
## Usage Notes
|
|
42
|
+
|
|
43
|
+
- Read phases in order unless otherwise noted.
|
|
44
|
+
- Keep phase files dependency-ordered.
|
|
45
|
+
- Every phase file must include `## Source PRD Docs`.
|
|
46
|
+
- Link every phase back to the relevant PRD docs.
|
|
47
|
+
- Keep each accepted Human Experience promise or preserved `none` boundary traceable through its owning phase, evidence decision, implementation gate, and any accepted obligation.
|
|
48
|
+
- When this backlog retains evidence for acceptance or review, create or update its central `evidence.md` report and add a relative link to it in this index. Follow the Acceptance-Case Evidence Retention section in `.make-docs/system/contracts/coverage-pass-contract.md`. The report explains the findings and links supporting evidence, including evidence already stored elsewhere. Do not create an empty report or link to a report that does not exist.
|
|
49
|
+
- When deferred obligations or Unassisted Goal Testing are in scope, inventory applicable `O-###`, activated `NUAT-###`, and finding links plus the expected phase versus capability status. Record `not-needed-now` without inventing an ID.
|
|
50
|
+
|
|
51
|
+
## Intended Follow-On
|
|
52
|
+
|
|
53
|
+
This handoff is advisory-default-but-overridable: it is authoritative unless the user explicitly overrides it, and it is not a gate or precondition.
|
|
54
|
+
|
|
55
|
+
- Route: `implementation-loop`
|
|
56
|
+
- Next step: Start with the first applicable phase in this backlog and continue phase-by-phase.
|
|
57
|
+
- Why: The backlog is the implementation queue derived from the plan and PRD contract.
|
|
58
|
+
- Coordinate Handoff: Carry this backlog's W/R coordinate into phase history records and commits, adding the active P coordinate for each phase.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Phase {{PHASE_NUMBER}}: {{PHASE_TITLE}}"
|
|
3
|
+
kind: "work"
|
|
4
|
+
status: "active"
|
|
5
|
+
coordinate: "W{{W}} R{{R}} P{{PHASE_NUMBER}}"
|
|
6
|
+
# source:
|
|
7
|
+
# type: "prd"
|
|
8
|
+
# path: "{{SOURCE_PATH}}"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Phase {{PHASE_NUMBER}}: {{PHASE_TITLE}}
|
|
12
|
+
|
|
13
|
+
> Shape for `0N-<phase>.md` files inside a work directory. See `.make-docs/system/references/wave-model.md` for W/R semantics.
|
|
14
|
+
|
|
15
|
+
## Purpose
|
|
16
|
+
|
|
17
|
+
Explain why this phase exists and what foundation it depends on.
|
|
18
|
+
|
|
19
|
+
## Overview
|
|
20
|
+
|
|
21
|
+
Explain the work covered by this phase and the value it unlocks.
|
|
22
|
+
|
|
23
|
+
## Human Experience Outcome
|
|
24
|
+
|
|
25
|
+
- Impact and governing promise or preserved boundary: {{IMPACT_AND_PROMISE_OR_BOUNDARY}}
|
|
26
|
+
- Intended human outcome: {{OBSERVABLE_HUMAN_OUTCOME_OR_UNCHANGED_BOUNDARY}}
|
|
27
|
+
- Human-facing surface or indirect effect: {{SURFACE_OR_EFFECT}}
|
|
28
|
+
- Implementation work: {{IMPLEMENTATION_WORK}}
|
|
29
|
+
- Evidence source or testing type selected under current authority: {{EVIDENCE_OR_TESTING_TYPE}}
|
|
30
|
+
- Executor: {{EXECUTOR}}
|
|
31
|
+
- Accepted obligation or deferral route: {{O_REF_OR_NONE}}
|
|
32
|
+
|
|
33
|
+
Link to the owning PRD requirement and `.make-docs/system/contracts/human-experience-contract.md`. For `none`, state how evidence will prove the boundary unchanged. Do not copy the standard.
|
|
34
|
+
|
|
35
|
+
## Current Testing Decisions
|
|
36
|
+
|
|
37
|
+
Record the current decision for each testing type. Do not activate a test only to fill this table. Use `not-needed-now` when evidence from that type cannot change a current decision. For each activated type, add or link the compact decision record required by current testing authority.
|
|
38
|
+
|
|
39
|
+
| Testing type | Current decision | Decision record or `not-needed-now` reason |
|
|
40
|
+
| --- | --- | --- |
|
|
41
|
+
| Automated Implementation Testing | {{AUTOMATED_IMPLEMENTATION_TESTING_DECISION}} | {{AUTOMATED_IMPLEMENTATION_TESTING_RECORD_OR_REASON}} |
|
|
42
|
+
| Performance Testing | {{PERFORMANCE_TESTING_DECISION}} | {{PERFORMANCE_TESTING_RECORD_OR_REASON}} |
|
|
43
|
+
| Guided Progress Review | {{GUIDED_PROGRESS_REVIEW_DECISION}} | {{GUIDED_PROGRESS_REVIEW_RECORD_OR_REASON}} |
|
|
44
|
+
| Unassisted Goal Testing | {{UNASSISTED_GOAL_TESTING_DECISION}} | {{UNASSISTED_GOAL_TESTING_RECORD_OR_REASON}} |
|
|
45
|
+
|
|
46
|
+
For each performance candidate, record only these lifecycle fields:
|
|
47
|
+
|
|
48
|
+
- Base maintenance action: `{{BASE_MAINTENANCE_ACTION}}`
|
|
49
|
+
- Performance applicability: `{{PERFORMANCE_APPLICABILITY}}`
|
|
50
|
+
- Canonical `PERF-###` profile link or `none`: {{CANONICAL_PERF_PROFILE_LINK_OR_NONE}}
|
|
51
|
+
- Finite evidence budget and stop-rule reference or `not-applicable`: {{PERFORMANCE_BUDGET_AND_STOP_REFERENCE_OR_NOT_APPLICABLE}}
|
|
52
|
+
- Execution packet link or `not-applicable`: {{PERFORMANCE_EXECUTION_PACKET_OR_NOT_APPLICABLE}}
|
|
53
|
+
- Outcome and evidence handoff or `none`: {{PERFORMANCE_OUTCOME_AND_EVIDENCE_HANDOFF_OR_NONE}}
|
|
54
|
+
- Gate disposition and supported-scope limit or `not-applicable`: {{PERFORMANCE_GATE_DISPOSITION_AND_SCOPE_OR_NOT_APPLICABLE}}
|
|
55
|
+
|
|
56
|
+
Human Experience Review is separate. Apply it as required agent review work for each applicable promise. Reuse suitable evidence. The agent inspects the available real result and records observations, conclusions, limits, and next actions. For completed direct human-facing work, normally include a short optional experience handoff with one to three normal-use steps, what to notice, and an invitation for feedback. A missing response does not block closure or create an obligation. Require a human response only when accepted authority explicitly defines a human acceptance gate. Do not record the review or handoff as a fifth testing type.
|
|
57
|
+
|
|
58
|
+
## Source PRD Docs
|
|
59
|
+
|
|
60
|
+
- {{SOURCE_PRD_LINK_ONE}}
|
|
61
|
+
- {{SOURCE_PRD_LINK_TWO}}
|
|
62
|
+
|
|
63
|
+
## Source Obligations, Scenarios, And Findings
|
|
64
|
+
|
|
65
|
+
- `{{O_REF_OR_NONE}}`
|
|
66
|
+
- `{{NUAT_REF_OR_NONE}}`
|
|
67
|
+
- `{{FINDING_REF_OR_NONE}}`
|
|
68
|
+
|
|
69
|
+
## Stage {{STAGE_NUMBER}} - {{STAGE_NAME}}
|
|
70
|
+
|
|
71
|
+
### Tasks
|
|
72
|
+
|
|
73
|
+
- [ ] t1: {{TASK}}
|
|
74
|
+
- [ ] t2: {{TASK}}
|
|
75
|
+
|
|
76
|
+
### Acceptance criteria
|
|
77
|
+
|
|
78
|
+
Use stable `A<number>` case IDs that are unique across this backlog's phases. When retaining evidence for acceptance or review, create or update the owning backlog's central `evidence.md` report. Link the relevant report sections from this phase's acceptance or closeout record. The report must explain the findings even when supporting evidence already exists elsewhere and no new capture folder is needed. Keep new acceptance-case captures in `evidence/a<number>/` only when needed; detailed reports in case folders are optional. Follow the Acceptance-Case Evidence Retention section in `.make-docs/system/contracts/coverage-pass-contract.md`.
|
|
79
|
+
|
|
80
|
+
Reject `UX is good`, `easy to use`, `intuitive`, and similar criteria. Replace each vague claim with an observable result on the named surface or evidence tied to the stated indirect effect. Use only examples that apply to this phase:
|
|
81
|
+
|
|
82
|
+
- The person can identify the current subject before machine detail.
|
|
83
|
+
- The person can understand how the result relates to its parent, prior state, or next item.
|
|
84
|
+
- Success, partial success, waiting, failure, and blocked state are distinct when applicable.
|
|
85
|
+
- The next useful action is visible when one exists.
|
|
86
|
+
- The person can understand an error and use the stated recovery path.
|
|
87
|
+
- Useful meaning appears first, and exact detail remains available through a clear secondary path.
|
|
88
|
+
- The person can complete the goal without first learning an unexplained internal identifier.
|
|
89
|
+
|
|
90
|
+
- A{{CASE_NUMBER}}: {{ACCEPTANCE}}
|
|
91
|
+
- A{{NEXT_CASE_NUMBER}}: {{ACCEPTANCE}}
|
|
92
|
+
|
|
93
|
+
### Dependencies
|
|
94
|
+
|
|
95
|
+
- {{DEPENDENCY}}
|
|
96
|
+
|
|
97
|
+
### Closeout Notes
|
|
98
|
+
|
|
99
|
+
- Four testing decisions: {{AUTOMATED_PERFORMANCE_GUIDED_UNASSISTED_DECISIONS}}
|
|
100
|
+
- Performance evidence: {{BASE_ACTION_APPLICABILITY_PROFILE_PACKET_RESULT_FINDING_WAIVER_EXPIRY_BUDGET_GATE_AND_SCOPE_OR_NONE}}
|
|
101
|
+
- Human Experience Review: {{PROMISE_CONCLUSIONS_EVIDENCE_REVIEWER_AND_LIMITS}}
|
|
102
|
+
- Optional experience handoff: {{SHORT_TRY_IT_STEPS_WHAT_TO_NOTICE_AND_OPTIONAL_FEEDBACK_OR_NOT_APPLICABLE}}
|
|
103
|
+
- Explicit human acceptance gate: {{AUTHORITY_SCOPE_REVIEWER_SURFACE_QUESTION_GATE_EFFECT_AND_RESPONSE_OR_NONE}}
|
|
104
|
+
- Evidence report: {{CENTRAL_EVIDENCE_REPORT_SECTION_LINKS_OR_REASON_NO_DURABLE_RECORD_IS_NEEDED}}
|
|
105
|
+
- Phase / capability status: {{PHASE_AND_CAPABILITY_STATUS}}
|
|
106
|
+
|
|
107
|
+
<!-- Insert additional STAGES as needed -->
|