wdi-method 0.5.0 → 0.5.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.
@@ -1,169 +1,169 @@
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 wave 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 — V25 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
- | **Wave** | One unit of delivered work. Opens at G4 or G5, closes at G5, recorded in `waves.yaml` |
56
- | **Release** | What a PRD promises. One release MAY span several waves; the relation is data, never inferred from numbering |
57
- | **Wave size** | `S` ≤3 stories 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` |
58
- | **Fast Path** | A fix that skips all gates: ≤1 story, 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 machine contract for **one wave**. A projection of `.what/` + `.how/`, and MUST NOT contain anything new. Not read by humans |
76
- | **Story** | One unit of build. Status is read from its own frontmatter, never copied elsewhere |
77
- | **Structure map** | `.control/structure-codebase.md` and `structure-document.md` — where things actually are today |
78
- | **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 |
79
-
80
- ## Identifiers
81
-
82
- | Code | For |
83
- |---|---|
84
- | `BG-` · `FR-` · `NFR-` · `UJ-` | Business goal · functional requirement · non-functional requirement · user journey |
85
- | `UC-` | Use case |
86
- | `AD-` | An invariant in the architecture spine |
87
- | `DEC-` | A decision |
88
- | `LC-` | A Logical Component |
89
- | `OQ-` | An open question |
90
- | `RTR-` | An archived retrospective, in `.control/reports/` |
91
- | `CAP-` | A capability — the planning unit |
92
- | `NT-` | A non-technical fact |
93
- | `BUG-` · `HOT-` | A defect · a hotfix |
94
- | `V1`–`V25` | Validators. `V10` fell and its number is not reused |
95
-
96
- IDs are allocated **globally** and never restart per document, per component, or per release. The chain
97
- that must hold end to end: `BG → FR → UC → story → test`.
98
-
99
- `ADR-` is **retired**. It was renamed to `DEC-` on 2026-08-18 with the numbers unchanged, so `ADR-004`
100
- inside a document frozen before that date is an alias for `DEC-004`, and those documents MUST NOT be
101
- rewritten for the prefix.
102
-
103
- ## Registry and generated
104
-
105
- | Term | Means |
106
- |---|---|
107
- | **Registry** | `.control/registry/` — the source of truth for IDs and plans. Written through `wdi-*` skills |
108
- | **Generated** | `.control/generated/` — derived from the registry. Written by the generator only, by hand **never** |
109
- | **RTM** | Requirements traceability matrix. Generated, never hand-maintained |
110
- | **Validator** | A script that answers what can be counted. It does not replace a gate checklist, which answers what must be judged |
111
-
112
- ## BMad terms
113
-
114
- BMad terms live in a WDI glossary because WDI runs on BMad. Each is defined **as WDI uses it**;
115
- where BMad's own meaning is wider, the narrower one here wins.
116
-
117
- | Term | Means |
118
- |---|---|
119
- | **Stories mode** | The route this method uses: SRS + SDD + PRD → `SPEC.md` + `stories.yaml` → build |
120
- | **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 |
121
- | **Companion** | A side file a BMad skill produces next to its main output. The lasting ones are promoted by the distillation table |
122
- | **Distillation** | Promoting what is durable out of `_bmad-output/` before a wave closes. What is not promoted dies with the folder |
123
- | **`persistent_facts`** | Files a skill always reads. Routing alone does not achieve this |
124
- | **`doc_standards`** | Rule files a skill checks its output against. Facts MUST NOT be installed here, and neither MUST anything at `status: Reference` |
125
- | **`{project_knowledge}`** | The config variable pointing at `.control/` |
126
- | **`_bmad/custom/`** | Where every BMad override lives. `.claude/skills/bmad-*/customize.toml` MUST NOT be edited — it is overwritten on update |
127
-
128
- ## Retired — MUST NOT be used as current
129
-
130
- | Retired | Instead |
131
- |---|---|
132
- | `ADR-` | `DEC-` — same numbers, new prefix |
133
- | `ANX-`, and the annex concept | Nothing. Zero annexes were ever born |
134
- | `SCP-` | A `DEC-` of `type: course-correction` |
135
- | `layer:` on a decision | `touches:`, filled from what actually changed |
136
- | "Stage 1"…"Stage 5" as flow vocabulary | The five gates |
137
- | `epics.md` · `sprint-status.yaml` · `bmad-sprint-planning` · `bmad-create-epics-and-stories` | The stories route: `SPEC.md` + `stories.yaml`, status in story frontmatter |
138
- | Validator `V10` | Nothing. Its number is not reused |
139
- | `bmad-help` as the answer to "where am I" | `wdi-help` |
140
- | 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 fifteen in `method/README.md`. `method/rationale.md` says which absorbed which, and why |
141
- | An Indonesian synonym for a `mode` value — *ringkas*, *terjaga*, *katalog* as prose | The English value, used as written: `catalog` · `outline` · `guarded` · `deep` |
142
-
143
- ## Synonyms that MUST NOT be coined
144
-
145
- A synonym for a term that already has an entry is drift, and `wdi-reconcile` hunts for it.
146
-
147
- | Do not say | Say | Because |
148
- |---|---|---|
149
- | application · app · service, for a deployable | **container** | The term is already defined at C4 L2 and carried by every LC |
150
- | 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 |
151
- | 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 |
152
- | module · package, for a unit of build | **Logical Component** | `components.yaml` names it, and V12 resolves against that name |
153
- | epic · sprint, for a batch of work | **wave** | Both belong to the sprint route this method dropped |
154
- | area, for a domain slice | **Product Component** | The word "area" is not used anywhere in this method |
155
- | 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 |
156
- | profile · tier · level, for document depth | **`mode`** | One knob, four values, and no matrix behind it |
157
- | feature, for a domain slice | **Product Component** | A feature is a promise; a PC is a folder pair with an owner |
158
- | requirements document | **PRD** or **SRS** | They cut different axes — time versus space — and merging the names merges the documents |
159
-
160
- ## Rules
161
-
162
- - A new method term MUST be added here in the same pass it first appears, not defined where it is
163
- used. Adding one is a change to the **method itself** — `wdi-blueprint` MAY propose it and MUST NOT
164
- write it, because a method term binds every project the method is installed in.
165
- - One term MUST NOT have two entries. Two meanings mean two terms.
166
- - A domain term MUST go to `.control/product-glossary.md` instead. If it is unclear which, ask whether the
167
- term would survive being applied to a different product: yes → here, no → there.
168
- - Common technical terms stay in English when the industry name is the one that matches the code,
169
- the error message, or the reader's expectation.
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 wave 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 — V25 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
+ | **Wave** | One unit of delivered work. Opens at G4 or G5, closes at G5, recorded in `waves.yaml` |
56
+ | **Release** | What a PRD promises. One release MAY span several waves; the relation is data, never inferred from numbering |
57
+ | **Wave size** | `S` ≤3 stories 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` |
58
+ | **Fast Path** | A fix that skips all gates: ≤1 story, 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 machine contract for **one wave**. A projection of `.what/` + `.how/`, and MUST NOT contain anything new. Not read by humans |
76
+ | **Story** | One unit of build. Status is read from its own frontmatter, never copied elsewhere |
77
+ | **Structure map** | `.control/structure-codebase.md` and `structure-document.md` — where things actually are today |
78
+ | **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 |
79
+
80
+ ## Identifiers
81
+
82
+ | Code | For |
83
+ |---|---|
84
+ | `BG-` · `FR-` · `NFR-` · `UJ-` | Business goal · functional requirement · non-functional requirement · user journey |
85
+ | `UC-` | Use case |
86
+ | `AD-` | An invariant in the architecture spine |
87
+ | `DEC-` | A decision |
88
+ | `LC-` | A Logical Component |
89
+ | `OQ-` | An open question |
90
+ | `RTR-` | An archived retrospective, in `.control/reports/` |
91
+ | `CAP-` | A capability — the planning unit |
92
+ | `NT-` | A non-technical fact |
93
+ | `BUG-` · `HOT-` | A defect · a hotfix |
94
+ | `V1`–`V25` | Validators. `V10` fell and its number is not reused |
95
+
96
+ IDs are allocated **globally** and never restart per document, per component, or per release. The chain
97
+ that must hold end to end: `BG → FR → UC → story → test`.
98
+
99
+ `ADR-` is **retired**. It was renamed to `DEC-` on 2026-08-18 with the numbers unchanged, so `ADR-004`
100
+ inside a document frozen before that date is an alias for `DEC-004`, and those documents MUST NOT be
101
+ rewritten for the prefix.
102
+
103
+ ## Registry and generated
104
+
105
+ | Term | Means |
106
+ |---|---|
107
+ | **Registry** | `.control/registry/` — the source of truth for IDs and plans. Written through `wdi-*` skills |
108
+ | **Generated** | `.control/generated/` — derived from the registry. Written by the generator only, by hand **never** |
109
+ | **RTM** | Requirements traceability matrix. Generated, never hand-maintained |
110
+ | **Validator** | A script that answers what can be counted. It does not replace a gate checklist, which answers what must be judged |
111
+
112
+ ## BMad terms
113
+
114
+ BMad terms live in a WDI glossary because WDI runs on BMad. Each is defined **as WDI uses it**;
115
+ where BMad's own meaning is wider, the narrower one here wins.
116
+
117
+ | Term | Means |
118
+ |---|---|
119
+ | **Stories mode** | The route this method uses: SRS + SDD + PRD → `SPEC.md` + `stories.yaml` → build |
120
+ | **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 |
121
+ | **Companion** | A side file a BMad skill produces next to its main output. The lasting ones are promoted by the distillation table |
122
+ | **Distillation** | Promoting what is durable out of `_bmad-output/` before a wave closes. What is not promoted dies with the folder |
123
+ | **`persistent_facts`** | Files a skill always reads. Routing alone does not achieve this |
124
+ | **`doc_standards`** | Rule files a skill checks its output against. Facts MUST NOT be installed here, and neither MUST anything at `status: Reference` |
125
+ | **`{project_knowledge}`** | The config variable pointing at `.control/` |
126
+ | **`_bmad/custom/`** | Where every BMad override lives. `.claude/skills/bmad-*/customize.toml` MUST NOT be edited — it is overwritten on update |
127
+
128
+ ## Retired — MUST NOT be used as current
129
+
130
+ | Retired | Instead |
131
+ |---|---|
132
+ | `ADR-` | `DEC-` — same numbers, new prefix |
133
+ | `ANX-`, and the annex concept | Nothing. Zero annexes were ever born |
134
+ | `SCP-` | A `DEC-` of `type: course-correction` |
135
+ | `layer:` on a decision | `touches:`, filled from what actually changed |
136
+ | "Stage 1"…"Stage 5" as flow vocabulary | The five gates |
137
+ | `epics.md` · `sprint-status.yaml` · `bmad-sprint-planning` · `bmad-create-epics-and-stories` | The stories route: `SPEC.md` + `stories.yaml`, status in story frontmatter |
138
+ | Validator `V10` | Nothing. Its number is not reused |
139
+ | `bmad-help` as the answer to "where am I" | `wdi-help` |
140
+ | 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 fifteen in `why/README.md`. `why/rationale.md` says which absorbed which, and why |
141
+ | An Indonesian synonym for a `mode` value — *ringkas*, *terjaga*, *katalog* as prose | The English value, used as written: `catalog` · `outline` · `guarded` · `deep` |
142
+
143
+ ## Synonyms that MUST NOT be coined
144
+
145
+ A synonym for a term that already has an entry is drift, and `wdi-reconcile` hunts for it.
146
+
147
+ | Do not say | Say | Because |
148
+ |---|---|---|
149
+ | application · app · service, for a deployable | **container** | The term is already defined at C4 L2 and carried by every LC |
150
+ | 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 |
151
+ | 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 |
152
+ | module · package, for a unit of build | **Logical Component** | `components.yaml` names it, and V12 resolves against that name |
153
+ | epic · sprint, for a batch of work | **wave** | Both belong to the sprint route this method dropped |
154
+ | area, for a domain slice | **Product Component** | The word "area" is not used anywhere in this method |
155
+ | 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 |
156
+ | profile · tier · level, for document depth | **`mode`** | One knob, four values, and no matrix behind it |
157
+ | feature, for a domain slice | **Product Component** | A feature is a promise; a PC is a folder pair with an owner |
158
+ | requirements document | **PRD** or **SRS** | They cut different axes — time versus space — and merging the names merges the documents |
159
+
160
+ ## Rules
161
+
162
+ - A new method term MUST be added here in the same pass it first appears, not defined where it is
163
+ used. Adding one is a change to the **method itself** — `wdi-blueprint` MAY propose it and MUST NOT
164
+ write it, because a method term binds every project the method is installed in.
165
+ - One term MUST NOT have two entries. Two meanings mean two terms.
166
+ - A domain term MUST go to `.control/product-glossary.md` instead. If it is unclear which, ask whether the
167
+ term would survive being applied to a different product: yes → here, no → there.
168
+ - Common technical terms stay in English when the industry name is the one that matches the code,
169
+ the error message, or the reader's expectation.
@@ -1,110 +1,120 @@
1
- ---
2
- status: Accepted
3
- ---
4
-
5
- # Repo Guide
6
-
7
- **Loaded when:** adding a file that is neither code nor corpus, or unsure whether something may be
8
- kept in this repo
9
-
10
- Every other guide answers *where in the corpus does this go*. This one answers the question that
11
- comes before it: **does it belong in this repository at all?**
12
-
13
- ## What this repository is
14
-
15
- One product, built for one owner. It holds what is needed to build and run that product, and
16
- nothing that merely relates to it commercially or organisationally.
17
-
18
- | MAY be here | MUST NOT be here |
19
- |---|---|
20
- | Application code, configuration, migrations, tests | Proposals, contracts, meeting notes with the client |
21
- | The corpus — `.constitution/` `.control/` `.what/` `.how/` | Contract values, pricing strategy, margins, rate cards |
22
- | Technical documentation, ADR, diagrams | Real customer data, production credentials, tokens |
23
- | Synthetic seed data | Anything whose leak would harm a bargaining position |
24
- | Built deliverables | An archive of commercial documents |
25
-
26
- The test is not "is it secret". It is **what changes when this file changes** — a commitment, or how
27
- the thing is built. Only the second belongs here.
28
-
29
- ## Two failure modes, and why the second is worse
30
-
31
- The obvious one is a credential in a commit. It is loud, it is caught, and it has a known remedy.
32
-
33
- The quiet one is a **commercial fact restated as a technical one** — a limit that exists because of
34
- what was negotiated, written into an ADR as though it were an engineering constraint. It survives
35
- every scan, it is never noticed as a leak, and it teaches the next reader that the boundary is
36
- soft.
37
-
38
- When a technical decision genuinely follows from a commercial one, the ADR MUST state the technical
39
- fact and MUST NOT state the commercial one. *"Retention is 90 days"* is a technical fact.
40
- *"Retention is 90 days because the client would not pay for more"* is a commercial one wearing a
41
- technical coat.
42
-
43
- ## `.work/` — scratch that is committed
44
-
45
- `.work/` holds work in progress that has no home yet: notes while reading an unfamiliar system,
46
- drafts, exploratory output, a working paper for a change spanning several sessions.
47
-
48
- It is **committed**, so that a session picked up on another machine finds it, and so a reviewer can
49
- see what a change was actually reasoning about.
50
-
51
- It is **ephemeral**, and the two together are what make its rules matter:
52
-
53
- - Any durable outcome MUST be moved out before the task closes — to the corpus if it is truth, to
54
- `_bmad-output/` if it is a run's byproduct.
55
- - Obsolete scratch MUST be deleted when its task closes. `.work/` that only grows stops being
56
- scratch and becomes a second, unindexed corpus that nobody trusts and nobody deletes.
57
- - Secrets and commercial figures MUST NOT be written here. Being scratch is not an exemption; it is
58
- the reason people assume it is one.
59
- - Nothing MUST be read from `.work/` as authority. If something there is right, it belongs
60
- somewhere with an owner.
61
-
62
- `.work/` MUST NOT be confused with `_bmad-output/`. That folder holds the output of skill runs, is
63
- never curated, and is cited by path. `.work/` holds what a human or agent wrote by hand while
64
- working, and is meant to empty out.
65
-
66
- ## Referring to things outside this repository
67
-
68
- Engagement context — who the client is, what was agreed, what is due — lives elsewhere. This repo
69
- MUST work without it. An agent MUST be able to act on the rules stated here without opening any
70
- other repository.
71
-
72
- When an artifact genuinely needs external context:
73
-
74
- - MUST state the technical fact locally, in full.
75
- - MAY name the external source by **repository and path**, as provenance.
76
- - MUST NOT paste the external content in, and MUST NOT replace a technical statement with a pointer
77
- to a commercial document.
78
-
79
- A pointer where a specification should be is the failure this rule exists to stop: the reader who
80
- cannot open that path is left with nothing, and the reader who can is reading the wrong kind of
81
- document.
82
-
83
- ## How the method arrives
84
-
85
- Method files in `.constitution/`, the `wdi-*` skills, and `_bmad/custom/*.toml` arrive from the
86
- public WDI Method package via `npx wdi-method install` / `update`.
87
-
88
- **Three paths inside `.constitution/` are this product's, not the method's.** Each is seeded once
89
- when absent and then never written again — an update MUST NOT touch one, and `promote` MUST NOT
90
- carry one back into the package:
91
-
92
- | Path | Holds |
93
- |---|---|
94
- | `constitution.md` | This product's Articles 1, 2, and 5 |
95
- | `codebase/*-guide.md` | This product's stack, conventions, and brownfield rules — at **any** `status:`, including `Draft`, which is when they are being written |
96
- | `project/` | Any rule that binds only this product |
97
-
98
- The seam is the **path**, never a marked region inside a generic file. `AGENTS.md` uses a marked
99
- block because it is one file with no alternative; `.constitution/` has fifty-odd, and blocks inside
100
- them would make every update perform surgery in every file.
101
-
102
- At **read time** this repo is self-contained: every file the rules need is here, readable with the
103
- repo alone. At **change time** the method has one published writer the WDI Method package. Two
104
- rules follow:
105
-
106
- - A method file MUST NOT be invented or patched here to improve the method. If a rule is wrong, it
107
- is fixed in the WDI Method package, then brought here with `update`.
108
- - A rule particular to this repo MUST be written out in full, and MUST NOT be replaced by a pointer
109
- into another repository.
110
-
1
+ ---
2
+ status: Accepted
3
+ ---
4
+
5
+ # Repo Guide
6
+
7
+ **Loaded when:** adding a file that is neither code nor corpus, or unsure whether something may be
8
+ kept in this repo
9
+
10
+ Every other guide answers *where in the corpus does this go*. This one answers the question that
11
+ comes before it: **does it belong in this repository at all?**
12
+
13
+ ## What this repository is
14
+
15
+ One product, built for one owner. It holds what is needed to build and run that product, and
16
+ nothing that merely relates to it commercially or organisationally.
17
+
18
+ | MAY be here | MUST NOT be here |
19
+ |---|---|
20
+ | Application code, configuration, migrations, tests | Proposals, contracts, meeting notes with the client |
21
+ | The corpus — `.constitution/` `.control/` `.what/` `.how/` | Contract values, pricing strategy, margins, rate cards |
22
+ | Technical documentation, ADR, diagrams | Real customer data, production credentials, tokens |
23
+ | Synthetic seed data | Anything whose leak would harm a bargaining position |
24
+ | Built deliverables | An archive of commercial documents |
25
+
26
+ The test is not "is it secret". It is **what changes when this file changes** — a commitment, or how
27
+ the thing is built. Only the second belongs here.
28
+
29
+ ## Two failure modes, and why the second is worse
30
+
31
+ The obvious one is a credential in a commit. It is loud, it is caught, and it has a known remedy.
32
+
33
+ The quiet one is a **commercial fact restated as a technical one** — a limit that exists because of
34
+ what was negotiated, written into an ADR as though it were an engineering constraint. It survives
35
+ every scan, it is never noticed as a leak, and it teaches the next reader that the boundary is
36
+ soft.
37
+
38
+ When a technical decision genuinely follows from a commercial one, the ADR MUST state the technical
39
+ fact and MUST NOT state the commercial one. *"Retention is 90 days"* is a technical fact.
40
+ *"Retention is 90 days because the client would not pay for more"* is a commercial one wearing a
41
+ technical coat.
42
+
43
+ ## `.work/` — scratch that is committed
44
+
45
+ `.work/` holds work in progress that has no home yet: notes while reading an unfamiliar system,
46
+ drafts, exploratory output, a working paper for a change spanning several sessions.
47
+
48
+ It is **committed**, so that a session picked up on another machine finds it, and so a reviewer can
49
+ see what a change was actually reasoning about.
50
+
51
+ It is **ephemeral**, and the two together are what make its rules matter:
52
+
53
+ - Any durable outcome MUST be moved out before the task closes — to the corpus if it is truth, to
54
+ `_bmad-output/` if it is a run's byproduct.
55
+ - Obsolete scratch MUST be deleted when its task closes. `.work/` that only grows stops being
56
+ scratch and becomes a second, unindexed corpus that nobody trusts and nobody deletes.
57
+ - Secrets and commercial figures MUST NOT be written here. Being scratch is not an exemption; it is
58
+ the reason people assume it is one.
59
+ - Nothing MUST be read from `.work/` as authority. If something there is right, it belongs
60
+ somewhere with an owner.
61
+
62
+ `.work/` MUST NOT be confused with `_bmad-output/`. That folder holds the output of skill runs, is
63
+ never curated, and is cited by path. `.work/` holds what a human or agent wrote by hand while
64
+ working, and is meant to empty out.
65
+
66
+ ## Referring to things outside this repository
67
+
68
+ Engagement context — who the client is, what was agreed, what is due — lives elsewhere. This repo
69
+ MUST work without it. An agent MUST be able to act on the rules stated here without opening any
70
+ other repository.
71
+
72
+ When an artifact genuinely needs external context:
73
+
74
+ - MUST state the technical fact locally, in full.
75
+ - MAY name the external source by **repository and path**, as provenance.
76
+ - MUST NOT paste the external content in, and MUST NOT replace a technical statement with a pointer
77
+ to a commercial document.
78
+
79
+ A pointer where a specification should be is the failure this rule exists to stop: the reader who
80
+ cannot open that path is left with nothing, and the reader who can is reading the wrong kind of
81
+ document.
82
+
83
+ ## How the method arrives
84
+
85
+ Method files in `.constitution/`, the `wdi-*` skills, and `_bmad/custom/*.toml` arrive from the
86
+ public WDI Method package via `npx wdi-method install` / `update`.
87
+
88
+ `.constitution/` holds **exactly two folders**, and which one a file is in decides who owns it:
89
+
90
+ | Folder | Owner | On `update` | On `promote` |
91
+ |---|---|---|---|
92
+ | `method/` | the method | **overwritten** in full | carried into the package |
93
+ | `project/` | this product | **never touched** — seeded once when absent | **never carried**, so a product's rules cannot be published |
94
+
95
+ Everything in the room is yours: `project/constitution.md` (Articles 1, 2, 5),
96
+ `project/codebase-*-guide.md` (stack, conventions, brownfield protected at **any** `status:`,
97
+ including `Draft`, which is when they are actually written), and any rule file you add.
98
+
99
+ **A file this product adds belongs in `project/`.** `.constitution/` holds two folders and nothing
100
+ else the method knows about, so a loose `.md` at its root is in a state no rule describes: `update`
101
+ leaves it (it is not the method's) and no guide names it. Migration deliberately does NOT move one —
102
+ it may already be pointed at by its current path from `AGENTS.md` or an editor rule the installer
103
+ cannot see so it prints the filename and leaves the choice to you. Either move it into `project/`
104
+ and fix those pointers, or name it from Article 2 so the next reader knows why it is there. Leaving
105
+ it unnamed is the only wrong answer.
106
+
107
+ The seam is the **folder**, never a marked region inside a generic file. `AGENTS.md` uses a marked
108
+ block because it is one file with no alternative; `.constitution/` has fifty-odd, and blocks inside
109
+ them would make every update perform surgery in every file. Prose has no merge algebra — only a path
110
+ can say, unambiguously, whose a file is.
111
+
112
+ At **read time** this repo is self-contained: every file the rules need is here, readable with the
113
+ repo alone. At **change time** the method has one published writer — the WDI Method package. Two
114
+ rules follow:
115
+
116
+ - A method file MUST NOT be invented or patched here to improve the method. If a rule is wrong, it
117
+ is fixed in the WDI Method package, then brought here with `update`.
118
+ - A rule particular to this repo MUST be written out in full, and MUST NOT be replaced by a pointer
119
+ into another repository.
120
+