wdi-method 0.6.8 → 0.6.18
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/CHANGELOG.md +213 -0
- package/README.md +13 -6
- package/bin/wdi-method.js +109 -1
- package/kit/.constitution/method/document/corpus-guide.md +41 -0
- package/kit/.constitution/method/document/decision-guide.md +216 -208
- package/kit/.constitution/method/method-glossary.md +184 -183
- package/kit/.constitution/method/scripts/timeline.py +676 -663
- package/kit/.constitution/method/scripts/validate.py +231 -26
- package/kit/skills/wdi-autopilot/SKILL.md +3 -2
- package/kit/skills/wdi-decision/SKILL.md +203 -197
- package/kit/skills/wdi-product/SKILL.md +22 -0
- package/kit/skills/wdi-upgrade/SKILL.md +23 -2
- package/package.json +2 -1
|
@@ -1,183 +1,184 @@
|
|
|
1
|
-
---
|
|
2
|
-
status: Accepted
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# Method Glossary
|
|
6
|
-
|
|
7
|
-
**Loaded when:** a method term is unclear, and before coining a new one.
|
|
8
|
-
|
|
9
|
-
The words this method uses for **itself**. What the product is about belongs to
|
|
10
|
-
`.control/product-glossary.md` instead. A term defined here MUST NOT be redefined there, and the
|
|
11
|
-
reverse holds too. The test: would this term still apply on a different product? Yes → here.
|
|
12
|
-
|
|
13
|
-
## Layers
|
|
14
|
-
|
|
15
|
-
| Term | Means |
|
|
16
|
-
|---|---|
|
|
17
|
-
| **Corpus** | The four layers below. `_bmad-output/` is not part of it |
|
|
18
|
-
| **`.constitution/`** | How we work. Rules. Rarely changes |
|
|
19
|
-
| **`.control/`** | What currently holds and what has been decided. Facts. Changes often. Equals `{project_knowledge}` |
|
|
20
|
-
| **`.what/`** | What was promised |
|
|
21
|
-
| **`.how/`** | How it is built |
|
|
22
|
-
| **Workspace** | `_bmad-output/` — work in progress, committed but not curated |
|
|
23
|
-
| **Placement test** | Is this file still true after its spec has passed? Yes → corpus. No → workspace |
|
|
24
|
-
|
|
25
|
-
## Units
|
|
26
|
-
|
|
27
|
-
| Term | Means |
|
|
28
|
-
|---|---|
|
|
29
|
-
| **Product Component** (PC) | A domain slice — the box at C4 L3. Lives in `.what/<pc>/` and `.how/<pc>/`, and its `containers:` says where it runs |
|
|
30
|
-
| **Logical Component** (LC) | One addressable unit of build. Registered in `components.yaml` with `type` · `container` · `owner` · `area` |
|
|
31
|
-
| **Container** | Something that **runs its own code or stores its own data** and can be replaced without rebuilding another one. The C4 L2 term, and the value of an LC's `container` field. Two questions decide it and both MUST be yes — `architecture-guide.md` owns the test. Shipping two containers in one release does **not** merge them |
|
|
32
|
-
| **`built`** | A container's one boolean. `true` when we write what is inside it, `false` when we deploy someone else's implementation. It decides whether the container gets an L3, an `LC`, and a heading in the codebase map — `container-built` checks all three |
|
|
33
|
-
| **External system** | Something the product talks to whose **runtime we do not deploy**. It belongs at C4 L1, and MUST NOT be a container, an `LC`'s `container`, or a heading in the codebase map. What we lean on it for lives in `cross-cutting.md` or an integration contract |
|
|
34
|
-
| **`_platform`** | **Not a component.** The home for what belongs to no Product Component: the spine, the C4 set, `cross-cutting.md`, the three inventories, and whatever it **owns**. A legitimate value in every position that asks which component owns something — `platform_owns`, an inventory row, an `LC`. Four kinds today: data · endpoint · job · screen. It carries no `mode`, no `risk_accepted`, and no G4 |
|
|
35
|
-
| **Library** | An includable artifact — compiled into or imported by something else, never run on its own. Not a container |
|
|
36
|
-
| **Slot** | A numbered sub-folder of a PC. `.what/<pc>/` 02–05 is reading order; `.how/<pc>/` 01–06 is ABCE classification. The two numberings do **not** mean the same thing |
|
|
37
|
-
| **Kernel** | The `SRS-<pc>.md` or `SDD-<pc>.md` file itself. Content SHOULD stay in it until it grows past roughly 400 lines — a suggestion, not a threshold |
|
|
38
|
-
|
|
39
|
-
A PC is not a container: a container runs, a PC is a domain. One container holds several PCs, and
|
|
40
|
-
one PC may appear in more than one container. Because they cross, neither list implies the other, and
|
|
41
|
-
the crossing MUST be written down rather than inferred — that is the PC × container matrix at C4 L2,
|
|
42
|
-
rendered from each PC's `containers:`.
|
|
43
|
-
|
|
44
|
-
## Flow
|
|
45
|
-
|
|
46
|
-
There is no "stage". The five gates are the only flow vocabulary, and the word **area** is not used at all —
|
|
47
|
-
there is only Product Component.
|
|
48
|
-
|
|
49
|
-
| Term | Means |
|
|
50
|
-
|---|---|
|
|
51
|
-
| **Gate** | One of five decision points: G1 Problem · G2 Product · G3 Blueprint · G4 Component · G5 Release. Named after what is decided there, not after the work before it |
|
|
52
|
-
| **`mode`** | The one knob for **document depth**, and nothing else. `catalog` · `outline` · `guarded` · `deep`, default `catalog`. Two scopes — global in `index.yaml`, per component in `components.yaml`, and the per-component one wins. **No third scope** |
|
|
53
|
-
| **`risk_accepted`** | The one field for **review intensity**, and nothing else. `low` · `medium` · `high`. It MUST NOT be derived from `mode`, nor `mode` from it |
|
|
54
|
-
| **Blueprint** | The whole-product portrait decided once at G3: one line per use case, table, endpoint, and screen, plus entities, actors, the spine, C4, and cross-component rules. It names a **gate and a skill**, never a document or a folder |
|
|
55
|
-
| **Spec** | One unit of delivered work: the tickets that reach one outcome. Opens at G4 or G5, closes at G5, recorded in `specs.yaml`. Its document is `SPEC.md`, **optional at size `S`** — one term, one entry, and the document is named after the unit the way a `DEC-` file is named after its decision |
|
|
56
|
-
| **Release** | What a PRD promises. One release MAY span several specs; the relation is data, never inferred from numbering |
|
|
57
|
-
| **Spec size** | `S` ≤3 tickets no new FR · `M` 4–12 · `L` >12 or a new container. MAY be raised mid-flight, MUST NOT be lowered. It does **not** choose which gates are active — that is `mode`. It decides two things: whether G4 and G5 merge into one session (`S`), and whether `SPEC.md` is written at all (`M` and up) |
|
|
58
|
-
| **Fast Path** | A fix that skips all gates: ≤1 ticket, no FR/UC/`AD-N`/domain-model change, no money, personal data, or third-party integration |
|
|
59
|
-
| **Step** | One of the five points inside `wdi-build`'s ship pipeline — plan · build · panel · publish · CI. It is **not** a gate and not a stage, and the word MUST NOT be used for anything at gate altitude |
|
|
60
|
-
|
|
61
|
-
## Artifacts
|
|
62
|
-
|
|
63
|
-
| Term | Means |
|
|
64
|
-
|---|---|
|
|
65
|
-
| **Brief** | One problem, one user, one measure. Singleton, spans releases |
|
|
66
|
-
| **PRD** | What is promised for **one initiative**, across every release it touches. FR and NFR numbered from the registry |
|
|
67
|
-
| **SRS** | Per PC: what the system must do. `.what/` — slices space, while the PRD slices initiative. It **exists at every `mode`**, carrying the actor list and the use case catalogue |
|
|
68
|
-
| **SDD** | Per PC: how it is built. `.how/`. At `mode: catalog` it is a skeleton, and that is a finished state |
|
|
69
|
-
| **Inventory** | One of three living registers at product level — tables, endpoints, screens. Written as a plan when there is no code, **derived** from code once there is |
|
|
70
|
-
| **Architecture spine** | `ARCHITECTURE-SPINE.md` — invariants as `AD-N`, each carrying Binds · Prevents · Rule. It constrains; it does not describe |
|
|
71
|
-
| **C4** | L1 system context · L2 containers · L3 components, one file per container. L1+L2 together are what other methods call the HLD |
|
|
72
|
-
| **`DESIGN.md`** | UX per PC, in `.how/<pc>/01-ux/` |
|
|
73
|
-
| **`EXPERIENCE.md`** | The user-facing journey, in `.what/<pc>/04-usecases/` |
|
|
74
|
-
| **`DEC-`** | One decision worth remembering, numbered globally. Lives in `.control/decisions/`. Recording is **not mandatory**; it freezes at `applied`, not at `accepted` |
|
|
75
|
-
| **SPEC** | The document of **one spec**: a projection of `.what/` + `.how/` that MUST NOT contain anything new. Not read by humans, and **not written at size `S`** — there the tickets are the contract |
|
|
76
|
-
| **Ticket** | One unit of build: a tracer-bullet vertical slice, complete through every layer, verifiable on its own, sized to one fresh context window. Carries the tickets that **block** it. Status is read from the ticket itself, never copied elsewhere |
|
|
77
|
-
| **Structure map** | `.control/structure-codebase.md` and `structure-document.md` — where things actually are today |
|
|
78
|
-
| **Mandate** | A `DEC-` of `type: mandate`: the owner's one dated, expiring delegation that lets `wdi-autopilot` decide what the skills would otherwise have asked. Its parameters live on its registry row only; every decision taken under it is a row in the ledger, `.control/memlog/autopilot-<date>.md` |
|
|
79
|
-
| **Memlog** | The record of *why* while an artifact was written. Never copied into a document; a source when writing a `DEC-`. It is a **run log**, and it MUST NOT be searched as an index of decisions — `.control/generated/decisions.md` is that |
|
|
80
|
-
|
|
81
|
-
## Identifiers
|
|
82
|
-
|
|
83
|
-
| Code | For |
|
|
84
|
-
|---|---|
|
|
85
|
-
| `BG-` · `FR-` · `NFR-` · `UJ-` | Business goal · functional requirement · non-functional requirement · user journey |
|
|
86
|
-
| `UC-` | Use case |
|
|
87
|
-
| `AD-` | An invariant in the architecture spine |
|
|
88
|
-
| `DEC-` | A decision |
|
|
89
|
-
| `LC-` | A Logical Component |
|
|
90
|
-
| `OQ-` | An open question |
|
|
91
|
-
| `
|
|
92
|
-
| `
|
|
93
|
-
| `
|
|
94
|
-
| `
|
|
95
|
-
| `
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
| **
|
|
110
|
-
| **
|
|
111
|
-
| **
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
| **
|
|
122
|
-
| **
|
|
123
|
-
| **
|
|
124
|
-
|
|
|
125
|
-
| **`
|
|
126
|
-
| **`
|
|
127
|
-
| **`
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
| `
|
|
135
|
-
| `
|
|
136
|
-
| `
|
|
137
|
-
|
|
|
138
|
-
|
|
|
139
|
-
|
|
|
140
|
-
| `
|
|
141
|
-
|
|
|
142
|
-
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
|
152
|
-
|
|
|
153
|
-
|
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
| **
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
1
|
+
---
|
|
2
|
+
status: Accepted
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Method Glossary
|
|
6
|
+
|
|
7
|
+
**Loaded when:** a method term is unclear, and before coining a new one.
|
|
8
|
+
|
|
9
|
+
The words this method uses for **itself**. What the product is about belongs to
|
|
10
|
+
`.control/product-glossary.md` instead. A term defined here MUST NOT be redefined there, and the
|
|
11
|
+
reverse holds too. The test: would this term still apply on a different product? Yes → here.
|
|
12
|
+
|
|
13
|
+
## Layers
|
|
14
|
+
|
|
15
|
+
| Term | Means |
|
|
16
|
+
|---|---|
|
|
17
|
+
| **Corpus** | The four layers below. `_bmad-output/` is not part of it |
|
|
18
|
+
| **`.constitution/`** | How we work. Rules. Rarely changes |
|
|
19
|
+
| **`.control/`** | What currently holds and what has been decided. Facts. Changes often. Equals `{project_knowledge}` |
|
|
20
|
+
| **`.what/`** | What was promised |
|
|
21
|
+
| **`.how/`** | How it is built |
|
|
22
|
+
| **Workspace** | `_bmad-output/` — work in progress, committed but not curated |
|
|
23
|
+
| **Placement test** | Is this file still true after its spec has passed? Yes → corpus. No → workspace |
|
|
24
|
+
|
|
25
|
+
## Units
|
|
26
|
+
|
|
27
|
+
| Term | Means |
|
|
28
|
+
|---|---|
|
|
29
|
+
| **Product Component** (PC) | A domain slice — the box at C4 L3. Lives in `.what/<pc>/` and `.how/<pc>/`, and its `containers:` says where it runs |
|
|
30
|
+
| **Logical Component** (LC) | One addressable unit of build. Registered in `components.yaml` with `type` · `container` · `owner` · `area` |
|
|
31
|
+
| **Container** | Something that **runs its own code or stores its own data** and can be replaced without rebuilding another one. The C4 L2 term, and the value of an LC's `container` field. Two questions decide it and both MUST be yes — `architecture-guide.md` owns the test. Shipping two containers in one release does **not** merge them |
|
|
32
|
+
| **`built`** | A container's one boolean. `true` when we write what is inside it, `false` when we deploy someone else's implementation. It decides whether the container gets an L3, an `LC`, and a heading in the codebase map — `container-built` checks all three |
|
|
33
|
+
| **External system** | Something the product talks to whose **runtime we do not deploy**. It belongs at C4 L1, and MUST NOT be a container, an `LC`'s `container`, or a heading in the codebase map. What we lean on it for lives in `cross-cutting.md` or an integration contract |
|
|
34
|
+
| **`_platform`** | **Not a component.** The home for what belongs to no Product Component: the spine, the C4 set, `cross-cutting.md`, the three inventories, and whatever it **owns**. A legitimate value in every position that asks which component owns something — `platform_owns`, an inventory row, an `LC`. Four kinds today: data · endpoint · job · screen. It carries no `mode`, no `risk_accepted`, and no G4 |
|
|
35
|
+
| **Library** | An includable artifact — compiled into or imported by something else, never run on its own. Not a container |
|
|
36
|
+
| **Slot** | A numbered sub-folder of a PC. `.what/<pc>/` 02–05 is reading order; `.how/<pc>/` 01–06 is ABCE classification. The two numberings do **not** mean the same thing |
|
|
37
|
+
| **Kernel** | The `SRS-<pc>.md` or `SDD-<pc>.md` file itself. Content SHOULD stay in it until it grows past roughly 400 lines — a suggestion, not a threshold |
|
|
38
|
+
|
|
39
|
+
A PC is not a container: a container runs, a PC is a domain. One container holds several PCs, and
|
|
40
|
+
one PC may appear in more than one container. Because they cross, neither list implies the other, and
|
|
41
|
+
the crossing MUST be written down rather than inferred — that is the PC × container matrix at C4 L2,
|
|
42
|
+
rendered from each PC's `containers:`.
|
|
43
|
+
|
|
44
|
+
## Flow
|
|
45
|
+
|
|
46
|
+
There is no "stage". The five gates are the only flow vocabulary, and the word **area** is not used at all —
|
|
47
|
+
there is only Product Component.
|
|
48
|
+
|
|
49
|
+
| Term | Means |
|
|
50
|
+
|---|---|
|
|
51
|
+
| **Gate** | One of five decision points: G1 Problem · G2 Product · G3 Blueprint · G4 Component · G5 Release. Named after what is decided there, not after the work before it |
|
|
52
|
+
| **`mode`** | The one knob for **document depth**, and nothing else. `catalog` · `outline` · `guarded` · `deep`, default `catalog`. Two scopes — global in `index.yaml`, per component in `components.yaml`, and the per-component one wins. **No third scope** |
|
|
53
|
+
| **`risk_accepted`** | The one field for **review intensity**, and nothing else. `low` · `medium` · `high`. It MUST NOT be derived from `mode`, nor `mode` from it |
|
|
54
|
+
| **Blueprint** | The whole-product portrait decided once at G3: one line per use case, table, endpoint, and screen, plus entities, actors, the spine, C4, and cross-component rules. It names a **gate and a skill**, never a document or a folder |
|
|
55
|
+
| **Spec** | One unit of delivered work: the tickets that reach one outcome. Opens at G4 or G5, closes at G5, recorded in `specs.yaml`. Its document is `SPEC.md`, **optional at size `S`** — one term, one entry, and the document is named after the unit the way a `DEC-` file is named after its decision |
|
|
56
|
+
| **Release** | What a PRD promises. One release MAY span several specs; the relation is data, never inferred from numbering |
|
|
57
|
+
| **Spec size** | `S` ≤3 tickets no new FR · `M` 4–12 · `L` >12 or a new container. MAY be raised mid-flight, MUST NOT be lowered. It does **not** choose which gates are active — that is `mode`. It decides two things: whether G4 and G5 merge into one session (`S`), and whether `SPEC.md` is written at all (`M` and up) |
|
|
58
|
+
| **Fast Path** | A fix that skips all gates: ≤1 ticket, no FR/UC/`AD-N`/domain-model change, no money, personal data, or third-party integration |
|
|
59
|
+
| **Step** | One of the five points inside `wdi-build`'s ship pipeline — plan · build · panel · publish · CI. It is **not** a gate and not a stage, and the word MUST NOT be used for anything at gate altitude |
|
|
60
|
+
|
|
61
|
+
## Artifacts
|
|
62
|
+
|
|
63
|
+
| Term | Means |
|
|
64
|
+
|---|---|
|
|
65
|
+
| **Brief** | One problem, one user, one measure. Singleton, spans releases |
|
|
66
|
+
| **PRD** | What is promised for **one initiative**, across every release it touches. FR and NFR numbered from the registry |
|
|
67
|
+
| **SRS** | Per PC: what the system must do. `.what/` — slices space, while the PRD slices initiative. It **exists at every `mode`**, carrying the actor list and the use case catalogue |
|
|
68
|
+
| **SDD** | Per PC: how it is built. `.how/`. At `mode: catalog` it is a skeleton, and that is a finished state |
|
|
69
|
+
| **Inventory** | One of three living registers at product level — tables, endpoints, screens. Written as a plan when there is no code, **derived** from code once there is |
|
|
70
|
+
| **Architecture spine** | `ARCHITECTURE-SPINE.md` — invariants as `AD-N`, each carrying Binds · Prevents · Rule. It constrains; it does not describe |
|
|
71
|
+
| **C4** | L1 system context · L2 containers · L3 components, one file per container. L1+L2 together are what other methods call the HLD |
|
|
72
|
+
| **`DESIGN.md`** | UX per PC, in `.how/<pc>/01-ux/` |
|
|
73
|
+
| **`EXPERIENCE.md`** | The user-facing journey, in `.what/<pc>/04-usecases/` |
|
|
74
|
+
| **`DEC-`** | One decision worth remembering, numbered globally. Lives in `.control/decisions/`. Recording is **not mandatory**; it freezes at `applied`, not at `accepted` |
|
|
75
|
+
| **SPEC** | The document of **one spec**: a projection of `.what/` + `.how/` that MUST NOT contain anything new. Not read by humans, and **not written at size `S`** — there the tickets are the contract |
|
|
76
|
+
| **Ticket** | One unit of build: a tracer-bullet vertical slice, complete through every layer, verifiable on its own, sized to one fresh context window. Carries the tickets that **block** it. Status is read from the ticket itself, never copied elsewhere |
|
|
77
|
+
| **Structure map** | `.control/structure-codebase.md` and `structure-document.md` — where things actually are today |
|
|
78
|
+
| **Mandate** | A `DEC-` of `type: mandate`: the owner's one dated, expiring delegation that lets `wdi-autopilot` decide what the skills would otherwise have asked. Its parameters live on its registry row only; every decision taken under it is a row in the ledger, `.control/memlog/autopilot-<date>.md` |
|
|
79
|
+
| **Memlog** | The record of *why* while an artifact was written. Never copied into a document; a source when writing a `DEC-`. It is a **run log**, and it MUST NOT be searched as an index of decisions — `.control/generated/decisions.md` is that |
|
|
80
|
+
|
|
81
|
+
## Identifiers
|
|
82
|
+
|
|
83
|
+
| Code | For |
|
|
84
|
+
|---|---|
|
|
85
|
+
| `BG-` · `FR-` · `NFR-` · `UJ-` | Business goal · functional requirement · non-functional requirement · user journey |
|
|
86
|
+
| `UC-` | Use case |
|
|
87
|
+
| `AD-` | An invariant in the architecture spine |
|
|
88
|
+
| `DEC-` | A decision |
|
|
89
|
+
| `LC-` | A Logical Component |
|
|
90
|
+
| `OQ-` | An open question |
|
|
91
|
+
| `status: withdrawn` | On a `BG` · `CAP` · `FR` · `NFR` · `UC` row: the product stopped promising it, and the row stays so every old reference still resolves and its id is never reused. It names the `DEC-` that withdrew it in `withdrawn_by`. Still **defined**, no longer **promised** — `corpus-guide.md` owns the rule |
|
|
92
|
+
| `RTR-` | **Retired.** It was an archived retrospective in `.control/reports/`; the retrospective step and `V19` went together. A frozen `RTR-` file stays where it is |
|
|
93
|
+
| `CAP-` | A capability — the planning unit |
|
|
94
|
+
| `NT-` | A non-technical fact |
|
|
95
|
+
| `BUG-` · `HOT-` | A defect · a hotfix |
|
|
96
|
+
| `goal-has-fr`–`container-built` | Validators. `V10` fell and its number is not reused |
|
|
97
|
+
|
|
98
|
+
IDs are allocated **globally** and never restart per document, per component, or per release. The chain
|
|
99
|
+
that must hold end to end: `BG → FR → UC → ticket → test`.
|
|
100
|
+
|
|
101
|
+
`ADR-` is **retired**. It was renamed to `DEC-` on 2026-08-18 with the numbers unchanged, so `ADR-004`
|
|
102
|
+
inside a document frozen before that date is an alias for `DEC-004`, and those documents MUST NOT be
|
|
103
|
+
rewritten for the prefix.
|
|
104
|
+
|
|
105
|
+
## Registry and generated
|
|
106
|
+
|
|
107
|
+
| Term | Means |
|
|
108
|
+
|---|---|
|
|
109
|
+
| **Registry** | `.control/registry/` — the source of truth for IDs and plans. Written through `wdi-*` skills |
|
|
110
|
+
| **Generated** | `.control/generated/` — derived from the registry. Written by the generator only, by hand **never** |
|
|
111
|
+
| **RTM** | Requirements traceability matrix. Generated, never hand-maintained |
|
|
112
|
+
| **Validator** | A script that answers what can be counted. It does not replace a gate checklist, which answers what must be judged |
|
|
113
|
+
|
|
114
|
+
## BMad terms
|
|
115
|
+
|
|
116
|
+
BMad terms live in a WDI glossary because WDI runs on BMad. Each is defined **as WDI uses it**;
|
|
117
|
+
where BMad's own meaning is wider, the narrower one here wins.
|
|
118
|
+
|
|
119
|
+
| Term | Means |
|
|
120
|
+
|---|---|
|
|
121
|
+
| **Stories mode** | **Retired.** It was BMad's route — `SPEC.md` + `stories.yaml` produced by `bmad-spec`. The engine layer below G5 no longer runs it; `bmad-guide.md` says what replaced it |
|
|
122
|
+
| **Skill class** | `A` living document, straight to the corpus · `B` living but wrongly granular, lands neutral then is placed · `C` spent after its work · `D` no artifact |
|
|
123
|
+
| **Companion** | A side file a BMad skill produces next to its main output. The lasting ones are promoted by the distillation table |
|
|
124
|
+
| **Distillation** | Promoting what is durable out of `_bmad-output/` before a spec closes. What is not promoted dies with the folder |
|
|
125
|
+
| **`persistent_facts`** | Files a skill always reads. Routing alone does not achieve this |
|
|
126
|
+
| **`doc_standards`** | Rule files a skill checks its output against. Facts MUST NOT be installed here, and neither MUST anything at `status: Reference` |
|
|
127
|
+
| **`{project_knowledge}`** | The config variable pointing at `.control/` |
|
|
128
|
+
| **`_bmad/custom/`** | Where every BMad override lives. `.claude/skills/bmad-*/customize.toml` MUST NOT be edited — it is overwritten on update |
|
|
129
|
+
|
|
130
|
+
## Retired — MUST NOT be used as current
|
|
131
|
+
|
|
132
|
+
| Retired | Instead |
|
|
133
|
+
|---|---|
|
|
134
|
+
| `ADR-` | `DEC-` — same numbers, new prefix |
|
|
135
|
+
| `ANX-`, and the annex concept | Nothing. Zero annexes were ever born |
|
|
136
|
+
| `SCP-` | A `DEC-` of `type: course-correction` |
|
|
137
|
+
| `layer:` on a decision | `touches:`, filled from what actually changed |
|
|
138
|
+
| "Stage 1"…"Stage 5" as flow vocabulary | The five gates |
|
|
139
|
+
| `epics.md` · `sprint-status.yaml` · `bmad-sprint-planning` · `bmad-create-epics-and-stories` · `stories.yaml` | Tickets, each carrying its own status and its blocking edges |
|
|
140
|
+
| Validator `V10` | Nothing. Its number is not reused |
|
|
141
|
+
| `bmad-help` as the answer to "where am I" | `wdi-help` |
|
|
142
|
+
| The skills `wdi-analysis` · `wdi-architecture` · `wdi-design` · `wdi-glossary` · `wdi-structure` · `wdi-apply` · `wdi-correct-course` · `wdi-wave` · `wdi-ship-story` · `wdi-product-brief` · `wdi-meeting` · `wdi-project-log` | The eighteen in `why/README.md`. `why/rationale.md` says which absorbed which, and why |
|
|
143
|
+
| An Indonesian synonym for a `mode` value — *ringkas*, *terjaga*, *katalog* as prose | The English value, used as written: `catalog` · `outline` · `guarded` · `deep` |
|
|
144
|
+
|
|
145
|
+
## Synonyms that MUST NOT be coined
|
|
146
|
+
|
|
147
|
+
A synonym for a term that already has an entry is drift, and `wdi-reconcile` hunts for it.
|
|
148
|
+
|
|
149
|
+
| Do not say | Say | Because |
|
|
150
|
+
|---|---|---|
|
|
151
|
+
| application · app · service, for a deployable | **container** | The term is already defined at C4 L2 and carried by every LC |
|
|
152
|
+
| infrastructure · third-party · dependency, for something inside the boundary | **container** with `built: false` | Calling it something else is how a container ends up with no row, no owner, and no NFR |
|
|
153
|
+
| container, for something whose runtime we do not deploy | **external system** | It has no `built`, no L3, and no heading. Registering it as a container promises a section of the codebase map that will never exist |
|
|
154
|
+
| module · package, for a unit of build | **Logical Component** | `components.yaml` names it, and `lc-registered` resolves against that name |
|
|
155
|
+
| epic · sprint, for a batch of work | **spec** | Both belong to the sprint route this method dropped |
|
|
156
|
+
| **wave**, for a unit of delivered work | **spec** | Retired when the engine layer below G5 changed. See the retired-alias rule below |
|
|
157
|
+
| **story**, for a unit of build | **ticket** | Same retirement. A ticket is a vertical slice that blocks and is blocked; a story was a row in a file BMad owned |
|
|
158
|
+
| area, for a domain slice | **Product Component** | The word "area" is not used anywhere in this method |
|
|
159
|
+
| platform, for a Product Component | **`_platform`**, and only for what is not one | Registering `_platform` as a PC gives it a `mode`, an SRS, and a G4 it has no use for |
|
|
160
|
+
| profile · tier · level, for document depth | **`mode`** | One knob, four values, and no matrix behind it |
|
|
161
|
+
| feature, for a domain slice | **Product Component** | A feature is a promise; a PC is a folder pair with an owner |
|
|
162
|
+
| requirements document | **PRD** or **SRS** | They cut different axes — time versus space — and merging the names merges the documents |
|
|
163
|
+
|
|
164
|
+
## Retired terms keep their frozen documents
|
|
165
|
+
|
|
166
|
+
`wave` and `story` are **retired aliases** of `spec` and `ticket`. A `wave` or a `story` appearing in a
|
|
167
|
+
document frozen before the change — a closed `DEC-`, an `RTR-`, minutes, `why/rationale.md`'s record of what
|
|
168
|
+
happened — reads as its replacement, and those documents **MUST NOT be rewritten for the term.** This is the
|
|
169
|
+
same rule Article 6 already applies to `ADR-NNN` → `DEC-NNN`, and for the same reason: a frozen record that
|
|
170
|
+
cites a name is evidence, and rewriting evidence to tidy a vocabulary destroys the thing that made it useful.
|
|
171
|
+
|
|
172
|
+
What MUST use the new term: every `Accepted` guide, every skill, every registry, and anything written from
|
|
173
|
+
here on.
|
|
174
|
+
|
|
175
|
+
## Rules
|
|
176
|
+
|
|
177
|
+
- A new method term MUST be added here in the same pass it first appears, not defined where it is
|
|
178
|
+
used. Adding one is a change to the **method itself** — `wdi-blueprint` MAY propose it and MUST NOT
|
|
179
|
+
write it, because a method term binds every project the method is installed in.
|
|
180
|
+
- One term MUST NOT have two entries. Two meanings mean two terms.
|
|
181
|
+
- A domain term MUST go to `.control/product-glossary.md` instead. If it is unclear which, ask whether the
|
|
182
|
+
term would survive being applied to a different product: yes → here, no → there.
|
|
183
|
+
- Common technical terms stay in English when the industry name is the one that matches the code,
|
|
184
|
+
the error message, or the reader's expectation.
|