wdi-method 0.5.4 → 0.5.9
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/bin/wdi-method.js +17 -0
- package/kit/.constitution/method/README.md +5 -3
- package/kit/.constitution/method/document/architecture-guide.md +209 -209
- package/kit/.constitution/method/document/corpus-guide.md +2 -2
- package/kit/.constitution/method/document/sdd-guide.md +3 -2
- package/kit/.constitution/method/document/templates/architecture-spine.md +100 -100
- package/kit/.constitution/method/document/templates/inventory.md +2 -2
- package/kit/.constitution/method/document/templates/sdd.md +1 -1
- package/kit/.constitution/method/document/templates/srs.md +149 -149
- package/kit/.constitution/method/document/templates/uc.md +69 -69
- package/kit/.constitution/method/scripts/inventory.py +99 -293
- package/kit/.constitution/method/scripts/validate.py +1676 -1648
- package/kit/.constitution/method/why/portability.md +7 -0
- package/kit/.constitution/project/README.md +8 -0
- package/kit/.constitution/project/inventory-readers.py +85 -0
- package/kit/skills/wdi-blueprint/SKILL.md +203 -203
- package/kit/skills/wdi-build/SKILL.md +4 -2
- package/kit/skills/wdi-init/SKILL.md +38 -4
- package/kit/skills/wdi-log/SKILL.md +107 -107
- package/kit/skills/wdi-report/SKILL.md +6 -6
- package/kit-overlay/README.md +5 -3
- package/kit-overlay/portability.md +7 -0
- package/package.json +1 -1
- package/scaffold/.control/registry/decisions.yaml +3 -3
|
@@ -1,107 +1,107 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: wdi-log
|
|
3
|
-
description: Use when a fact from outside the code has to be recorded — a meeting that finished, or a non-technical fact that constrains what may be built. Two intents, meeting and fact. Routes decisions and open questions to their own skills.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# WDI Log
|
|
7
|
-
|
|
8
|
-
Free of stage and free of role. Two intents, because both record **a fact that came from outside the code** and
|
|
9
|
-
neither belongs to any gate.
|
|
10
|
-
|
|
11
|
-
| Intent | Owns | Home |
|
|
12
|
-
|---|---|---|
|
|
13
|
-
| `meeting` | What a meeting decided and left open | `.control/meetings/YYYY-MM-DD-<slug>.md` |
|
|
14
|
-
| `fact` | A non-technical fact that constrains what may be built, used, or promised | `.control/project-non-technical-log.md` |
|
|
15
|
-
|
|
16
|
-
They share a shape and a failure mode: both are tempting places to record something that belongs somewhere with
|
|
17
|
-
an owner. Neither MAY absorb a decision or an open question.
|
|
18
|
-
|
|
19
|
-
## Intent `meeting`
|
|
20
|
-
|
|
21
|
-
### What the note MUST carry
|
|
22
|
-
|
|
23
|
-
| Section | Content |
|
|
24
|
-
|---|---|
|
|
25
|
-
| Attendees and date | Who was actually there, not who was invited |
|
|
26
|
-
| What was decided | Each decision as one sentence, stated as what now holds |
|
|
27
|
-
| What was left open | Each unresolved item, with who can resolve it |
|
|
28
|
-
| Action items | Grouped by role, each with an owner |
|
|
29
|
-
| `## DEC` | Links to the decisions this meeting produced — filled after `wdi-decision` runs |
|
|
30
|
-
|
|
31
|
-
The `## DEC` back-link makes the trail run both ways. Minutes whose decisions have no `DEC-`, and a `DEC-` with
|
|
32
|
-
no minutes behind it, are both traceability gaps the audit surfaces later at a worse time.
|
|
33
|
-
|
|
34
|
-
### Rules
|
|
35
|
-
|
|
36
|
-
- It MUST NOT write the decision itself. That goes to `wdi-decision` intent `open`, which numbers it globally.
|
|
37
|
-
Minutes say what was **discussed**; a `DEC-` says what was **chosen** and what it cost.
|
|
38
|
-
- It MUST NOT write to `.what/` or `.how/`. A meeting changes documents only through `wdi-decision` intent
|
|
39
|
-
`apply`.
|
|
40
|
-
- It MUST NOT record an open question only in the note. Those go to `wdi-question`, so they land in one of four
|
|
41
|
-
lists rather than scattered across meetings nobody rereads.
|
|
42
|
-
- Record what was decided, not what was discussed. A transcript is not minutes, and nobody rereads one.
|
|
43
|
-
- A decision recorded with no owner and no consequence MUST be treated as an open question instead. "We agreed
|
|
44
|
-
to look into it" is not a decision.
|
|
45
|
-
- Client commitments MUST be recorded verbatim where the wording matters. Paraphrasing a commitment is how a
|
|
46
|
-
scope dispute starts.
|
|
47
|
-
|
|
48
|
-
## Intent `fact`
|
|
49
|
-
|
|
50
|
-
`.control/project-non-technical-log.md` is the authority on **what may be recorded** — its content boundary, its
|
|
51
|
-
closed category list, and the table of facts belonging to another home. Read it before acting; this skill MUST
|
|
52
|
-
NOT restate those rules and MUST NOT override them. What this skill owns is **how** the file is read and written.
|
|
53
|
-
|
|
54
|
-
### Looking one up
|
|
55
|
-
|
|
56
|
-
1. Read the
|
|
57
|
-
last week reads as current when only its row is seen.
|
|
58
|
-
2. Check
|
|
59
|
-
3. If the answer is absent, **say it is absent.** You MUST NOT infer a fact from a commit message, from
|
|
60
|
-
`.control/memlog/`, or from a sibling repo and report it as recorded — those are leads for registering, not
|
|
61
|
-
answers.
|
|
62
|
-
|
|
63
|
-
An entry marked `[
|
|
64
|
-
fact.
|
|
65
|
-
|
|
66
|
-
### Registering one
|
|
67
|
-
|
|
68
|
-
1. Apply the log's content boundary first. A fact that fails it is refused here and MUST NOT be softened to fit —
|
|
69
|
-
say which rule refused it and where it belongs.
|
|
70
|
-
2. **Route before writing.** If the fact is a decision expensive to reverse, an open question, a meeting outcome,
|
|
71
|
-
a domain term, or an infrastructure asset detail, its own skill or repo runs first. A row here MAY then hold
|
|
72
|
-
only the consequence for this product, pointing at that home.
|
|
73
|
-
3. Assign the next `NT-NNN` from the highest id ever used, including retired ones. An id MUST NOT be reused.
|
|
74
|
-
4. Fill every column. `
|
|
75
|
-
`
|
|
76
|
-
5. A fact whose source is hearsay MUST be written with `[
|
|
77
|
-
`wdi-question` in the same run. Recording it and leaving it unowned is the failure this step exists to stop.
|
|
78
|
-
|
|
79
|
-
**One fact, one row.** A single event producing several facts — a domain bought, and a launch date it makes
|
|
80
|
-
possible — MUST become several rows, because they stop holding at different times.
|
|
81
|
-
|
|
82
|
-
### Updating one
|
|
83
|
-
|
|
84
|
-
A fact that changed is **never** edited in place, and its row is never deleted.
|
|
85
|
-
|
|
86
|
-
1. Move the old row to
|
|
87
|
-
id.
|
|
88
|
-
2. Register the new fact as a fresh `NT-NNN`.
|
|
89
|
-
3. Follow the old row's `
|
|
90
|
-
behind that still assumes it; that document MUST be raised, and if it sits under an `applied` decision, routed
|
|
91
|
-
to `wdi-decision` intent `apply`.
|
|
92
|
-
|
|
93
|
-
Correcting a typo or a wrong `
|
|
94
|
-
|
|
95
|
-
## Rules
|
|
96
|
-
|
|
97
|
-
- Terms MUST match `.control/product-glossary.md`. A note that coins a new domain noun MUST propose it through
|
|
98
|
-
`wdi-blueprint`, not leave two words meaning the same thing.
|
|
99
|
-
- This skill MUST NOT write any file other than the two it owns. Every other file it touches is reached through
|
|
100
|
-
the skill that owns it.
|
|
101
|
-
- `.control/structure-document.md` MUST NOT be edited to reflect a new entry — it maps folders, not rows, and
|
|
102
|
-
`wdi-init` intent `structure` re-derives it.
|
|
103
|
-
|
|
104
|
-
## Output
|
|
105
|
-
|
|
106
|
-
Intent taken · what was recorded, in one line · what was **routed** rather than recorded, and to which skill ·
|
|
107
|
-
for `fact`, the `NT-` id and what its `
|
|
1
|
+
---
|
|
2
|
+
name: wdi-log
|
|
3
|
+
description: Use when a fact from outside the code has to be recorded — a meeting that finished, or a non-technical fact that constrains what may be built. Two intents, meeting and fact. Routes decisions and open questions to their own skills.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# WDI Log
|
|
7
|
+
|
|
8
|
+
Free of stage and free of role. Two intents, because both record **a fact that came from outside the code** and
|
|
9
|
+
neither belongs to any gate.
|
|
10
|
+
|
|
11
|
+
| Intent | Owns | Home |
|
|
12
|
+
|---|---|---|
|
|
13
|
+
| `meeting` | What a meeting decided and left open | `.control/meetings/YYYY-MM-DD-<slug>.md` |
|
|
14
|
+
| `fact` | A non-technical fact that constrains what may be built, used, or promised | `.control/project-non-technical-log.md` |
|
|
15
|
+
|
|
16
|
+
They share a shape and a failure mode: both are tempting places to record something that belongs somewhere with
|
|
17
|
+
an owner. Neither MAY absorb a decision or an open question.
|
|
18
|
+
|
|
19
|
+
## Intent `meeting`
|
|
20
|
+
|
|
21
|
+
### What the note MUST carry
|
|
22
|
+
|
|
23
|
+
| Section | Content |
|
|
24
|
+
|---|---|
|
|
25
|
+
| Attendees and date | Who was actually there, not who was invited |
|
|
26
|
+
| What was decided | Each decision as one sentence, stated as what now holds |
|
|
27
|
+
| What was left open | Each unresolved item, with who can resolve it |
|
|
28
|
+
| Action items | Grouped by role, each with an owner |
|
|
29
|
+
| `## DEC` | Links to the decisions this meeting produced — filled after `wdi-decision` runs |
|
|
30
|
+
|
|
31
|
+
The `## DEC` back-link makes the trail run both ways. Minutes whose decisions have no `DEC-`, and a `DEC-` with
|
|
32
|
+
no minutes behind it, are both traceability gaps the audit surfaces later at a worse time.
|
|
33
|
+
|
|
34
|
+
### Rules
|
|
35
|
+
|
|
36
|
+
- It MUST NOT write the decision itself. That goes to `wdi-decision` intent `open`, which numbers it globally.
|
|
37
|
+
Minutes say what was **discussed**; a `DEC-` says what was **chosen** and what it cost.
|
|
38
|
+
- It MUST NOT write to `.what/` or `.how/`. A meeting changes documents only through `wdi-decision` intent
|
|
39
|
+
`apply`.
|
|
40
|
+
- It MUST NOT record an open question only in the note. Those go to `wdi-question`, so they land in one of four
|
|
41
|
+
lists rather than scattered across meetings nobody rereads.
|
|
42
|
+
- Record what was decided, not what was discussed. A transcript is not minutes, and nobody rereads one.
|
|
43
|
+
- A decision recorded with no owner and no consequence MUST be treated as an open question instead. "We agreed
|
|
44
|
+
to look into it" is not a decision.
|
|
45
|
+
- Client commitments MUST be recorded verbatim where the wording matters. Paraphrasing a commitment is how a
|
|
46
|
+
scope dispute starts.
|
|
47
|
+
|
|
48
|
+
## Intent `fact`
|
|
49
|
+
|
|
50
|
+
`.control/project-non-technical-log.md` is the authority on **what may be recorded** — its content boundary, its
|
|
51
|
+
closed category list, and the table of facts belonging to another home. Read it before acting; this skill MUST
|
|
52
|
+
NOT restate those rules and MUST NOT override them. What this skill owns is **how** the file is read and written.
|
|
53
|
+
|
|
54
|
+
### Looking one up
|
|
55
|
+
|
|
56
|
+
1. Read the In force table in full. It is short by design and MUST NOT be sampled with grep alone — a fact retired
|
|
57
|
+
last week reads as current when only its row is seen.
|
|
58
|
+
2. Check No longer in force for the same subject. A superseded entry names its replacement.
|
|
59
|
+
3. If the answer is absent, **say it is absent.** You MUST NOT infer a fact from a commit message, from
|
|
60
|
+
`.control/memlog/`, or from a sibling repo and report it as recorded — those are leads for registering, not
|
|
61
|
+
answers.
|
|
62
|
+
|
|
63
|
+
An entry marked `[UNCONFIRMED]` MUST be reported with that tag attached, never flattened into a plain
|
|
64
|
+
fact.
|
|
65
|
+
|
|
66
|
+
### Registering one
|
|
67
|
+
|
|
68
|
+
1. Apply the log's content boundary first. A fact that fails it is refused here and MUST NOT be softened to fit —
|
|
69
|
+
say which rule refused it and where it belongs.
|
|
70
|
+
2. **Route before writing.** If the fact is a decision expensive to reverse, an open question, a meeting outcome,
|
|
71
|
+
a domain term, or an infrastructure asset detail, its own skill or repo runs first. A row here MAY then hold
|
|
72
|
+
only the consequence for this product, pointing at that home.
|
|
73
|
+
3. Assign the next `NT-NNN` from the highest id ever used, including retired ones. An id MUST NOT be reused.
|
|
74
|
+
4. Fill every column. `Effect` MUST name something in this repo — a gate, an `FR`, a prerequisite, a file.
|
|
75
|
+
`Source` MUST name a person, a repo and path, or another entry id.
|
|
76
|
+
5. A fact whose source is hearsay MUST be written with `[UNCONFIRMED]` **and** filed through
|
|
77
|
+
`wdi-question` in the same run. Recording it and leaving it unowned is the failure this step exists to stop.
|
|
78
|
+
|
|
79
|
+
**One fact, one row.** A single event producing several facts — a domain bought, and a launch date it makes
|
|
80
|
+
possible — MUST become several rows, because they stop holding at different times.
|
|
81
|
+
|
|
82
|
+
### Updating one
|
|
83
|
+
|
|
84
|
+
A fact that changed is **never** edited in place, and its row is never deleted.
|
|
85
|
+
|
|
86
|
+
1. Move the old row to No longer in force, filling `Stopped holding` with the date and `Superseded by` with the new
|
|
87
|
+
id.
|
|
88
|
+
2. Register the new fact as a fresh `NT-NNN`.
|
|
89
|
+
3. Follow the old row's `Effect` and check whatever it named. A fact that stops holding usually leaves a document
|
|
90
|
+
behind that still assumes it; that document MUST be raised, and if it sits under an `applied` decision, routed
|
|
91
|
+
to `wdi-decision` intent `apply`.
|
|
92
|
+
|
|
93
|
+
Correcting a typo or a wrong `Source` is not an update in this sense and MAY be edited in place.
|
|
94
|
+
|
|
95
|
+
## Rules
|
|
96
|
+
|
|
97
|
+
- Terms MUST match `.control/product-glossary.md`. A note that coins a new domain noun MUST propose it through
|
|
98
|
+
`wdi-blueprint`, not leave two words meaning the same thing.
|
|
99
|
+
- This skill MUST NOT write any file other than the two it owns. Every other file it touches is reached through
|
|
100
|
+
the skill that owns it.
|
|
101
|
+
- `.control/structure-document.md` MUST NOT be edited to reflect a new entry — it maps folders, not rows, and
|
|
102
|
+
`wdi-init` intent `structure` re-derives it.
|
|
103
|
+
|
|
104
|
+
## Output
|
|
105
|
+
|
|
106
|
+
Intent taken · what was recorded, in one line · what was **routed** rather than recorded, and to which skill ·
|
|
107
|
+
for `fact`, the `NT-` id and what its `Effect` names.
|
|
@@ -89,7 +89,7 @@ A published report is **frozen**. It states what was true on a date, exactly lik
|
|
|
89
89
|
overwrite one (exit 4) rather than trusting anyone to remember.
|
|
90
90
|
|
|
91
91
|
- You MUST NOT edit a published report. If it was wrong, the next report says so.
|
|
92
|
-
- The `##
|
|
92
|
+
- The `## Note` block is the one part a person writes, once, at publish time, before the commit.
|
|
93
93
|
- Commentary MUST cite rather than restate: a slip has a cause, and that cause already lives in a `DEC-`, an
|
|
94
94
|
`OQ-`, a risk, or a defect.
|
|
95
95
|
|
|
@@ -144,11 +144,11 @@ is the ideal shape of a wave and because an `FR` has had a proof of done since b
|
|
|
144
144
|
| `FR` | Its id |
|
|
145
145
|
| Epic | The Product Component |
|
|
146
146
|
| `mode` | That component's depth — this is what makes document load visible |
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
|
|
|
150
|
-
|
|
|
151
|
-
|
|
|
147
|
+
| Exposure | `risk_accepted` + `risk_note` |
|
|
148
|
+
| Effort | Mandays, derived from the parent `CAP`'s `estimate_mandays`, divided among its `FR` |
|
|
149
|
+
| Priority | From the `CAP` |
|
|
150
|
+
| Depends on | From `depends_on` |
|
|
151
|
+
| Release | The `CAP`'s `target_release` |
|
|
152
152
|
|
|
153
153
|
## Step 4 — Say what it is, and what it is not
|
|
154
154
|
|
package/kit-overlay/README.md
CHANGED
|
@@ -68,6 +68,8 @@ used to reject a change.
|
|
|
68
68
|
## `scripts/`
|
|
69
69
|
|
|
70
70
|
`validate.py` — registry gates and the `.control/generated/` generator. `timeline.py` — the time
|
|
71
|
-
dimension from git history. `inventory.py` —
|
|
72
|
-
|
|
73
|
-
|
|
71
|
+
dimension from git history. `inventory.py` — compares the three inventories against the code
|
|
72
|
+
and reports the difference; it MUST NOT patch either side into agreement. It reads no code itself:
|
|
73
|
+
the patterns live in `../project/inventory-readers.py`, because comparing is generic and reading a
|
|
74
|
+
stack is not. That file ships as a skeleton and `wdi-init` intent `readers` writes it for the repo
|
|
75
|
+
in front of it. All three run through `uv run`.
|
|
@@ -31,6 +31,12 @@ them only an *example* does — not a rule.
|
|
|
31
31
|
Everything else — the five gates, the two fields, the fifteen skills, the templates, `validate.py`,
|
|
32
32
|
`inventory.py`, `../method-glossary.md`, and the three files beside this one — carries without edit.
|
|
33
33
|
|
|
34
|
+
One half-exception, and it is by design: `inventory.py` is the generic engine and carries whole, but
|
|
35
|
+
it reads no code itself. The three readers live in `../../project/inventory-readers.py`, which ships
|
|
36
|
+
as a skeleton and belongs to the product. A new project runs `wdi-init` intent `readers` once and
|
|
37
|
+
rewrites that file, nothing else. No example ships, deliberately — an example is a guess about a
|
|
38
|
+
stack nobody here has seen.
|
|
39
|
+
|
|
34
40
|
## What does NOT travel
|
|
35
41
|
|
|
36
42
|
| Stays behind | Why |
|
|
@@ -38,6 +44,7 @@ Everything else — the five gates, the two fields, the fifteen skills, the temp
|
|
|
38
44
|
| `.control/` | This product's state. A new project scaffolds its own through `wdi-init` intent `setup`, or receives empty stubs on first `install` |
|
|
39
45
|
| `.what/` · `.how/` | This product's promises and build |
|
|
40
46
|
| `.constitution/project/codebase-*-guide.md` | Written by the **project**, not the method. They ship as empty `Draft` stubs |
|
|
47
|
+
| `.constitution/project/inventory-readers.py` | How THIS product's code is read. Seeded as a SKELETON — no patterns and no stack. `wdi-init` intent `readers` writes it against the repo in front of it |
|
|
41
48
|
| `_bmad-output/` | Run workspace |
|
|
42
49
|
| The `bmad-*` skills themselves | BMad's, installed by BMad. Only `_bmad/custom/*.toml` is ours |
|
|
43
50
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# decisions.yaml — SSOT
|
|
1
|
+
# decisions.yaml — SSOT for `DEC-` decisions
|
|
2
2
|
#
|
|
3
|
-
#
|
|
4
|
-
#
|
|
3
|
+
# Numbering is GLOBAL. `status`: draft | accepted | applied | superseded | rejected.
|
|
4
|
+
# A decision FREEZES at `applied`, not at `accepted`.
|
|
5
5
|
|
|
6
6
|
decisions: []
|