@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
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
<!-- make-docs:begin -->
|
|
1
2
|
# Plans Directory
|
|
2
3
|
|
|
3
4
|
This directory contains approach and rationale documents created before execution begins. Plans are always directories: an entry-point `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
@@ -9,12 +10,18 @@ Pattern: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
|
9
10
|
- Inside the directory: `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
10
11
|
- Slug: lowercase, hyphens only, no special characters.
|
|
11
12
|
- Example: `docs/plans/2026-04-15-w1-r0-migration-strategy/` containing `00-overview.md`, `01-clean-room.md`, `02-integration.md`.
|
|
12
|
-
-
|
|
13
|
+
- Use a valid local `.make-docs/system/references/wave-model.md` body for W/R semantics. When it is absent, run `make-docs resource read make-docs://system/reference/wave-model.md`.
|
|
13
14
|
|
|
14
15
|
## Agent Instructions
|
|
15
16
|
|
|
16
|
-
- Before writing,
|
|
17
|
+
- Before writing, use a valid local `.make-docs/system/references/planning-workflow.md` body or, when it is absent, run `make-docs resource read make-docs://system/reference/planning-workflow.md`.
|
|
18
|
+
- For a new or materially updated governed plan, also read `.make-docs/system/contracts/human-experience-contract.md`, `.make-docs/system/references/human-experience.md`, and `.make-docs/system/references/lifecycle.md`. When a valid local body is absent, use its matching `make-docs://system/contract/human-experience-contract.md`, `make-docs://system/reference/human-experience.md`, or `make-docs://system/reference/lifecycle.md` URI.
|
|
19
|
+
- When a performance candidate exists, use the `performance-evidence` catalog workflow. Load `.make-docs/system/contracts/performance-evidence-governance.md`, or read `make-docs://system/contract/performance-evidence-governance.md` when the local body is absent. Under the same condition, load `.make-docs/system/prompts/performance-coverage.prompt.md` and `.make-docs/system/templates/performance-evidence-profile.md`, or read `make-docs://system/prompt/performance-coverage.prompt.md` and `make-docs://system/template/performance-evidence-profile.md` when a local body is absent. Do not load the prompt or template otherwise.
|
|
20
|
+
- For `00-overview.md`, use `.make-docs/system/templates/plan-overview.md` or run `make-docs resource read make-docs://system/template/plan-overview.md` when the local body is absent.
|
|
21
|
+
- For PRD authority-maintenance overview content, use `.make-docs/system/templates/plan-prd.md`, `.make-docs/system/templates/plan-prd-decompose.md`, or `.make-docs/system/templates/plan-prd-change.md`. When the selected local body is absent, run `make-docs resource read` with its exact `make-docs://system/template/plan-prd.md`, `make-docs://system/template/plan-prd-decompose.md`, or `make-docs://system/template/plan-prd-change.md` URI.
|
|
22
|
+
- PRD authority-maintenance plans list existing PRD owners to update, genuinely new product PRDs if any, requirement-history entries, and affected links, risks, plans, and work artifacts. Editorial change and revision language belongs here, not in `docs/prd/`.
|
|
17
23
|
- Always create the plan as a directory; even single-phase plans use the same shape with one `0N-<phase>.md` file.
|
|
18
24
|
- Apply the date-slug-W/R naming; do not backdate plans.
|
|
19
25
|
- Plans are written before execution, not retroactively.
|
|
20
|
-
- Archived plans live in
|
|
26
|
+
- Archived plans live in `.make-docs/archive/plans/`. Before first use, run `make-docs project surface ensure archive`. Never archive unless explicitly asked.
|
|
27
|
+
<!-- make-docs:end -->
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
<!-- make-docs:begin -->
|
|
1
2
|
# Plans Directory
|
|
2
3
|
|
|
3
4
|
This directory contains approach and rationale documents created before execution begins. Plans are always directories: an entry-point `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
@@ -9,12 +10,18 @@ Pattern: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
|
9
10
|
- Inside the directory: `00-overview.md` plus one or more `0N-<phase>.md` files.
|
|
10
11
|
- Slug: lowercase, hyphens only, no special characters.
|
|
11
12
|
- Example: `docs/plans/2026-04-15-w1-r0-migration-strategy/` containing `00-overview.md`, `01-clean-room.md`, `02-integration.md`.
|
|
12
|
-
-
|
|
13
|
+
- Use a valid local `.make-docs/system/references/wave-model.md` body for W/R semantics. When it is absent, run `make-docs resource read make-docs://system/reference/wave-model.md`.
|
|
13
14
|
|
|
14
15
|
## Agent Instructions
|
|
15
16
|
|
|
16
|
-
- Before writing,
|
|
17
|
+
- Before writing, use a valid local `.make-docs/system/references/planning-workflow.md` body or, when it is absent, run `make-docs resource read make-docs://system/reference/planning-workflow.md`.
|
|
18
|
+
- For a new or materially updated governed plan, also read `.make-docs/system/contracts/human-experience-contract.md`, `.make-docs/system/references/human-experience.md`, and `.make-docs/system/references/lifecycle.md`. When a valid local body is absent, use its matching `make-docs://system/contract/human-experience-contract.md`, `make-docs://system/reference/human-experience.md`, or `make-docs://system/reference/lifecycle.md` URI.
|
|
19
|
+
- When a performance candidate exists, use the `performance-evidence` catalog workflow. Load `.make-docs/system/contracts/performance-evidence-governance.md`, or read `make-docs://system/contract/performance-evidence-governance.md` when the local body is absent. Under the same condition, load `.make-docs/system/prompts/performance-coverage.prompt.md` and `.make-docs/system/templates/performance-evidence-profile.md`, or read `make-docs://system/prompt/performance-coverage.prompt.md` and `make-docs://system/template/performance-evidence-profile.md` when a local body is absent. Do not load the prompt or template otherwise.
|
|
20
|
+
- For `00-overview.md`, use `.make-docs/system/templates/plan-overview.md` or run `make-docs resource read make-docs://system/template/plan-overview.md` when the local body is absent.
|
|
21
|
+
- For PRD authority-maintenance overview content, use `.make-docs/system/templates/plan-prd.md`, `.make-docs/system/templates/plan-prd-decompose.md`, or `.make-docs/system/templates/plan-prd-change.md`. When the selected local body is absent, run `make-docs resource read` with its exact `make-docs://system/template/plan-prd.md`, `make-docs://system/template/plan-prd-decompose.md`, or `make-docs://system/template/plan-prd-change.md` URI.
|
|
22
|
+
- PRD authority-maintenance plans list existing PRD owners to update, genuinely new product PRDs if any, requirement-history entries, and affected links, risks, plans, and work artifacts. Editorial change and revision language belongs here, not in `docs/prd/`.
|
|
17
23
|
- Always create the plan as a directory; even single-phase plans use the same shape with one `0N-<phase>.md` file.
|
|
18
24
|
- Apply the date-slug-W/R naming; do not backdate plans.
|
|
19
25
|
- Plans are written before execution, not retroactively.
|
|
20
|
-
- Archived plans live in
|
|
26
|
+
- Archived plans live in `.make-docs/archive/plans/`. Before first use, run `make-docs project surface ensure archive`. Never archive unless explicitly asked.
|
|
27
|
+
<!-- make-docs:end -->
|
|
@@ -1,9 +1,19 @@
|
|
|
1
|
+
<!-- make-docs:begin -->
|
|
1
2
|
# PRD Router
|
|
2
3
|
|
|
3
|
-
This directory is
|
|
4
|
+
This directory is the active product-authority namespace.
|
|
4
5
|
|
|
5
|
-
- Files use `NN-<slug>.md`; fixed-core filenames and lifecycle rules live in
|
|
6
|
+
- Files use `NN-<slug>.md`; fixed-core filenames and lifecycle rules live in `.make-docs/system/contracts/output-contract.md`. When that local body is absent, run `make-docs resource read make-docs://system/contract/output-contract.md`.
|
|
7
|
+
- Governing invariant: `docs/prd/` describes the current authoritative shape of the product. It must never describe the editorial operation used to change that authority.
|
|
8
|
+
- For every candidate, choose `update-existing` when an owner exists, `create` only for a coherent ownerless capability, subsystem, or boundary, `link-only` when authority is sufficient but navigation needs a pointer, or `none` when no PRD change is warranted.
|
|
9
|
+
- Put current normative requirements inline. Preserve material prior contracts only in the owning PRD's standardized, non-normative `## Requirement History` section.
|
|
10
|
+
- Never use filenames, H1 titles, kinds, or document identities that describe additions, enhancements, revisions, removals, migrations, or reconciliation.
|
|
11
|
+
- PRDs do not use W/R/P as document identity; maintenance coordinates belong in source links and requirement-history entries.
|
|
6
12
|
- `03-open-questions-and-risk-register.md` is the living register for gap state, open questions, resolved decisions, confirmed drift, and rebuild risks.
|
|
7
13
|
- Update the register directly for newly discovered or resolved gaps; do not create separate questions, decisions, risks, gaps, or architecture-decision files unless the user explicitly asks.
|
|
8
|
-
- Before writing,
|
|
9
|
-
-
|
|
14
|
+
- Before writing, use valid local `.make-docs/system/references/execution-workflow.md`, `.make-docs/system/contracts/output-contract.md`, and `.make-docs/system/references/prd-change-management.md` bodies. When one is absent, run `make-docs resource read` with its exact `make-docs://system/reference/execution-workflow.md`, `make-docs://system/contract/output-contract.md`, or `make-docs://system/reference/prd-change-management.md` URI.
|
|
15
|
+
- For a new or materially updated governed PRD, also read `.make-docs/system/contracts/human-experience-contract.md`, `.make-docs/system/references/human-experience.md`, and `.make-docs/system/references/lifecycle.md`. When a valid local body is absent, use its matching `make-docs://system/contract/human-experience-contract.md`, `make-docs://system/reference/human-experience.md`, or `make-docs://system/reference/lifecycle.md` URI.
|
|
16
|
+
- When a performance candidate exists, use the `performance-evidence` catalog workflow. Load `.make-docs/system/contracts/performance-evidence-governance.md`, or read `make-docs://system/contract/performance-evidence-governance.md` when the local body is absent. Under the same condition, load `.make-docs/system/prompts/performance-coverage.prompt.md` and `.make-docs/system/templates/performance-evidence-profile.md`, or read `make-docs://system/prompt/performance-coverage.prompt.md` and `make-docs://system/template/performance-evidence-profile.md` when a local body is absent. Do not load the prompt or template otherwise.
|
|
17
|
+
- Use the matching local template: `.make-docs/system/templates/prd-index.md`, `.make-docs/system/templates/prd-overview.md`, `.make-docs/system/templates/prd-architecture.md`, `.make-docs/system/templates/prd-subsystem.md`, `.make-docs/system/templates/prd-reference.md`, `.make-docs/system/templates/prd-glossary.md`, or `.make-docs/system/templates/prd-risk-register.md`. When it is absent, run `make-docs resource read` with its exact `make-docs://system/template/prd-index.md`, `make-docs://system/template/prd-overview.md`, `make-docs://system/template/prd-architecture.md`, `make-docs://system/template/prd-subsystem.md`, `make-docs://system/template/prd-reference.md`, `make-docs://system/template/prd-glossary.md`, or `make-docs://system/template/prd-risk-register.md` URI.
|
|
18
|
+
- Treat the reference docs as the authority for namespace lifecycle, ownership, numbering, requirement history, and validation; `make-docs run prd authority validate --target-root <project>` must exit zero before downstream work consumes the set, and invalid or escaping docs roots are blocking validation failures.
|
|
19
|
+
<!-- make-docs:end -->
|
|
@@ -1,9 +1,19 @@
|
|
|
1
|
+
<!-- make-docs:begin -->
|
|
1
2
|
# PRD Router
|
|
2
3
|
|
|
3
|
-
This directory is
|
|
4
|
+
This directory is the active product-authority namespace.
|
|
4
5
|
|
|
5
|
-
- Files use `NN-<slug>.md`; fixed-core filenames and lifecycle rules live in
|
|
6
|
+
- Files use `NN-<slug>.md`; fixed-core filenames and lifecycle rules live in `.make-docs/system/contracts/output-contract.md`. When that local body is absent, run `make-docs resource read make-docs://system/contract/output-contract.md`.
|
|
7
|
+
- Governing invariant: `docs/prd/` describes the current authoritative shape of the product. It must never describe the editorial operation used to change that authority.
|
|
8
|
+
- For every candidate, choose `update-existing` when an owner exists, `create` only for a coherent ownerless capability, subsystem, or boundary, `link-only` when authority is sufficient but navigation needs a pointer, or `none` when no PRD change is warranted.
|
|
9
|
+
- Put current normative requirements inline. Preserve material prior contracts only in the owning PRD's standardized, non-normative `## Requirement History` section.
|
|
10
|
+
- Never use filenames, H1 titles, kinds, or document identities that describe additions, enhancements, revisions, removals, migrations, or reconciliation.
|
|
11
|
+
- PRDs do not use W/R/P as document identity; maintenance coordinates belong in source links and requirement-history entries.
|
|
6
12
|
- `03-open-questions-and-risk-register.md` is the living register for gap state, open questions, resolved decisions, confirmed drift, and rebuild risks.
|
|
7
13
|
- Update the register directly for newly discovered or resolved gaps; do not create separate questions, decisions, risks, gaps, or architecture-decision files unless the user explicitly asks.
|
|
8
|
-
- Before writing,
|
|
9
|
-
-
|
|
14
|
+
- Before writing, use valid local `.make-docs/system/references/execution-workflow.md`, `.make-docs/system/contracts/output-contract.md`, and `.make-docs/system/references/prd-change-management.md` bodies. When one is absent, run `make-docs resource read` with its exact `make-docs://system/reference/execution-workflow.md`, `make-docs://system/contract/output-contract.md`, or `make-docs://system/reference/prd-change-management.md` URI.
|
|
15
|
+
- For a new or materially updated governed PRD, also read `.make-docs/system/contracts/human-experience-contract.md`, `.make-docs/system/references/human-experience.md`, and `.make-docs/system/references/lifecycle.md`. When a valid local body is absent, use its matching `make-docs://system/contract/human-experience-contract.md`, `make-docs://system/reference/human-experience.md`, or `make-docs://system/reference/lifecycle.md` URI.
|
|
16
|
+
- When a performance candidate exists, use the `performance-evidence` catalog workflow. Load `.make-docs/system/contracts/performance-evidence-governance.md`, or read `make-docs://system/contract/performance-evidence-governance.md` when the local body is absent. Under the same condition, load `.make-docs/system/prompts/performance-coverage.prompt.md` and `.make-docs/system/templates/performance-evidence-profile.md`, or read `make-docs://system/prompt/performance-coverage.prompt.md` and `make-docs://system/template/performance-evidence-profile.md` when a local body is absent. Do not load the prompt or template otherwise.
|
|
17
|
+
- Use the matching local template: `.make-docs/system/templates/prd-index.md`, `.make-docs/system/templates/prd-overview.md`, `.make-docs/system/templates/prd-architecture.md`, `.make-docs/system/templates/prd-subsystem.md`, `.make-docs/system/templates/prd-reference.md`, `.make-docs/system/templates/prd-glossary.md`, or `.make-docs/system/templates/prd-risk-register.md`. When it is absent, run `make-docs resource read` with its exact `make-docs://system/template/prd-index.md`, `make-docs://system/template/prd-overview.md`, `make-docs://system/template/prd-architecture.md`, `make-docs://system/template/prd-subsystem.md`, `make-docs://system/template/prd-reference.md`, `make-docs://system/template/prd-glossary.md`, or `make-docs://system/template/prd-risk-register.md` URI.
|
|
18
|
+
- Treat the reference docs as the authority for namespace lifecycle, ownership, numbering, requirement history, and validation; `make-docs run prd authority validate --target-root <project>` must exit zero before downstream work consumes the set, and invalid or escaping docs roots are blocking validation failures.
|
|
19
|
+
<!-- make-docs:end -->
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
<!-- make-docs:begin -->
|
|
1
2
|
# Work Directory
|
|
2
3
|
|
|
3
4
|
Output target for implementation backlogs. In v2, every backlog is a **directory** containing an index plus one or more phase files.
|
|
@@ -7,12 +8,18 @@ Output target for implementation backlogs. In v2, every backlog is a **directory
|
|
|
7
8
|
- Directory: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
8
9
|
- Inside: `00-index.md` (entry point) + `0N-<phase>.md` (one per phase)
|
|
9
10
|
- Example: `docs/work/2026-04-15-w1-r0-payments-rollout/` containing `00-index.md`, `01-foundation.md`, `02-rollout.md`
|
|
10
|
-
-
|
|
11
|
+
- Use a valid local `.make-docs/system/references/wave-model.md` body for W/R semantics. When it is absent, run `make-docs resource read make-docs://system/reference/wave-model.md`.
|
|
11
12
|
|
|
12
13
|
## Agent Instructions
|
|
13
14
|
|
|
14
|
-
- Before writing,
|
|
15
|
+
- Before writing, use a valid local `.make-docs/system/references/execution-workflow.md` body or, when it is absent, run `make-docs resource read make-docs://system/reference/execution-workflow.md`.
|
|
16
|
+
- For a new or materially updated governed backlog, also read `.make-docs/system/contracts/human-experience-contract.md`, `.make-docs/system/references/human-experience.md`, and `.make-docs/system/references/lifecycle.md`. When a valid local body is absent, use its matching `make-docs://system/contract/human-experience-contract.md`, `make-docs://system/reference/human-experience.md`, or `make-docs://system/reference/lifecycle.md` URI.
|
|
17
|
+
- When a performance candidate exists, use the `performance-evidence` catalog workflow. Load `.make-docs/system/contracts/performance-evidence-governance.md`, or read `make-docs://system/contract/performance-evidence-governance.md` when the local body is absent. Under the same condition, load `.make-docs/system/prompts/performance-coverage.prompt.md` and `.make-docs/system/templates/performance-evidence-profile.md`, or read `make-docs://system/prompt/performance-coverage.prompt.md` and `make-docs://system/template/performance-evidence-profile.md` when a local body is absent. Do not load the prompt or template otherwise.
|
|
18
|
+
- For `00-index.md`, use `.make-docs/system/templates/work-index.md` or run `make-docs resource read make-docs://system/template/work-index.md` when the local body is absent. For phase files, use `.make-docs/system/templates/work-phase.md` or run `make-docs resource read make-docs://system/template/work-phase.md` when the local body is absent.
|
|
19
|
+
- Use the current repository's accepted design, plan, PRD, and work contracts as backlog authority before consulting archived examples or installed skill projections.
|
|
20
|
+
- Treat bundled skill assets, generated harness stubs, and archived backlogs as fallback/reference material only; they are not independent backlog-shape authority when live repo contracts are available.
|
|
15
21
|
- In phase files, preserve markdown task syntax in `### Tasks` (`- [ ] t1: ...`) and keep `### Acceptance criteria` as plain bullets.
|
|
16
22
|
- Always create work as a directory; never a flat `.md` file.
|
|
17
23
|
- Apply the date-W/R-slug naming; do not backdate.
|
|
18
|
-
- Archived backlogs live in
|
|
24
|
+
- Archived backlogs live in `.make-docs/archive/work/`. Before first use, run `make-docs project surface ensure archive`. **Never archive unless explicitly asked.**
|
|
25
|
+
<!-- make-docs:end -->
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
<!-- make-docs:begin -->
|
|
1
2
|
# Work Directory
|
|
2
3
|
|
|
3
4
|
Output target for implementation backlogs. In v2, every backlog is a **directory** containing an index plus one or more phase files.
|
|
@@ -7,12 +8,18 @@ Output target for implementation backlogs. In v2, every backlog is a **directory
|
|
|
7
8
|
- Directory: `YYYY-MM-DD-w{W}-r{R}-<slug>/`
|
|
8
9
|
- Inside: `00-index.md` (entry point) + `0N-<phase>.md` (one per phase)
|
|
9
10
|
- Example: `docs/work/2026-04-15-w1-r0-payments-rollout/` containing `00-index.md`, `01-foundation.md`, `02-rollout.md`
|
|
10
|
-
-
|
|
11
|
+
- Use a valid local `.make-docs/system/references/wave-model.md` body for W/R semantics. When it is absent, run `make-docs resource read make-docs://system/reference/wave-model.md`.
|
|
11
12
|
|
|
12
13
|
## Agent Instructions
|
|
13
14
|
|
|
14
|
-
- Before writing,
|
|
15
|
+
- Before writing, use a valid local `.make-docs/system/references/execution-workflow.md` body or, when it is absent, run `make-docs resource read make-docs://system/reference/execution-workflow.md`.
|
|
16
|
+
- For a new or materially updated governed backlog, also read `.make-docs/system/contracts/human-experience-contract.md`, `.make-docs/system/references/human-experience.md`, and `.make-docs/system/references/lifecycle.md`. When a valid local body is absent, use its matching `make-docs://system/contract/human-experience-contract.md`, `make-docs://system/reference/human-experience.md`, or `make-docs://system/reference/lifecycle.md` URI.
|
|
17
|
+
- When a performance candidate exists, use the `performance-evidence` catalog workflow. Load `.make-docs/system/contracts/performance-evidence-governance.md`, or read `make-docs://system/contract/performance-evidence-governance.md` when the local body is absent. Under the same condition, load `.make-docs/system/prompts/performance-coverage.prompt.md` and `.make-docs/system/templates/performance-evidence-profile.md`, or read `make-docs://system/prompt/performance-coverage.prompt.md` and `make-docs://system/template/performance-evidence-profile.md` when a local body is absent. Do not load the prompt or template otherwise.
|
|
18
|
+
- For `00-index.md`, use `.make-docs/system/templates/work-index.md` or run `make-docs resource read make-docs://system/template/work-index.md` when the local body is absent. For phase files, use `.make-docs/system/templates/work-phase.md` or run `make-docs resource read make-docs://system/template/work-phase.md` when the local body is absent.
|
|
19
|
+
- Use the current repository's accepted design, plan, PRD, and work contracts as backlog authority before consulting archived examples or installed skill projections.
|
|
20
|
+
- Treat bundled skill assets, generated harness stubs, and archived backlogs as fallback/reference material only; they are not independent backlog-shape authority when live repo contracts are available.
|
|
15
21
|
- In phase files, preserve markdown task syntax in `### Tasks` (`- [ ] t1: ...`) and keep `### Acceptance criteria` as plain bullets.
|
|
16
22
|
- Always create work as a directory; never a flat `.md` file.
|
|
17
23
|
- Apply the date-W/R-slug naming; do not backdate.
|
|
18
|
-
- Archived backlogs live in
|
|
24
|
+
- Archived backlogs live in `.make-docs/archive/work/`. Before first use, run `make-docs project surface ensure archive`. **Never archive unless explicitly asked.**
|
|
25
|
+
<!-- make-docs:end -->
|