@brucewaynedecoy/make-docs 1.0.0-rc.1 → 2.0.3
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 +31 -67
- package/dist/backup-GCM64IPN.js +20 -0
- package/dist/backup-GCM64IPN.js.map +1 -0
- package/dist/chunk-2HNJCJJE.js +1291 -0
- package/dist/chunk-2HNJCJJE.js.map +1 -0
- package/dist/chunk-4LLSMDWJ.js +24674 -0
- package/dist/chunk-4LLSMDWJ.js.map +1 -0
- package/dist/chunk-57GN6ALR.js +204 -0
- package/dist/chunk-57GN6ALR.js.map +1 -0
- package/dist/chunk-C2IBRVUA.js +4136 -0
- package/dist/chunk-C2IBRVUA.js.map +1 -0
- package/dist/chunk-D4HDZEJT.js +37 -0
- package/dist/chunk-D4HDZEJT.js.map +1 -0
- package/dist/chunk-DFQJENNL.js +2340 -0
- package/dist/chunk-DFQJENNL.js.map +1 -0
- package/dist/chunk-DNDM7DUQ.js +39 -0
- package/dist/chunk-DNDM7DUQ.js.map +1 -0
- package/dist/chunk-GPVKIBFC.js +875 -0
- package/dist/chunk-GPVKIBFC.js.map +1 -0
- package/dist/chunk-IHMZ2OCS.js +1575 -0
- package/dist/chunk-IHMZ2OCS.js.map +1 -0
- package/dist/chunk-O2UZ35PV.js +523 -0
- package/dist/chunk-O2UZ35PV.js.map +1 -0
- package/dist/chunk-U25GFKNZ.js +13995 -0
- package/dist/chunk-U25GFKNZ.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-UHPM4A2U.js +653 -0
- package/dist/self-UHPM4A2U.js.map +1 -0
- package/dist/server-N7XAAV3X.js +512 -0
- package/dist/server-N7XAAV3X.js.map +1 -0
- package/dist/setup-system-JUHGDZJW.js +544 -0
- package/dist/setup-system-JUHGDZJW.js.map +1 -0
- package/dist/{skills-command-3ESCZ75U.js → skills-command-W3SE3OFP.js} +190 -32
- package/dist/skills-command-W3SE3OFP.js.map +1 -0
- package/dist/uninstall-BGMJ6KCI.js +223 -0
- package/dist/uninstall-BGMJ6KCI.js.map +1 -0
- package/dist/virtual_make-docs-first-party-skills-VXSUUHTL.js +11 -0
- package/dist/virtual_make-docs-first-party-skills-VXSUUHTL.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,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "{{TITLE}}"
|
|
3
|
+
kind: "design"
|
|
4
|
+
status: "draft"
|
|
5
|
+
follow_on:
|
|
6
|
+
route: "{{FOLLOW_ON_ROUTE}}"
|
|
7
|
+
next_prompt: "make-docs://system/prompt/{{PROMPT_FILE}}"
|
|
8
|
+
why: "{{FOLLOW_ON_WHY}}"
|
|
9
|
+
coordinate_handoff: "{{COORDINATE_HANDOFF}}"
|
|
10
|
+
# coordinate: "W{{W}} R{{R}}"
|
|
11
|
+
# source:
|
|
12
|
+
# type: "manual-request"
|
|
13
|
+
# path: "{{SOURCE_PATH}}"
|
|
14
|
+
# lifecycle:
|
|
15
|
+
# default_arc: "design -> plan -> PRD -> work -> implementation"
|
|
16
|
+
# departure: "source-to-design-straddle"
|
|
17
|
+
# reason: "{{LIFECYCLE_REASON}}"
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# {{TITLE}}
|
|
21
|
+
|
|
22
|
+
> Filename: `YYYY-MM-DD-<slug>.md`. See `.make-docs/system/contracts/design-contract.md` for naming and structural rules.
|
|
23
|
+
|
|
24
|
+
## Purpose
|
|
25
|
+
|
|
26
|
+
Explain what decision this document captures and why it exists.
|
|
27
|
+
|
|
28
|
+
## Context
|
|
29
|
+
|
|
30
|
+
Describe the problem, constraints, forces, and existing conditions that shape the decision.
|
|
31
|
+
|
|
32
|
+
## Human Experience Intent
|
|
33
|
+
|
|
34
|
+
<!-- Follow make-docs://system/contract/human-experience-contract.md. Choose direct or indirect for the full form below. For none, REPLACE these fields with Impact, Reason, Preserved experience, and Evidence required from the contract. Keep one section. Remove these instructions and resolve all placeholders. -->
|
|
35
|
+
|
|
36
|
+
Impact: `{{IMPACT}}`
|
|
37
|
+
|
|
38
|
+
Affected humans: {{AFFECTED_HUMANS}}
|
|
39
|
+
|
|
40
|
+
Human goal or effect: {{HUMAN_GOAL_OR_EFFECT}}
|
|
41
|
+
|
|
42
|
+
Experience promises:
|
|
43
|
+
|
|
44
|
+
- {{OBSERVABLE_EXPERIENCE_PROMISE}}
|
|
45
|
+
|
|
46
|
+
Complexity kept out of the human path:
|
|
47
|
+
|
|
48
|
+
- {{COMPLEXITY_NOT_REQUIRED_FOR_THE_GOAL}}
|
|
49
|
+
|
|
50
|
+
Evidence required:
|
|
51
|
+
|
|
52
|
+
- {{PLANNED_EVIDENCE}}
|
|
53
|
+
|
|
54
|
+
## Performance Evidence Candidates
|
|
55
|
+
|
|
56
|
+
When the design contains a performance candidate, read `make-docs://system/contract/performance-evidence-governance.md` with `make-docs resource read`. Keep this inventory short and do not invent a target.
|
|
57
|
+
|
|
58
|
+
| Candidate | Base maintenance action | Performance applicability | Protected outcome | Decision informed | Canonical owner or next record |
|
|
59
|
+
| --- | --- | --- | --- | --- | --- |
|
|
60
|
+
| {{PERFORMANCE_CANDIDATE_OR_NONE}} | `{{BASE_MAINTENANCE_ACTION}}` | `{{REQUIRED_NOW_CHARACTERIZE_NOW_DEFER_REQUIRED_NOT_NEEDED_OR_REJECT_UNSUPPORTED}}` | {{PROTECTED_OUTCOME_OR_NONE}} | {{DECISION_INFORMED_OR_NONE}} | {{OWNER_PERF_O_OR_NONE}} |
|
|
61
|
+
|
|
62
|
+
## Decision
|
|
63
|
+
|
|
64
|
+
Describe the chosen approach clearly enough that planning can proceed from it.
|
|
65
|
+
|
|
66
|
+
## Alternatives Considered
|
|
67
|
+
|
|
68
|
+
List the meaningful alternatives and why they were not chosen.
|
|
69
|
+
|
|
70
|
+
## Consequences
|
|
71
|
+
|
|
72
|
+
Describe outcomes, trade-offs, risks, and follow-on implications.
|
|
73
|
+
|
|
74
|
+
## Intended Follow-On
|
|
75
|
+
|
|
76
|
+
- Route: `baseline-plan` or `change-plan`
|
|
77
|
+
- Next Prompt: {{NEXT_PROMPT_LINK}}. Read `make-docs://system/prompt/{{PROMPT_FILE}}` with `make-docs resource read`.
|
|
78
|
+
- Why: Explain why this design should flow into that planning path.
|
|
79
|
+
- Coordinate Handoff: For `change-plan`, identify the related completed coordinate and recommended downstream W/R coordinate when known; otherwise state `unresolved; planner must resolve before writing.`
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "{{TITLE}}"
|
|
3
|
+
kind: "guide"
|
|
4
|
+
status: "draft"
|
|
3
5
|
path: "{{PATH}}"
|
|
4
|
-
|
|
6
|
+
persona: "maintainer"
|
|
5
7
|
# version: ""
|
|
6
8
|
# order: 100
|
|
7
9
|
# tags: []
|
|
@@ -11,7 +13,9 @@ status: draft
|
|
|
11
13
|
|
|
12
14
|
# {{TITLE}}
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
<!-- Select an effective Persona with the `maintainer` primitive from the built-in defaults plus valid project config. Set `persona` to that slug and write under `docs/assets/<persona-slug>/`. The built-in default is `maintainer`. Either role can be human or agent; do not infer the audience from the author. -->
|
|
17
|
+
|
|
18
|
+
> See `.make-docs/system/contracts/guide-contract.md` for frontmatter schema, slug rules, audience rules, coverage decisions, and future coverage handling.
|
|
15
19
|
|
|
16
20
|
## Overview
|
|
17
21
|
|
|
@@ -25,7 +29,7 @@ Where the relevant code, docs, generated files, contracts, and source-of-truth a
|
|
|
25
29
|
|
|
26
30
|
Tools, access, local setup, or project knowledge required before starting.
|
|
27
31
|
|
|
28
|
-
##
|
|
32
|
+
## Maintenance Workflow
|
|
29
33
|
|
|
30
34
|
How to change, extend, maintain, validate, or troubleshoot this capability.
|
|
31
35
|
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "{{TITLE}}"
|
|
3
|
+
kind: "guide"
|
|
4
|
+
status: "draft"
|
|
3
5
|
path: "{{PATH}}"
|
|
4
|
-
|
|
6
|
+
persona: "user"
|
|
5
7
|
# version: ""
|
|
6
8
|
# order: 100
|
|
7
9
|
# tags: []
|
|
@@ -11,7 +13,9 @@ status: draft
|
|
|
11
13
|
|
|
12
14
|
# {{TITLE}}
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
<!-- Select an effective Persona with the `user` primitive from the built-in defaults plus valid project config. Set `persona` to that slug and write under `docs/assets/<persona-slug>/`. The built-in default is `user`. Either role can be human or agent; do not infer the audience from the author. -->
|
|
17
|
+
|
|
18
|
+
> See `.make-docs/system/contracts/guide-contract.md` for frontmatter schema, slug rules, audience rules, coverage decisions, and future coverage handling.
|
|
15
19
|
|
|
16
20
|
## Overview
|
|
17
21
|
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
+
title: "{{TITLE}}"
|
|
3
|
+
kind: "history"
|
|
4
|
+
status: "completed"
|
|
2
5
|
date: "{{YYYY-MM-DD}}"
|
|
3
6
|
client: "{{CLIENT}}"
|
|
4
7
|
model: "{{MODEL}}"
|
|
@@ -6,19 +9,19 @@ coordinate: "{{COORDINATE}}"
|
|
|
6
9
|
# provider: "{{PROVIDER}}"
|
|
7
10
|
# repo: "{{REPO}}"
|
|
8
11
|
# branch: "{{BRANCH}}"
|
|
9
|
-
# status: "{{STATUS}}"
|
|
10
12
|
# summary: "{{ONE_LINE_SUMMARY}}"
|
|
11
13
|
---
|
|
12
14
|
|
|
13
15
|
<!-- Remove unknown frontmatter keys instead of leaving placeholders or inventing values. -->
|
|
14
16
|
|
|
15
|
-
<!-- Filename: docs/
|
|
17
|
+
<!-- Filename: .make-docs/archive/history/YYYY-MM-DD-w{W}-r{R}-p{P}-<slug>.md when W/R/P is known. If only W/R is known, omit p{P}; if no coordinate is known, use YYYY-MM-DD-<slug>.md. Keep stage/task details only in coordinate frontmatter. -->
|
|
16
18
|
|
|
17
19
|
# {{TITLE}}
|
|
18
20
|
|
|
19
21
|
## Changes
|
|
20
22
|
|
|
21
23
|
Summarize what was touched this session. Use prose, a short file tree, a table, or optional sub-sections — whichever best fits the work.
|
|
24
|
+
When deferred obligations or Unassisted Goal Testing changed materially, add one concise delta. Name an affected `O-###` or `NUAT-###` when one exists. Record `not-needed-now` without inventing an ID. Include the orphan-audit outcome when relevant and link the resulting scenario or finding disposition to authority.
|
|
22
25
|
|
|
23
26
|
```text
|
|
24
27
|
{{REPO_ROOT}}/
|
|
@@ -41,7 +44,7 @@ Project-level docs: READMEs, agent instructions, designs, plans, work backlogs,
|
|
|
41
44
|
|
|
42
45
|
If none, state "None this session."
|
|
43
46
|
|
|
44
|
-
###
|
|
47
|
+
### Maintainer
|
|
45
48
|
|
|
46
49
|
Docs intended for engineers, maintainers, or internal contributors.
|
|
47
50
|
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
<!-- Stable template for an Unassisted Goal Testing decision and any activated NUAT scenario. Keep the filename for compatibility. -->
|
|
2
|
+
|
|
3
|
+
## Testing Decision
|
|
4
|
+
|
|
5
|
+
| Field | Value |
|
|
6
|
+
| --- | --- |
|
|
7
|
+
| Testing Type | Unassisted Goal Testing |
|
|
8
|
+
| Decision Informed | {{CURRENT_PRODUCT_RELEASE_OR_HUMAN_EXPERIENCE_DECISION}} |
|
|
9
|
+
| Reason Now | {{ACTIVATION_OR_NOT_NEEDED_NOW_REASON}} |
|
|
10
|
+
| Product Maturity | {{RELEVANT_PRODUCT_STATE}} |
|
|
11
|
+
| Scope | {{PRODUCT_PLATFORM_AUDIENCE_AND_SUPPORT_SCOPE}} |
|
|
12
|
+
| Executor | {{QUALIFIED_EXECUTOR_OR_NONE}} |
|
|
13
|
+
| Gate Effect | {{ADVISORY_OR_EXPLICIT_BLOCKING_EFFECT}} |
|
|
14
|
+
| Effort Budget | {{FINITE_RUN_AND_CORRECTION_LIMIT}} |
|
|
15
|
+
| Stop Condition | {{FINITE_STOP_RULE}} |
|
|
16
|
+
| Evidence Retained | {{EVIDENCE_NEEDED_FOR_THE_DECISION}} |
|
|
17
|
+
| Rerun Trigger | {{MATERIAL_CHANGE_OR_EXPLICIT_AUTHORITY}} |
|
|
18
|
+
| Result | {{NOT_NEEDED_NOW_OR_RUN_RESULT}} |
|
|
19
|
+
|
|
20
|
+
Use `not-needed-now` without a scenario when no current decision justifies a run. Record the reason and applicable evidence. Do not create an obligation unless an accepted future outcome remains owed.
|
|
21
|
+
|
|
22
|
+
### NUAT-### {{TITLE}}
|
|
23
|
+
|
|
24
|
+
#### Operator View
|
|
25
|
+
|
|
26
|
+
| Field | Value |
|
|
27
|
+
| --- | --- |
|
|
28
|
+
| Scenario ID | `NUAT-###` |
|
|
29
|
+
| Scenario Version | `{{SCENARIO_VERSION}}` |
|
|
30
|
+
| Title | {{TITLE}} |
|
|
31
|
+
| User Goal | {{REAL_WORLD_GOAL}} |
|
|
32
|
+
| Source Requirements | {{PRD_LINKS_AND_ANCHORS}} |
|
|
33
|
+
| Target User | {{INTENDED_AUDIENCE}} |
|
|
34
|
+
| Current Uncertainty | {{MATERIAL_CURRENT_QUESTION}} |
|
|
35
|
+
| Selected Persona | {{ELIGIBLE_PERSONA_OR_DEFAULT_USER}} |
|
|
36
|
+
| Supported Scope | {{PLATFORM_LOCALE_INPUT_ACCESSIBILITY_ACCOUNT_NETWORK_SCOPE}} |
|
|
37
|
+
| Product Build And Environment | {{REPRODUCIBLE_NORMALLY_CONSUMABLE_PRODUCT_IDENTITY}} |
|
|
38
|
+
| Starting State | {{VISIBLE_ACCOUNT_CONTENT_PERMISSIONS_ENVIRONMENT}} |
|
|
39
|
+
| Public Resources | {{ALLOWED_PUBLIC_OR_REALISTIC_RESOURCES}} |
|
|
40
|
+
| Prohibited Context | {{PRIVATE_CONTEXT_AND_HIDDEN_ROUTE_GUIDANCE}} |
|
|
41
|
+
| Tester Prompt | {{GOAL_ORIENTED_TESTER_PACKET_SUMMARY}} |
|
|
42
|
+
| Operator Success Outcomes | {{OPERATOR_ONLY_EVALUATION_CONDITIONS}} |
|
|
43
|
+
| Setup | {{ISOLATION_QUALIFICATION_CONSENT_CAPTURE_READINESS}} |
|
|
44
|
+
| Teardown | {{CLEANUP_REDACTION_RESTORATION}} |
|
|
45
|
+
| Evidence Requirements | {{EVIDENCE_NEEDED_FOR_THE_CURRENT_DECISION}} |
|
|
46
|
+
| Severity Rules | {{BASE_OR_PROJECT_SPECIFIC_RULE}} |
|
|
47
|
+
| Finding Route | {{OWNING_PRD_WORK_AND_GATE_ROUTE}} |
|
|
48
|
+
|
|
49
|
+
#### Tester Packet
|
|
50
|
+
|
|
51
|
+
> This packet is visible to the executor. Do not leak operator-only setup, requirement IDs, hidden steps, expected answers, or success criteria.
|
|
52
|
+
|
|
53
|
+
- Situation: {{REALISTIC_SITUATION}}
|
|
54
|
+
- Goal: {{TESTER_VISIBLE_GOAL}}
|
|
55
|
+
- Visible starting state: {{VISIBLE_STARTING_STATE_ONLY}}
|
|
56
|
+
- Allowed public resources: {{PUBLIC_OR_REALISTIC_HELP_ONLY}}
|
|
57
|
+
- Genuine constraints and safety notes: {{PUBLICLY_SHAREABLE_CONSTRAINTS}}
|
|
58
|
+
- Consent and capture notice: {{TESTER_VISIBLE_CONSENT_NOTICE}}
|
|
59
|
+
- Tester-owned teardown steps: {{TESTER_OWNED_CLEANUP_ONLY}}
|
|
60
|
+
|
|
61
|
+
#### Run Record Checklist
|
|
62
|
+
|
|
63
|
+
- `run_id`
|
|
64
|
+
- `scenario_ref` with ID, version, and source digest
|
|
65
|
+
- `selected_persona` / `persona_primitive` / `persona_resolution`
|
|
66
|
+
- `executor_qualification` / `isolation_evidence`
|
|
67
|
+
- `evidence_root`
|
|
68
|
+
- `work_coordinate`
|
|
69
|
+
- `product_build` / `environment` / `support_scope`
|
|
70
|
+
- `public_resources_used`
|
|
71
|
+
- `interventions`
|
|
72
|
+
- `result`
|
|
73
|
+
- `observations`
|
|
74
|
+
- `interaction_evidence` / `visual_evidence` / `accessibility_evidence`
|
|
75
|
+
- `finding_ids`
|
|
76
|
+
- `reproduction`
|
|
77
|
+
- `evidence_refs`
|
|
78
|
+
- `review`
|
|
79
|
+
|
|
80
|
+
#### Finding Expectations
|
|
81
|
+
|
|
82
|
+
Record observed behavior, expected human outcome, severity, reproducibility, support scope, evidence, source requirement or promise, owner, and disposition.
|
|
83
|
+
|
|
84
|
+
#### Notes
|
|
85
|
+
|
|
86
|
+
- Keep this scenario in the owning PRD. Do not create a second canonical copy in work or history.
|
|
87
|
+
- Increment `scenario_version` for a material change to the same goal.
|
|
88
|
+
- Use a new `NUAT-###` only for a materially different goal, audience, support claim, or risk.
|
|
89
|
+
- Keep Persona-specific packets, runs, findings, and approved evidence under `docs/assets/<persona-slug>/testing/`.
|
|
90
|
+
- Do not store Unassisted Goal Testing evidence under `.make-docs/archive/` or `docs/assets/project/`.
|
|
91
|
+
- Keep the stable filename and `NUAT-###` identity for compatibility.
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
<!-- Copy this progressive shape into the one record that owns the candidate. Do not keep a second live profile copy. -->
|
|
2
|
+
|
|
3
|
+
## Performance Applicability
|
|
4
|
+
|
|
5
|
+
| Field | Value |
|
|
6
|
+
| --- | --- |
|
|
7
|
+
| Candidate ID | `{{STABLE_LOCAL_CANDIDATE_ID}}` |
|
|
8
|
+
| Title | {{PRODUCT_LANGUAGE_TITLE}} |
|
|
9
|
+
| Testing Type | Performance Testing |
|
|
10
|
+
| Base Maintenance Action | `{{CREATE_UPDATE_EXISTING_LINK_ONLY_OR_NONE}}` |
|
|
11
|
+
| Protected Outcome | {{USER_OR_BUSINESS_OUTCOME}} |
|
|
12
|
+
| Decision Informed | {{CURRENT_DECISION_THIS_EVIDENCE_CAN_CHANGE}} |
|
|
13
|
+
| Failure Cost | {{CONSEQUENCE_AND_SEVERITY_BASIS}} |
|
|
14
|
+
| Risk And Reversibility | {{BLAST_RADIUS_REVERSIBILITY_FALSE_PASS_AND_FALSE_FAIL_COST}} |
|
|
15
|
+
| Supported Scope | {{EXACT_CLAIMED_SURFACE_AND_BOUNDARY}} |
|
|
16
|
+
| Product Maturity | {{CURRENT_MATURITY_POSTURE}} |
|
|
17
|
+
| Source Authority | {{RELATIVE_LINKS_TO_ACCEPTED_AUTHORITY_OR_NONE}} |
|
|
18
|
+
| Source Evidence | {{RELATIVE_LINKS_TO_RELEVANT_EVIDENCE_OR_NONE}} |
|
|
19
|
+
| Baseline Availability | {{COMPARABLE_BASELINE_REFERENCE_OR_NONE}} |
|
|
20
|
+
| Applicability | `{{REQUIRED_NOW_CHARACTERIZE_NOW_DEFER_REQUIRED_NOT_NEEDED_OR_REJECT_UNSUPPORTED}}` |
|
|
21
|
+
| Target Class | `{{TARGET_CLASS_OR_NONE}}` |
|
|
22
|
+
| Owner | {{DURABLE_DECISION_OWNER}} |
|
|
23
|
+
| Lifecycle Coordinate | {{CURRENT_OR_INTENDED_ACTIVATION_POINT}} |
|
|
24
|
+
| Gate Effect | {{ADVISORY_INFORMATIONAL_OR_EXPLICIT_BLOCKING_SCOPE}} |
|
|
25
|
+
| Reason | {{DECISION_RELEVANT_JUSTIFICATION}} |
|
|
26
|
+
| Next Record | {{PERF_O_OR_NONE}} |
|
|
27
|
+
|
|
28
|
+
For `not-needed` or `reject-unsupported`, stop here.
|
|
29
|
+
|
|
30
|
+
For `defer-required`, link one accepted `O-###` in **Next Record** and stop here.
|
|
31
|
+
|
|
32
|
+
Continue only for `required-now` or `characterize-now`. Put the profile in the one canonical record selected by its target class.
|
|
33
|
+
|
|
34
|
+
### PERF-### {{PROFILE_TITLE}}
|
|
35
|
+
|
|
36
|
+
#### Identity And Authority
|
|
37
|
+
|
|
38
|
+
| Field | Value |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| Profile ID | `PERF-###` |
|
|
41
|
+
| Profile Version | `{{MONOTONIC_VERSION}}` |
|
|
42
|
+
| Source Digest | `{{ALGORITHM_AND_DIGEST}}` |
|
|
43
|
+
| Title | {{PRODUCT_LANGUAGE_TITLE}} |
|
|
44
|
+
| Protected Outcome | {{USER_OR_BUSINESS_OUTCOME}} |
|
|
45
|
+
| Source Requirements | {{RELATIVE_OWNING_AUTHORITY_LINKS}} |
|
|
46
|
+
| Canonical Owner | {{ONE_PRD_PLAN_OR_WORK_LOCATION}} |
|
|
47
|
+
| Product Maturity | {{CURRENT_MATURITY_POSTURE}} |
|
|
48
|
+
| Applicability | `{{REQUIRED_NOW_OR_CHARACTERIZE_NOW}}` |
|
|
49
|
+
| Target Class | `{{EXECUTABLE_TARGET_CLASS}}` |
|
|
50
|
+
| Risk And Failure Cost | {{USER_IMPACT_SEVERITY_REVERSIBILITY_FALSE_PASS_AND_FALSE_FAIL_COST}} |
|
|
51
|
+
| Owner | {{DURABLE_AUTHORITY_ROLE}} |
|
|
52
|
+
| Approver | {{ACCEPTANCE_CHANGE_WAIVER_RETIREMENT_OR_SUPERSESSION_ROLE}} |
|
|
53
|
+
|
|
54
|
+
#### Supported Scope
|
|
55
|
+
|
|
56
|
+
| Field | Value |
|
|
57
|
+
| --- | --- |
|
|
58
|
+
| Surface | {{PRODUCT_SURFACE}} |
|
|
59
|
+
| Platform Or Runtime | {{SUPPORTED_PLATFORM_OR_RUNTIME_SCOPE}} |
|
|
60
|
+
| Deployment Or Device Class | {{SUPPORTED_DEPLOYMENT_OR_DEVICE_SCOPE}} |
|
|
61
|
+
| Scale | {{SUPPORTED_SCALE_BOUNDARY}} |
|
|
62
|
+
| Account And Network State | {{SUPPORTED_ACCOUNT_AND_NETWORK_BOUNDARY}} |
|
|
63
|
+
| Resource Envelope | {{SUPPORTED_RESOURCE_BOUNDARY}} |
|
|
64
|
+
| Exclusions | {{EXPLICIT_EXCLUSIONS_OR_NONE}} |
|
|
65
|
+
|
|
66
|
+
#### Baseline And Target
|
|
67
|
+
|
|
68
|
+
| Field | Value |
|
|
69
|
+
| --- | --- |
|
|
70
|
+
| Comparable Baseline | {{EVIDENCE_REFERENCE_OR_NONE}} |
|
|
71
|
+
| Target | {{EVIDENCE_BACKED_TARGET_OR_NONE}} |
|
|
72
|
+
| Unit | {{UNIT_OR_NONE}} |
|
|
73
|
+
| Direction | {{DIRECTION_OR_NONE}} |
|
|
74
|
+
| Tolerance | {{TOLERANCE_OR_NONE}} |
|
|
75
|
+
| Target Source | {{SOURCE_LINK_OR_NONE}} |
|
|
76
|
+
| Target Approval | {{APPROVAL_REFERENCE_OR_NONE}} |
|
|
77
|
+
|
|
78
|
+
#### Environment And Workload
|
|
79
|
+
|
|
80
|
+
| Field | Value |
|
|
81
|
+
| --- | --- |
|
|
82
|
+
| Product Build | {{BUILD_IDENTITY}} |
|
|
83
|
+
| Dependency State | {{RELEVANT_DEPENDENCY_IDENTITY}} |
|
|
84
|
+
| Configuration | {{RELEVANT_CONFIGURATION}} |
|
|
85
|
+
| Qualified Environment | {{ENVIRONMENT_OR_ENVIRONMENT_CLASS}} |
|
|
86
|
+
| Dataset Or Fixture | {{DATASET_SETUP_OR_FIXTURE_IDENTITY}} |
|
|
87
|
+
| Workload | {{WORKLOAD_DEFINITION}} |
|
|
88
|
+
| Scale | {{WORKLOAD_SCALE}} |
|
|
89
|
+
| Concurrency | {{CONCURRENCY_DEFINITION}} |
|
|
90
|
+
| Operation Mix | {{OPERATION_MIX}} |
|
|
91
|
+
| Workload Exclusions | {{EXCLUSIONS_OR_NONE}} |
|
|
92
|
+
|
|
93
|
+
#### Measurement Protocol
|
|
94
|
+
|
|
95
|
+
| Field | Value |
|
|
96
|
+
| --- | --- |
|
|
97
|
+
| Measurement Boundary | {{START_END_AND_INCLUDED_WORK}} |
|
|
98
|
+
| Instrument And Version | {{INSTRUMENT_IDENTITY}} |
|
|
99
|
+
| Cold Or Warm State | {{DECLARED_STATE}} |
|
|
100
|
+
| Warmup Rule | {{PREDECLARED_RULE}} |
|
|
101
|
+
| Repetitions Or Observation Window | {{PREDECLARED_APPROACH}} |
|
|
102
|
+
| Statistic | {{DECISION_FIT_STATISTIC}} |
|
|
103
|
+
| Variance Reporting | {{VARIANCE_METHOD}} |
|
|
104
|
+
| Uncertainty Reporting | {{UNCERTAINTY_METHOD}} |
|
|
105
|
+
| Outlier Treatment | {{PREDECLARED_RULE}} |
|
|
106
|
+
| Comparison Method | {{METHOD_AND_EQUIVALENCE_RULE_OR_NONE}} |
|
|
107
|
+
| Raw Evidence Retention | {{LOCATION_FORMAT_AND_RETENTION_RULE}} |
|
|
108
|
+
| Observer Effects | {{MATERIAL_EFFECTS_AND_CONTROLS_OR_NONE}} |
|
|
109
|
+
|
|
110
|
+
#### Non-Sacrificable Constraints
|
|
111
|
+
|
|
112
|
+
| Constraint | Required Condition And Evidence |
|
|
113
|
+
| --- | --- |
|
|
114
|
+
| Correctness | {{CONDITION_AND_EVIDENCE}} |
|
|
115
|
+
| Durability | {{CONDITION_AND_EVIDENCE}} |
|
|
116
|
+
| Safety | {{CONDITION_AND_EVIDENCE}} |
|
|
117
|
+
| Security | {{CONDITION_AND_EVIDENCE}} |
|
|
118
|
+
| Privacy | {{CONDITION_AND_EVIDENCE}} |
|
|
119
|
+
| Accessibility | {{CONDITION_AND_EVIDENCE}} |
|
|
120
|
+
| Portability | {{CONDITION_AND_EVIDENCE}} |
|
|
121
|
+
| Cost | {{CONDITION_AND_EVIDENCE}} |
|
|
122
|
+
| Maintainability | {{CONDITION_AND_EVIDENCE}} |
|
|
123
|
+
| Fixture And Measurement Seam | {{VALIDATION_EVIDENCE}} |
|
|
124
|
+
|
|
125
|
+
#### Evidence Budget And Stop Rules
|
|
126
|
+
|
|
127
|
+
| Field | Value |
|
|
128
|
+
| --- | --- |
|
|
129
|
+
| Authorizing Plan Or Work Scope | {{RELATIVE_LINK_AND_COORDINATE}} |
|
|
130
|
+
| Budget Event ID | {{STABLE_EVENT_ID}} |
|
|
131
|
+
| Characterization Pass Limit | {{FINITE_LIMIT}} |
|
|
132
|
+
| Materially Distinct Correction Attempt Limit | {{FINITE_LIMIT}} |
|
|
133
|
+
| Review Cycle Limit | {{FINITE_LIMIT}} |
|
|
134
|
+
| Elapsed Investigation Time Limit | {{FINITE_LIMIT}} |
|
|
135
|
+
| Compute Limit | {{FINITE_LIMIT}} |
|
|
136
|
+
| External Resource Spend Limit | {{FINITE_LIMIT}} |
|
|
137
|
+
| Unchanged Fingerprint Action | {{REUSE_OR_AUTHORIZED_REQUALIFICATION}} |
|
|
138
|
+
| Material Change Action | {{AFFECTED_CHECKS_ONLY_RULE}} |
|
|
139
|
+
| Diminishing Return Rule | {{DECISION_RELEVANT_STOP_RULE}} |
|
|
140
|
+
| Budget Exhaustion Disposition | {{BLOCKED_REVISE_SCOPED_FAIL_OR_OWNER_DECISION}} |
|
|
141
|
+
|
|
142
|
+
#### Outcome Rules
|
|
143
|
+
|
|
144
|
+
| Outcome | Exact Condition |
|
|
145
|
+
| --- | --- |
|
|
146
|
+
| `pass` | {{CONDITION_FOR_THIS_PROFILE_AND_SCOPE}} |
|
|
147
|
+
| `fail` | {{COMPARABLE_REPRODUCIBLE_MISS_OR_CONSTRAINT_CONDITION}} |
|
|
148
|
+
| `revise` | {{UNFIT_PROFILE_TARGET_PROTOCOL_OR_DECISION_CONDITION}} |
|
|
149
|
+
| `blocked` | {{MISSING_PRECONDITION_CONDITION}} |
|
|
150
|
+
| `waived` | {{BOUNDED_APPROVED_RISK_ACCEPTANCE_CONDITION}} |
|
|
151
|
+
|
|
152
|
+
| Field | Value |
|
|
153
|
+
| --- | --- |
|
|
154
|
+
| Severity Treatment | `{{CRITICAL_MAJOR_MODERATE_OR_MINOR_RULE}}` |
|
|
155
|
+
| Reproducibility Treatment | `{{REPRODUCED_NOT_REPRODUCED_INTERMITTENT_OR_NOT_ATTEMPTED_RULE}}` |
|
|
156
|
+
| Finding Route | {{OWNING_PRD_WORK_AND_GATE_ROUTE}} |
|
|
157
|
+
| Escalation Route | {{OWNER_AND_DECISION_ROUTE}} |
|
|
158
|
+
|
|
159
|
+
#### Expiry And Reevaluation
|
|
160
|
+
|
|
161
|
+
| Field | Value |
|
|
162
|
+
| --- | --- |
|
|
163
|
+
| Material Change Triggers | {{PROFILE_BUILD_ENVIRONMENT_WORKLOAD_SCOPE_DEPENDENCY_INSTRUMENT_OR_ANALYSIS_TRIGGERS}} |
|
|
164
|
+
| Time Or Release Boundary | {{DECLARED_BOUNDARY_OR_NONE}} |
|
|
165
|
+
| Current-Use Invalidation Rule | {{INVALIDATION_RULE}} |
|
|
166
|
+
| Next Review Condition | {{OWNER_REVIEW_TRIGGER}} |
|
|
167
|
+
| Requalification Authority | {{SEPARATE_OWNER_OR_PHASE_AUTHORITY_REQUIRED}} |
|
|
168
|
+
| Requalification Budget | {{NEW_FINITE_BUDGET_REQUIRED}} |
|
|
169
|
+
| Unchanged-Fingerprint Qualification Limit | {{SINGLE_BOUNDED_EXECUTION}} |
|
|
170
|
+
|
|
171
|
+
#### Lineage And Traceability
|
|
172
|
+
|
|
173
|
+
| Field | Value |
|
|
174
|
+
| --- | --- |
|
|
175
|
+
| Predecessor | {{PERF_REFERENCE_OR_NONE}} |
|
|
176
|
+
| Successor | {{PERF_REFERENCE_OR_NONE}} |
|
|
177
|
+
| Promotion Source | {{NON_PRODUCT_PROFILE_REFERENCE_OR_NONE}} |
|
|
178
|
+
| Promotion Approval | {{PRD_OWNER_APPROVAL_REFERENCE_OR_NONE}} |
|
|
179
|
+
| Supersession Reason | {{RATIONALE_OR_NONE}} |
|
|
180
|
+
| Plan And Work Links | {{RELATIVE_LINKS_OR_NONE}} |
|
|
181
|
+
| Result Links | {{RELATIVE_LINKS_OR_NONE}} |
|
|
182
|
+
| Finding Links | {{RELATIVE_LINKS_OR_NONE}} |
|
|
183
|
+
| Obligation Links | {{O_REFERENCES_OR_NONE}} |
|
|
184
|
+
| History Links | {{RELATIVE_LINKS_OR_NONE}} |
|
|
185
|
+
| Support Links | {{RELATIVE_LINKS_OR_NONE}} |
|
|
186
|
+
|
|
187
|
+
#### Evidence Fingerprint
|
|
188
|
+
|
|
189
|
+
- Profile ID, version, and digest: {{EXACT_BINDING}}
|
|
190
|
+
- Product build and relevant code state: {{STABLE_IDENTITIES}}
|
|
191
|
+
- Dependency and configuration state: {{STABLE_IDENTITIES}}
|
|
192
|
+
- Qualified environment: {{STABLE_IDENTITY_OR_DIGEST}}
|
|
193
|
+
- Workload and fixture or dataset: {{STABLE_IDENTITIES_OR_DIGESTS}}
|
|
194
|
+
- Instrument version: {{STABLE_IDENTITY}}
|
|
195
|
+
- Analysis method: {{STABLE_IDENTITY_OR_DIGEST}}
|
|
196
|
+
- Comparability result and reasons: {{MATCH_EQUIVALENT_OR_NOT_COMPARABLE_WITH_REASON}}
|
|
197
|
+
|
|
198
|
+
#### Budget Ledger
|
|
199
|
+
|
|
200
|
+
- Authorizing scope and budget event: {{REFERENCE_AND_ID}}
|
|
201
|
+
- Requalification authorization: {{REFERENCE_OR_NONE}}
|
|
202
|
+
- Declared limits: {{LIMITS}}
|
|
203
|
+
- Materially distinct attempts: {{ATTEMPT_REFERENCES}}
|
|
204
|
+
- Affected checks: {{CHECK_REFERENCES}}
|
|
205
|
+
- Time, compute, and external spend: {{CONSUMPTION}}
|
|
206
|
+
- Review cycles used: {{CONSUMPTION}}
|
|
207
|
+
- Remaining budget: {{REMAINDER}}
|
|
208
|
+
- Unchanged evidence reused: {{EVIDENCE_REFERENCES_OR_NONE}}
|
|
209
|
+
- Stop reason and escalation: {{STOP_AND_ROUTE}}
|
|
210
|
+
|
|
211
|
+
#### Result Record
|
|
212
|
+
|
|
213
|
+
- Result ID: {{STABLE_RESULT_ID}}
|
|
214
|
+
- Exact profile binding: {{ID_VERSION_AND_DIGEST}}
|
|
215
|
+
- Build and evidence fingerprint: {{REFERENCES}}
|
|
216
|
+
- Environment and workload: {{REFERENCES}}
|
|
217
|
+
- Raw and analyzed evidence: {{RELATIVE_OR_SANITIZED_STABLE_REFERENCES}}
|
|
218
|
+
- Observed distribution: {{OBSERVATIONS}}
|
|
219
|
+
- Uncertainty and exclusions: {{OBSERVATIONS_AND_REASONS}}
|
|
220
|
+
- Budget ledger: {{REFERENCE}}
|
|
221
|
+
- Outcome: `{{PASS_FAIL_REVISE_BLOCKED_OR_WAIVED}}`
|
|
222
|
+
- Findings: {{FINDING_REFERENCES_OR_NONE}}
|
|
223
|
+
- Owner or reviewer disposition: {{DISPOSITION}}
|
|
224
|
+
- Supported-scope limit: {{EXACT_LIMIT}}
|
|
225
|
+
- Expiry: {{CURRENT_USE_BOUNDARY}}
|
|
226
|
+
- Later result: {{REFERENCE_OR_NONE}}
|
|
227
|
+
|
|
228
|
+
#### Finding Record
|
|
229
|
+
|
|
230
|
+
- Finding ID: {{STABLE_FINDING_ID}}
|
|
231
|
+
- Observed behavior and expected protected outcome: {{OBSERVATION_AND_EXPECTATION}}
|
|
232
|
+
- Target class: `{{TARGET_CLASS}}`
|
|
233
|
+
- Severity: `{{CRITICAL_MAJOR_MODERATE_OR_MINOR}}`
|
|
234
|
+
- Reproducibility and attempts: `{{STATE_AND_REFERENCES}}`
|
|
235
|
+
- Affected support scope: {{EXACT_SCOPE}}
|
|
236
|
+
- Source requirement and evidence: {{RELATIVE_LINKS}}
|
|
237
|
+
- Owner and disposition: {{OWNER_AND_DISPOSITION}}
|
|
238
|
+
- Expiry: {{CURRENT_USE_BOUNDARY}}
|
|
239
|
+
- Remediation work: {{WORK_REFERENCE_OR_NONE}}
|
|
240
|
+
- Rerun or result links: {{RELATIVE_LINKS_OR_NONE}}
|
|
241
|
+
|
|
242
|
+
#### Waiver Record
|
|
243
|
+
|
|
244
|
+
- Requirement and profile: {{EXACT_REFERENCES}}
|
|
245
|
+
- Exact miss and affected scope: {{MISS_AND_SCOPE}}
|
|
246
|
+
- Rationale and accepted risk: {{RATIONALE_AND_RISK}}
|
|
247
|
+
- Non-sacrificable constraint status: {{STATUS}}
|
|
248
|
+
- Owner and approver: {{AUTHORITY_ROLES}}
|
|
249
|
+
- Expiry or release boundary: {{BOUNDARY}}
|
|
250
|
+
- Reevaluation or remediation trigger: {{TRIGGER}}
|
|
251
|
+
- Owed work: {{O_REFERENCE_OR_NONE}}
|
|
252
|
+
- Renewal or terminal disposition: {{DISPOSITION}}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "{{TITLE}}"
|
|
3
|
+
kind: "plan"
|
|
4
|
+
status: "draft"
|
|
5
|
+
coordinate: "W{{W}} R{{R}}"
|
|
6
|
+
follow_on:
|
|
7
|
+
route: "prd-generation"
|
|
8
|
+
next_prompt: "{{NEXT_PROMPT}}"
|
|
9
|
+
why: "{{FOLLOW_ON_WHY}}"
|
|
10
|
+
coordinate_handoff: "Carry W{{W}} R{{R}} into the downstream PRD and work backlog lineage."
|
|
11
|
+
# source:
|
|
12
|
+
# type: "design"
|
|
13
|
+
# path: "{{SOURCE_PATH}}"
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# {{TITLE}}
|
|
17
|
+
|
|
18
|
+
## Purpose
|
|
19
|
+
|
|
20
|
+
State what this plan covers and why it exists in one short paragraph. Link back to the originating design or change request if applicable.
|
|
21
|
+
|
|
22
|
+
## Objective
|
|
23
|
+
|
|
24
|
+
List the concrete goals and the completion criteria for the plan. A reader should be able to tell when the plan is done.
|
|
25
|
+
|
|
26
|
+
## Human Experience Propagation
|
|
27
|
+
|
|
28
|
+
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.
|
|
29
|
+
|
|
30
|
+
For `direct` or `indirect` impact, map each accepted promise:
|
|
31
|
+
|
|
32
|
+
| Promise | Owning PRD | Human-facing surface or indirect effect | Work phase | Evidence source or selected testing type | Accepted obligation, if any |
|
|
33
|
+
| --- | --- | --- | --- | --- | --- |
|
|
34
|
+
| {{PROMISE}} | {{PRD_AUTHORITY}} | {{SURFACE_OR_EFFECT}} | {{WORK_PHASE}} | {{EVIDENCE_OR_TESTING_TYPE}} | {{O_REF_OR_NONE}} |
|
|
35
|
+
|
|
36
|
+
For `none`, replace the table with the preserved human boundary and the evidence that will prove it unchanged.
|
|
37
|
+
|
|
38
|
+
## Performance Evidence Plan
|
|
39
|
+
|
|
40
|
+
For current performance candidates, read `make-docs://system/contract/performance-evidence-governance.md` with `make-docs resource read`. Record both decisions. Link one canonical profile for each executable candidate. Do not copy a product target into this plan.
|
|
41
|
+
|
|
42
|
+
| Candidate | Base maintenance action | Performance applicability | Target class | Canonical `PERF-###` or next record | Finite budget and stop reference | Lifecycle point |
|
|
43
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
44
|
+
| {{PERFORMANCE_CANDIDATE_OR_NONE}} | `{{BASE_MAINTENANCE_ACTION}}` | `{{REQUIRED_NOW_CHARACTERIZE_NOW_DEFER_REQUIRED_NOT_NEEDED_OR_REJECT_UNSUPPORTED}}` | `{{TARGET_CLASS_OR_NONE}}` | {{PERF_O_OR_NONE}} | {{BUDGET_AND_STOP_REFERENCE_OR_NOT_APPLICABLE}} | {{ACTIVATION_POINT_OR_NONE}} |
|
|
45
|
+
|
|
46
|
+
## Coordinate Decision
|
|
47
|
+
|
|
48
|
+
- Coordinate: `W{{W}} R{{R}}`
|
|
49
|
+
- Classification: `new-wave` or `revision`
|
|
50
|
+
- Evidence: Explain the explicit user guidance, design handoff, source lineage, prior plan/work/history records, or highest-wave fallback used to choose this coordinate.
|
|
51
|
+
|
|
52
|
+
## Phase Map
|
|
53
|
+
|
|
54
|
+
List the phase detail files in this plan directory with a one-line description of each. Every plan has at least one phase file even when the work is small.
|
|
55
|
+
|
|
56
|
+
| File | Purpose |
|
|
57
|
+
| ---- | ------- |
|
|
58
|
+
| `01-{{UPPER_SNAKE}}.md` | {{PHASE_PURPOSE}} |
|
|
59
|
+
| `02-{{UPPER_SNAKE}}.md` | {{PHASE_PURPOSE}} |
|
|
60
|
+
|
|
61
|
+
## Dependencies
|
|
62
|
+
|
|
63
|
+
Call out external dependencies, upstream artifacts, or prerequisites that must be resolved before or during execution.
|
|
64
|
+
|
|
65
|
+
## Validation
|
|
66
|
+
|
|
67
|
+
Describe how success of the overall plan is verified once all phases complete. Reference the review pass or acceptance gate that closes the plan. Include observable proof for each accepted Human Experience promise or preserved `none` boundary.
|
|
68
|
+
|
|
69
|
+
## Intended Follow-On
|
|
70
|
+
|
|
71
|
+
This handoff is advisory-default-but-overridable: it is authoritative unless the user explicitly overrides it, and it is not a gate or precondition.
|
|
72
|
+
|
|
73
|
+
- Route: `prd-generation`
|
|
74
|
+
- Next step: Generate or update the PRD set from this plan.
|
|
75
|
+
- Why: The plan should become the product or documentation contract before work backlog generation.
|
|
76
|
+
- Coordinate Handoff: Carry `W{{W}} R{{R}}` into the downstream PRD and work backlog lineage, or explain the coordinate question that must be resolved before writing.
|