bmad-readiness-check

Name: bmad-readiness-check
Author: aj-geddes

467stars73forks

How to install bmad-readiness-check?

aj-geddes/claude-code-bmad-skills/bmad-readiness-check

$npx -y skills add aj-geddes/claude-code-bmad-skills --skill bmad-readiness-check

Installs into the current project.

Summary

SOLUTIONING GATE — validates cohesion across planning artifacts before any implementation begins. Cross-references PRD (or tech-spec), architecture document, and epics/stories for coverage consistency and missing pieces. Returns a verdict of PASS, CONCERNS, or FAIL with specifics

Files · 1

View on GitHub

SKILL.md

1	# BMAD Readiness Check
2
3	"Planning ends here." This skill is the gate between Solutioning and
4	Implementation. It validates that the planning corpus is internally consistent
5	— requirements are covered by architecture, epics trace back to requirements,
6	and nothing critical is missing — before a single line of code is written.
7
8	The output is a `readiness-report.md` with a clear PASS / CONCERNS / FAIL
9	verdict and actionable specifics.
10
11	---
12
13	## Workflow
14
15	Use TodoWrite to track: Load Artifacts → Cross-Reference → Quality Checks →
16	Generate Report → Display Verdict.
17
18	---
19
20	### Step 1 — Locate Planning Artifacts
21
22	Run the bundled existence check:
23
24	```bash
25	bash "${CLAUDE_PLUGIN_ROOT}/skills/bmad-readiness-check/scripts/readiness-check.sh" <output-folder>
26	```
27
28	The script checks for required artifact files and prints a PASS / CONCERNS /
29	FAIL pre-flight verdict. Read its output; it will also print artifact paths
30	for you to load in Step 2.
31
32	Default search root is `bmad-output/` (or the user-configured `outputFolder`).
33	If the user supplies a custom path, pass it as the argument.
34
35	---
36
37	### Step 2 — Load and Parse Artifacts
38
39	Read each artifact the script located:
40
41	Requirements document (PRD or tech-spec):
42	- Extract labelled Functional Requirements (FR-001, FR-002 …) or requirement
43	bullets if not labelled.
44	- Extract Non-Functional Requirements (NFR-001 … or named sections:
45	Performance, Security, Scalability, Reliability, Maintainability).
46	- Note epic count and high-level scope statements.
47
48	Architecture document:
49	- Extract system components and their responsibilities.
50	- Locate FR traceability matrix or explicit FR-to-component mappings.
51	- Locate NFR coverage sections.
52	- Note technology stack decisions and trade-off notes.
53
54	Epics / stories (if present):
55	- Count epics and stories.
56	- For each epic, identify which PRD requirement(s) it references.
57
58	Record a baseline:
59
60	```
61	Baseline
62	- FRs found: N
63	- NFRs found: N
64	- Epics found: N (0 if Quick Flow)
65	- Stories found: N (0 if not yet decomposed)
66	```
67
68	---
69
70	### Step 3 — Cross-Reference Checks
71
72	#### 3a. FR → Architecture Coverage
73	For each FR, search the architecture document for the FR identifier AND for
74	the subject matter of the requirement. Mark:
75	- Covered — FR explicitly addressed, component assigned.
76	- Implied — subject matter covered but not explicitly linked.
77	- Missing — no evidence of coverage.
78
79	#### 3b. NFR → Architecture Coverage
80	For each NFR category, check for a dedicated architecture section or explicit
81	strategy:
82	- Performance: caching, response-time targets, async patterns.
83	- Security: auth/authz model, encryption, secrets management.
84	- Scalability: horizontal/vertical strategy, load balancing.
85	- Reliability: failover, backup, uptime targets.
86	- Others as present.
87
88	Mark each: Addressed / Partial / Missing.
89
90	#### 3c. Epic → FR Traceability (BMad Method / Enterprise tracks)
91	For each epic, verify it references at least one FR or PRD section.
92	Flag orphan epics (no traceable requirement).
93
94	#### 3d. Architecture Quality Spot-Checks
95	Verify the architecture document contains:
96	- [ ] Architectural pattern stated and justified
97	- [ ] Component responsibilities and interfaces defined
98	- [ ] Data model / entity relationships
99	- [ ] API design or service contracts
100	- [ ] Technology choices with rationale
101	- [ ] Trade-offs documented
102	- [ ] Assumptions and constraints listed
103
104	---
105
106	### Step 4 — Compute Verdict
107
108	Apply these thresholds (adapted from BMAD Method v6 gate criteria, expressed
109	as PASS / CONCERNS / FAIL):
110
111	\| Criterion \| PASS \| CONCERNS \| FAIL \|
112	\|-----------\|------\|----------\|------\|
113	\| FR coverage (covered + implied) \| ≥ 90 % \| 80–89 % \| < 80 % \|
114	\| NFR coverage (addressed + partial) \| ≥ 90 % \| 80–89 % \| < 80 % \|
115	\| Architecture quality checks \| ≥ 80 % \| 70–79 % \| < 70 % \|
116	\| Blocker issues (critical gaps) \| 0 \| have mitigation \| unmitigated \|
117	\| Epic traceability (if applicable) \| all linked \| ≥ 80 % link

