wdi-method 0.4.6 → 0.5.0
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/README.md +264 -252
- package/bin/wdi-method.js +1121 -1030
- package/kit/.constitution/method/README.md +66 -169
- package/kit/.constitution/{constitution.md → method/constitution.md} +10 -56
- package/kit/.constitution/{document → method/document}/architecture-guide.md +1 -1
- package/kit/.constitution/{document → method/document}/corpus-guide.md +2 -2
- package/kit/.constitution/{document → method/document}/delivery-flow-guide.md +338 -338
- package/kit/.constitution/{document → method/document}/sdd-guide.md +1 -1
- package/kit/.constitution/{document → method/document}/templates/cross-cutting.md +1 -1
- package/kit/.constitution/{document → method/document}/templates/design-system.md +67 -67
- package/kit/.constitution/{document → method/document}/templates/inventory.md +69 -69
- package/kit/.constitution/{document → method/document}/templates/sdd.md +1 -1
- package/kit/.constitution/{document → method/document}/templates/structure-codebase.md +129 -129
- package/kit/.constitution/{document → method/document}/templates/structure-document.md +90 -90
- package/kit/.constitution/{language-guide.md → method/language-guide.md} +2 -2
- package/kit/.constitution/{repo-guide.md → method/repo-guide.md} +16 -3
- package/kit/.constitution/{scripts → method/scripts}/timeline.py +2 -2
- package/kit/.constitution/{scripts → method/scripts}/validate.py +1599 -1581
- package/kit/.constitution/{structure-guide.md → method/structure-guide.md} +3 -3
- package/kit/.constitution/method/why/README.md +169 -0
- package/kit/.constitution/method/{artifact-map.md → why/artifact-map.md} +5 -5
- package/kit/.constitution/method/{rationale.md → why/rationale.md} +5 -5
- package/kit/.constitution/project/constitution.md +63 -0
- package/kit/assets/bmad-custom/bmad-advanced-elicitation.toml +15 -15
- package/kit/assets/bmad-custom/bmad-architecture.toml +33 -33
- package/kit/assets/bmad-custom/bmad-code-review.toml +13 -13
- package/kit/assets/bmad-custom/bmad-correct-course.toml +28 -28
- package/kit/assets/bmad-custom/bmad-prd.toml +42 -42
- package/kit/assets/bmad-custom/bmad-product-brief.toml +34 -34
- package/kit/assets/bmad-custom/bmad-retrospective.toml +9 -9
- package/kit/assets/bmad-custom/bmad-spec.toml +16 -16
- package/kit/assets/bmad-custom/bmad-ux.toml +19 -19
- package/kit/skills/wdi-blueprint/SKILL.md +3 -3
- package/kit/skills/wdi-build/SKILL.md +244 -244
- package/kit/skills/wdi-component/SKILL.md +1 -1
- package/kit/skills/wdi-help/SKILL.md +98 -98
- package/kit/skills/wdi-init/SKILL.md +1 -1
- package/kit/skills/wdi-problem/SKILL.md +90 -90
- package/kit/skills/wdi-product/SKILL.md +127 -127
- package/kit/skills/wdi-reconcile/SKILL.md +2 -2
- package/kit/skills/wdi-report/SKILL.md +205 -205
- package/kit/skills/wdi-systematic-debugging/SKILL.md +193 -193
- package/kit/skills/wdi-ux/SKILL.md +145 -145
- package/kit-overlay/AGENTS.md +20 -20
- package/kit-overlay/README.md +24 -17
- package/kit-overlay/constitution.md +10 -56
- package/kit-overlay/portability.md +6 -6
- package/kit-overlay/repo-guide.md +112 -97
- package/package.json +37 -37
- package/kit/.constitution/README.md +0 -66
- /package/kit/.constitution/{document → method/document}/bmad-guide.md +0 -0
- /package/kit/.constitution/{document → method/document}/bmad-skill-register.md +0 -0
- /package/kit/.constitution/{document → method/document}/brief-guide.md +0 -0
- /package/kit/.constitution/{document → method/document}/decision-guide.md +0 -0
- /package/kit/.constitution/{document → method/document}/prd-guide.md +0 -0
- /package/kit/.constitution/{document → method/document}/srs-guide.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/addendum.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/architecture-spine.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/brief.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/c4.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/contract.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/decision.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/flow.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/integration.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/lc.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/lifecycle.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/meeting.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/model.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/oq.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/prd.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/questions.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/rtr.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/rules.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/scn.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/srs.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/uc.md +0 -0
- /package/kit/.constitution/{document → method/document}/templates/ux.md +0 -0
- /package/kit/.constitution/{document → method/document}/ux-guide.md +0 -0
- /package/kit/.constitution/{method-glossary.md → method/method-glossary.md} +0 -0
- /package/kit/.constitution/{scripts → method/scripts}/inventory.py +0 -0
- /package/kit/.constitution/method/{portability.md → why/portability.md} +0 -0
- /package/kit/.constitution/{codebase/brownfield-guide.md → project/codebase-brownfield-guide.md} +0 -0
- /package/kit/.constitution/{codebase/conventions-guide.md → project/codebase-conventions-guide.md} +0 -0
- /package/kit/.constitution/{codebase/stack-guide.md → project/codebase-stack-guide.md} +0 -0
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
# Class A — writes straight into the corpus.
|
|
2
|
-
# Singleton: one product, one brief, across releases. A second product MUST get its own repo.
|
|
3
|
-
#
|
|
4
|
-
# Called through `wdi-problem`, never directly. The override here decides where the artifact
|
|
5
|
-
# lands; the wrapper skill checks its content.
|
|
6
|
-
|
|
7
|
-
[workflow]
|
|
8
|
-
|
|
9
|
-
brief_template = "{project-root}/.constitution/document/templates/brief.md"
|
|
10
|
-
|
|
11
|
-
# run_folder_pattern MUST be constant — no {project_name}, no {date}.
|
|
12
|
-
# That is what forces the singleton: every run lands in the same folder, so a second run is
|
|
13
|
-
# detected as a resume/update, not a sibling folder.
|
|
14
|
-
# The result is .what/_product-brief/brief.md and .what/_product-brief/addendum.md; both
|
|
15
|
-
# filenames are hardcoded in SKILL.md and cannot be configured.
|
|
16
|
-
brief_output_path = "{project-root}/.what"
|
|
17
|
-
run_folder_pattern = "_product-brief"
|
|
18
|
-
|
|
19
|
-
# Append-only against the default `skill:bmad-review lenses=structure,prose`.
|
|
20
|
-
doc_standards = ["file:{project-root}/.constitution/document/brief-guide.md"]
|
|
21
|
-
|
|
22
|
-
persistent_facts = [
|
|
23
|
-
"Every memlog.py call — init, append, set, and the read on resume or intent Update — MUST use --path {project-root}/.control/memlog/brief.md. --workspace MUST NOT be used; it would place a .memlog.md inside .what/, and no memlog is allowed to live in the corpus.",
|
|
24
|
-
|
|
25
|
-
"The brief template opens with permission to drop a section that does not fit. That permission MUST NOT apply to the eight mandatory sections: The Problem, Who This Serves, Goals, Success Criteria, Scope In, Scope Out, Constraints, Assumptions — plus Prerequisites. Other template sections MAY be dropped.",
|
|
26
|
-
|
|
27
|
-
"Goals MUST be numbered BG-1, BG-2, and so on. They MUST NOT be numbered G1, G2 — G1 through G5 are the names of this method's five gates, and BG is the first link in the BG -> CAP -> FR/NFR -> UC -> Story -> Test traceability chain.",
|
|
28
|
-
|
|
29
|
-
"The Who This Serves table MUST carry exactly one row marked primary, and MUST cover every stakeholder including one who never opens the product.",
|
|
30
|
-
|
|
31
|
-
"The brief MUST NOT carry a Product Component list, and MUST NOT fill product_components or logical_components. The slicing is born at the TAIL of G2 through wdi-init intent `component`, read from the brief plus every PRD.",
|
|
32
|
-
|
|
33
|
-
"Output from research, brainstorming, forge, and PRFAQ MUST stay in _bmad-output/. It MUST NOT be folded into the brief and MUST NOT be promoted into .what/; a `DEC-` or PRD references it by path. That run folder MUST NOT be deleted — intent Update reads it back as original inputs.",
|
|
34
|
-
]
|
|
1
|
+
# Class A — writes straight into the corpus.
|
|
2
|
+
# Singleton: one product, one brief, across releases. A second product MUST get its own repo.
|
|
3
|
+
#
|
|
4
|
+
# Called through `wdi-problem`, never directly. The override here decides where the artifact
|
|
5
|
+
# lands; the wrapper skill checks its content.
|
|
6
|
+
|
|
7
|
+
[workflow]
|
|
8
|
+
|
|
9
|
+
brief_template = "{project-root}/.constitution/method/document/templates/brief.md"
|
|
10
|
+
|
|
11
|
+
# run_folder_pattern MUST be constant — no {project_name}, no {date}.
|
|
12
|
+
# That is what forces the singleton: every run lands in the same folder, so a second run is
|
|
13
|
+
# detected as a resume/update, not a sibling folder.
|
|
14
|
+
# The result is .what/_product-brief/brief.md and .what/_product-brief/addendum.md; both
|
|
15
|
+
# filenames are hardcoded in SKILL.md and cannot be configured.
|
|
16
|
+
brief_output_path = "{project-root}/.what"
|
|
17
|
+
run_folder_pattern = "_product-brief"
|
|
18
|
+
|
|
19
|
+
# Append-only against the default `skill:bmad-review lenses=structure,prose`.
|
|
20
|
+
doc_standards = ["file:{project-root}/.constitution/method/document/brief-guide.md"]
|
|
21
|
+
|
|
22
|
+
persistent_facts = [
|
|
23
|
+
"Every memlog.py call — init, append, set, and the read on resume or intent Update — MUST use --path {project-root}/.control/memlog/brief.md. --workspace MUST NOT be used; it would place a .memlog.md inside .what/, and no memlog is allowed to live in the corpus.",
|
|
24
|
+
|
|
25
|
+
"The brief template opens with permission to drop a section that does not fit. That permission MUST NOT apply to the eight mandatory sections: The Problem, Who This Serves, Goals, Success Criteria, Scope In, Scope Out, Constraints, Assumptions — plus Prerequisites. Other template sections MAY be dropped.",
|
|
26
|
+
|
|
27
|
+
"Goals MUST be numbered BG-1, BG-2, and so on. They MUST NOT be numbered G1, G2 — G1 through G5 are the names of this method's five gates, and BG is the first link in the BG -> CAP -> FR/NFR -> UC -> Story -> Test traceability chain.",
|
|
28
|
+
|
|
29
|
+
"The Who This Serves table MUST carry exactly one row marked primary, and MUST cover every stakeholder including one who never opens the product.",
|
|
30
|
+
|
|
31
|
+
"The brief MUST NOT carry a Product Component list, and MUST NOT fill product_components or logical_components. The slicing is born at the TAIL of G2 through wdi-init intent `component`, read from the brief plus every PRD.",
|
|
32
|
+
|
|
33
|
+
"Output from research, brainstorming, forge, and PRFAQ MUST stay in _bmad-output/. It MUST NOT be folded into the brief and MUST NOT be promoted into .what/; a `DEC-` or PRD references it by path. That run folder MUST NOT be deleted — intent Update reads it back as original inputs.",
|
|
34
|
+
]
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# Runs in stories mode: reads SPEC.md + stories.yaml + stories/<id>-*.md, not
|
|
2
|
-
# sprint-status.yaml. Its output is RETROSPECTIVE.md inside the spec folder — which is ephemeral.
|
|
3
|
-
|
|
4
|
-
[workflow]
|
|
5
|
-
|
|
6
|
-
persistent_facts = [
|
|
7
|
-
"This repo runs in stories mode. RETROSPECTIVE.md MUST be archived as RTR-<wave> in .control/reports/ by wdi-build before the wave closes. It is REQUIRED on a wave `L` and advisory on `S` and `M` — V19 is tied to wave size, not to `mode`, and skipping it MUST be stated rather than left silent.",
|
|
8
|
-
"Every row of the distillation table in .constitution/document/bmad-guide.md MUST be complete before a wave is declared closed.",
|
|
9
|
-
]
|
|
1
|
+
# Runs in stories mode: reads SPEC.md + stories.yaml + stories/<id>-*.md, not
|
|
2
|
+
# sprint-status.yaml. Its output is RETROSPECTIVE.md inside the spec folder — which is ephemeral.
|
|
3
|
+
|
|
4
|
+
[workflow]
|
|
5
|
+
|
|
6
|
+
persistent_facts = [
|
|
7
|
+
"This repo runs in stories mode. RETROSPECTIVE.md MUST be archived as RTR-<wave> in .control/reports/ by wdi-build before the wave closes. It is REQUIRED on a wave `L` and advisory on `S` and `M` — V19 is tied to wave size, not to `mode`, and skipping it MUST be stated rather than left silent.",
|
|
8
|
+
"Every row of the distillation table in .constitution/method/document/bmad-guide.md MUST be complete before a wave is declared closed.",
|
|
9
|
+
]
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
# Class C — one run per (wave x Product Component), spent once G5 closes.
|
|
2
|
-
#
|
|
3
|
-
# The slug decides whether a spec is ephemeral or lives on: the same slug lands in the same
|
|
4
|
-
# folder and keeps its capability ID. A slug per-PC alone would turn SPEC.md into a living
|
|
5
|
-
# document per PC — a direct rival to the SRS. The slug w<N>-<pc> keeps the spec ephemeral, and
|
|
6
|
-
# CAP-N stays sound because it is allocated from the registry, not from BMad's own internal
|
|
7
|
-
# mechanism.
|
|
8
|
-
|
|
9
|
-
[workflow]
|
|
10
|
-
|
|
11
|
-
persistent_facts = [
|
|
12
|
-
"A spec slug MUST take the shape w<N>-<pc>, one run per (wave x Product Component) pair.",
|
|
13
|
-
"SPEC.md MUST NOT carry anything that did not come from the SRS, SDD, or PRD. A new finding MUST be landed in the corpus by the skill that owns that layer — the ownership table in .constitution/document/corpus-guide.md — before the wave closes, never left sitting in the spec.",
|
|
14
|
-
"CAP-N MUST be allocated from {project-root}/.control/registry/requirements.yaml.",
|
|
15
|
-
"file:{project-root}/.control/product-glossary.md",
|
|
16
|
-
]
|
|
1
|
+
# Class C — one run per (wave x Product Component), spent once G5 closes.
|
|
2
|
+
#
|
|
3
|
+
# The slug decides whether a spec is ephemeral or lives on: the same slug lands in the same
|
|
4
|
+
# folder and keeps its capability ID. A slug per-PC alone would turn SPEC.md into a living
|
|
5
|
+
# document per PC — a direct rival to the SRS. The slug w<N>-<pc> keeps the spec ephemeral, and
|
|
6
|
+
# CAP-N stays sound because it is allocated from the registry, not from BMad's own internal
|
|
7
|
+
# mechanism.
|
|
8
|
+
|
|
9
|
+
[workflow]
|
|
10
|
+
|
|
11
|
+
persistent_facts = [
|
|
12
|
+
"A spec slug MUST take the shape w<N>-<pc>, one run per (wave x Product Component) pair.",
|
|
13
|
+
"SPEC.md MUST NOT carry anything that did not come from the SRS, SDD, or PRD. A new finding MUST be landed in the corpus by the skill that owns that layer — the ownership table in .constitution/method/document/corpus-guide.md — before the wave closes, never left sitting in the spec.",
|
|
14
|
+
"CAP-N MUST be allocated from {project-root}/.control/registry/requirements.yaml.",
|
|
15
|
+
"file:{project-root}/.control/product-glossary.md",
|
|
16
|
+
]
|
|
@@ -1,19 +1,19 @@
|
|
|
1
|
-
# Class B — the path is configurable, per-PC granularity is not.
|
|
2
|
-
#
|
|
3
|
-
# bmad-ux only knows {project_name} and {date}, no {slug}, so it cannot land directly into
|
|
4
|
-
# .how/<pc>/. Its landing zone is made NEUTRAL in _bmad-output/ because its output splits across
|
|
5
|
-
# two layers: DESIGN.md belongs to .how/, EXPERIENCE.md belongs to .what/. Landing in either one
|
|
6
|
-
# first would be a layer violation that lives for the length of one run.
|
|
7
|
-
|
|
8
|
-
[workflow]
|
|
9
|
-
|
|
10
|
-
ux_output_path = "{project-root}/_bmad-output/ux"
|
|
11
|
-
run_folder_pattern = "ux"
|
|
12
|
-
|
|
13
|
-
doc_standards = ["file:{project-root}/.constitution/document/ux-guide.md"]
|
|
14
|
-
|
|
15
|
-
persistent_facts = [
|
|
16
|
-
"Every memlog.py call MUST use --path {project-root}/.control/memlog/ux.md. --workspace MUST NOT be used.",
|
|
17
|
-
]
|
|
18
|
-
|
|
19
|
-
on_complete = "Hand the landing to wdi-ux: DESIGN.md to .how/<pc>/01-ux/, tokens and base components to .how/_platform/design-system.md, EXPERIENCE.md to .what/<pc>/04-usecases/, every screen registered as an LC ui-screen in components.yaml. MUST NOT land itself."
|
|
1
|
+
# Class B — the path is configurable, per-PC granularity is not.
|
|
2
|
+
#
|
|
3
|
+
# bmad-ux only knows {project_name} and {date}, no {slug}, so it cannot land directly into
|
|
4
|
+
# .how/<pc>/. Its landing zone is made NEUTRAL in _bmad-output/ because its output splits across
|
|
5
|
+
# two layers: DESIGN.md belongs to .how/, EXPERIENCE.md belongs to .what/. Landing in either one
|
|
6
|
+
# first would be a layer violation that lives for the length of one run.
|
|
7
|
+
|
|
8
|
+
[workflow]
|
|
9
|
+
|
|
10
|
+
ux_output_path = "{project-root}/_bmad-output/ux"
|
|
11
|
+
run_folder_pattern = "ux"
|
|
12
|
+
|
|
13
|
+
doc_standards = ["file:{project-root}/.constitution/method/document/ux-guide.md"]
|
|
14
|
+
|
|
15
|
+
persistent_facts = [
|
|
16
|
+
"Every memlog.py call MUST use --path {project-root}/.control/memlog/ux.md. --workspace MUST NOT be used.",
|
|
17
|
+
]
|
|
18
|
+
|
|
19
|
+
on_complete = "Hand the landing to wdi-ux: DESIGN.md to .how/<pc>/01-ux/, tokens and base components to .how/_platform/design-system.md, EXPERIENCE.md to .what/<pc>/04-usecases/, every screen registered as an LC ui-screen in components.yaml. MUST NOT land itself."
|
|
@@ -32,7 +32,7 @@ of that is `wdi-component` at G4. You MUST NOT write a promise; when the bluepri
|
|
|
32
32
|
| `.control/product-glossary.md` | Terms already fixed |
|
|
33
33
|
| `.control/decisions/` | `accepted` and `applied` decisions an `AD-N` usually sits behind |
|
|
34
34
|
| `src/` · `web/` | What actually runs, when this is not a new project |
|
|
35
|
-
| `.constitution/document/srs-guide.md` · `architecture-guide.md` | The rules the result is checked against |
|
|
35
|
+
| `.constitution/method/document/srs-guide.md` · `architecture-guide.md` | The rules the result is checked against |
|
|
36
36
|
|
|
37
37
|
## Step 1 — Position
|
|
38
38
|
|
|
@@ -65,7 +65,7 @@ whose nouns nobody defined.
|
|
|
65
65
|
the count passes a third of a component's use cases, derive it again — `delivery-flow-guide.md` owns the rule
|
|
66
66
|
and it MUST NOT be negotiated.
|
|
67
67
|
|
|
68
|
-
**A method term MUST NOT be written into `.constitution/method-glossary.md`.** A product term binds one
|
|
68
|
+
**A method term MUST NOT be written into `.constitution/method/method-glossary.md`.** A product term binds one
|
|
69
69
|
project; a method term binds every project the method is installed in. Raise it as a proposal, state where it
|
|
70
70
|
appeared and why the existing vocabulary does not cover it, and hand it to the owner.
|
|
71
71
|
|
|
@@ -152,7 +152,7 @@ copy inside any SDD.
|
|
|
152
152
|
| State | How each is born |
|
|
153
153
|
|---|---|
|
|
154
154
|
| No code yet | Written as a **plan** — the tables, endpoints, and screens intended. Nothing can be derived, because there is no source |
|
|
155
|
-
| Code exists | **Derived first** by `.constitution/scripts/inventory.py` — migrations for tables, route registration for endpoints, pages for screens — then compared with the plan. The difference is a **finding**, not hand work |
|
|
155
|
+
| Code exists | **Derived first** by `.constitution/method/scripts/inventory.py` — migrations for tables, route registration for endpoints, pages for screens — then compared with the plan. The difference is a **finding**, not hand work |
|
|
156
156
|
|
|
157
157
|
An inventory MUST NOT be assembled from a README or from route names that look plausible. Numbers are stable:
|
|
158
158
|
a new row takes the next number, never a renumber.
|