People who liked this also viewed

6 picks

Type

bmad-readiness-check

467stars73forks

View on GitHub

How to install bmad-readiness-check?

aj-geddes/claude-code-bmad-skills/bmad-readiness-check

$npx -y skills add aj-geddes/claude-code-bmad-skills --skill bmad-readiness-check

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# BMAD Readiness Check
2
3	"Planning ends here." This skill is the gate between Solutioning and
4	Implementation. It validates that the planning corpus is internally consistent
5	— requirements are covered by architecture, epics trace back to requirements,
6	and nothing critical is missing — before a single line of code is written.
7
8	The output is a `readiness-report.md` with a clear PASS / CONCERNS / FAIL
9	verdict and actionable specifics.
10
11	---
12
13	## Workflow
14
15	Use TodoWrite to track: Load Artifacts → Cross-Reference → Quality Checks →
16	Generate Report → Display Verdict.
17
18	---
19
20	### Step 1 — Locate Planning Artifacts
21
22	Run the bundled existence check:
23
24	```bash
25	bash "${CLAUDE_PLUGIN_ROOT}/skills/bmad-readiness-check/scripts/readiness-check.sh" <output-folder>
26	```
27
28	The script checks for required artifact files and prints a PASS / CONCERNS /
29	FAIL pre-flight verdict. Read its output; it will also print artifact paths
30	for you to load in Step 2.
31
32	Default search root is `bmad-output/` (or the user-configured `outputFolder`).
33	If the user supplies a custom path, pass it as the argument.
34
35	---
36
37	### Step 2 — Load and Parse Artifacts
38
39	Read each artifact the script located:
40
41	Requirements document (PRD or tech-spec):
42	- Extract labelled Functional Requirements (FR-001, FR-002 …) or requirement
43	bullets if not labelled.
44	- Extract Non-Functional Requirements (NFR-001 … or named sections:
45	Performance, Security, Scalability, Reliability, Maintainability).
46	- Note epic count and high-level scope statements.
47
48	Architecture document:
49	- Extract system components and their responsibilities.
50	- Locate FR traceability matrix or explicit FR-to-component mappings.
51	- Locate NFR coverage sections.
52	- Note technology stack decisions and trade-off notes.
53
54	Epics / stories (if present):
55	- Count epics and stories.
56	- For each epic, identify which PRD requirement(s) it references.
57
58	Record a baseline:
59
60	```
61	Baseline
62	- FRs found: N
63	- NFRs found: N
64	- Epics found: N (0 if Quick Flow)
65	- Stories found: N (0 if not yet decomposed)
66	```
67
68	---
69
70	### Step 3 — Cross-Reference Checks
71
72	#### 3a. FR → Architecture Coverage
73	For each FR, search the architecture document for the FR identifier AND for
74	the subject matter of the requirement. Mark:
75	- Covered — FR explicitly addressed, component assigned.
76	- Implied — subject matter covered but not explicitly linked.
77	- Missing — no evidence of coverage.
78
79	#### 3b. NFR → Architecture Coverage
80	For each NFR category, check for a dedicated architecture section or explicit
81	strategy:
82	- Performance: caching, response-time targets, async patterns.
83	- Security: auth/authz model, encryption, secrets management.
84	- Scalability: horizontal/vertical strategy, load balancing.
85	- Reliability: failover, backup, uptime targets.
86	- Others as present.
87
88	Mark each: Addressed / Partial / Missing.
89
90	#### 3c. Epic → FR Traceability (BMad Method / Enterprise tracks)
91	For each epic, verify it references at least one FR or PRD section.
92	Flag orphan epics (no traceable requirement).
93
94	#### 3d. Architecture Quality Spot-Checks
95	Verify the architecture document contains:
96	- [ ] Architectural pattern stated and justified
97	- [ ] Component responsibilities and interfaces defined
98	- [ ] Data model / entity relationships
99	- [ ] API design or service contracts
100	- [ ] Technology choices with rationale
101	- [ ] Trade-offs documented
102	- [ ] Assumptions and constraints listed
103
104	---
105
106	### Step 4 — Compute Verdict
107
108	Apply these thresholds (adapted from BMAD Method v6 gate criteria, expressed
109	as PASS / CONCERNS / FAIL):
110
111	\| Criterion \| PASS \| CONCERNS \| FAIL \|
112	\|-----------\|------\|----------\|------\|
113	\| FR coverage (covered + implied) \| ≥ 90 % \| 80–89 % \| < 80 % \|
114	\| NFR coverage (addressed + partial) \| ≥ 90 % \| 80–89 % \| < 80 % \|
115	\| Architecture quality checks \| ≥ 80 % \| 70–79 % \| < 70 % \|
116	\| Blocker issues (critical gaps) \| 0 \| have mitigation \| unmitigated \|
117	\| Epic traceability (if applicable) \| all linked \| ≥ 80 % link

People who liked this also viewed

6 picks

Type