bmad-plus 0.12.2 → 0.14.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/CHANGELOG.md +47 -0
- package/README.md +96 -461
- package/package.json +12 -5
- package/readme-international/README.de.md +42 -9
- package/readme-international/README.es.md +43 -10
- package/readme-international/README.fr.md +42 -9
- package/src/bmad-plus/agents/agent-orchestrator/SKILL.md +5 -3
- package/src/bmad-plus/module.yaml +270 -220
- package/src/bmad-plus/packs/pack-dev-studio/README.md +133 -141
- package/src/bmad-plus/packs/pack-dev-studio/SKILL.md +49 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/analyst-agent.md +35 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/document-project.md +59 -59
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/domain-research.md +55 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/market-research.md +58 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/prfaq.md +55 -132
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/product-brief.md +63 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/tech-writer-agent.md +54 -69
- package/src/bmad-plus/packs/pack-dev-studio/categories/analysis/technical-research.md +54 -93
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/architect-agent.md +32 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-architecture.md +67 -71
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/create-epics-stories.md +61 -90
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/generate-project-context.md +56 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/implementation-readiness.md +55 -88
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01-init.md +20 -153
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-01b-continue.md +20 -173
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-02-context.md +14 -220
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-03-starter.md +20 -329
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-04-decisions.md +15 -314
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-05-patterns.md +15 -355
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-06-structure.md +15 -375
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-07-validation.md +14 -357
- package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-08-complete.md +13 -78
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/checkpoint-preview.md +52 -65
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-01-gather-context.md +14 -81
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-02-review.md +14 -31
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-03-triage.md +14 -45
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review-steps/step-04-present.md +13 -128
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/code-review.md +61 -87
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/correct-course.md +55 -298
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/create-story.md +52 -426
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-agent.md +48 -69
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story-checklist.md +22 -80
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/dev-story.md +60 -482
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/investigate.md +50 -184
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/qa-e2e-tests.md +57 -173
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/quick-dev.md +56 -108
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/retrospective.md +54 -1509
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-planning.md +54 -296
- package/src/bmad-plus/packs/pack-dev-studio/categories/implementation/sprint-status.md +41 -283
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-prd.md +58 -18
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/create-ux-design.md +103 -72
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/edit-prd.md +55 -27
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/pm-agent.md +34 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/prd.md +46 -87
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/steps/step-01-init.md +10 -0
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/ux-designer-agent.md +30 -60
- package/src/bmad-plus/packs/pack-dev-studio/categories/planning/validate-prd.md +57 -27
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/advanced-elicitation.md +47 -138
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/adversarial-review.md +48 -34
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/bmad-help.md +51 -68
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/brainstorming.md +46 -3
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/customize.md +68 -109
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/distillator.md +53 -174
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/edge-case-hunter.md +39 -53
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-prose.md +45 -83
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/editorial-review-structure.md +45 -176
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/index-docs.md +45 -63
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/party-mode.md +53 -124
- package/src/bmad-plus/packs/pack-dev-studio/categories/utilities/shard-doc.md +44 -100
- package/src/bmad-plus/packs/pack-dev-studio/dev-studio-orchestrator.md +56 -116
- package/src/bmad-plus/packs/pack-dev-studio/shared/architecture-decision-template.md +49 -12
- package/src/bmad-plus/packs/pack-dev-studio/shared/bwml-spec.md +51 -328
- package/src/bmad-plus/packs/pack-dev-studio/shared/catalog.json +489 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/execution.md +69 -0
- package/src/bmad-plus/packs/pack-dev-studio/shared/module-help.csv +39 -32
- package/src/bmad-plus/packs/pack-dev-studio/upstream-sync.yaml +85 -14
- package/src/bmad-plus/packs/pack-memory/README.md +6 -0
- package/src/bmad-plus/packs/pack-memory/memory-orchestrator.md +12 -5
- package/src/bmad-plus/packs/pack-seo/SKILL.md +27 -1
- package/src/bmad-plus/packs/pack-seo/scripts/seo_apis.py +8 -8
- package/src/bmad-plus/packs/pack-seo/scripts/seo_fetch.py +1 -2
- package/src/bmad-plus/packs/pack-seo/scripts/seo_report.py +0 -1
- package/src/bmad-plus/packs/pack-seo/seo-chief.md +16 -1
- package/src/bmad-plus/packs/pack-seo/seo-judge.md +12 -0
- package/src/bmad-plus/packs/pack-seo/seo-scout.md +12 -0
- package/src/bmad-plus/skills/bmad-plus-autopilot/SKILL.md +4 -4
- package/src/bmad-plus/skills/bmad-plus-sync/SKILL.md +5 -3
- package/src/bmad-plus/skills/dev-studio/SKILL.md +19 -0
- package/tools/bmad-plus-npx.js +4 -2
- package/tools/build/adapters.config.js +60 -51
- package/tools/build/check-counts.js +52 -54
- package/tools/build/check-install-contract.js +450 -0
- package/tools/build/generate-adapters.js +252 -56
- package/tools/build/generate.js +364 -14
- package/tools/build/generated-adapters/.codex/AGENTS.md +20 -7
- package/tools/build/generated-adapters/.cursor/rules/bmad-plus.mdc +20 -7
- package/tools/build/generated-adapters/.opencode/AGENTS.md +20 -7
- package/tools/build/generated-adapters/AGENTS.md +20 -7
- package/tools/build/generated-adapters/CLAUDE.md +20 -7
- package/tools/build/generated-adapters/CONVENTIONS.md +20 -7
- package/tools/build/generated-adapters/GEMINI.md +20 -7
- package/tools/build/module.template.yaml +82 -0
- package/tools/build/pack-delivery.js +78 -0
- package/tools/cli/bmad-plus-cli.js +16 -1
- package/tools/cli/commands/doctor.js +49 -217
- package/tools/cli/commands/install.js +109 -164
- package/tools/cli/commands/studio.js +68 -0
- package/tools/cli/commands/uninstall.js +173 -65
- package/tools/cli/commands/update-check.js +31 -0
- package/tools/cli/commands/update-policy.js +39 -0
- package/tools/cli/commands/update.js +102 -113
- package/tools/cli/i18n.js +60 -0
- package/tools/cli/lib/ide-config.js +4 -261
- package/tools/cli/lib/install-manifest.js +17 -0
- package/tools/cli/lib/installation-health.js +360 -0
- package/tools/cli/lib/installed-adapters.js +89 -0
- package/tools/cli/lib/npm-runner.js +177 -0
- package/tools/cli/lib/pack-copy.js +62 -66
- package/tools/cli/lib/packs.js +546 -3
- package/tools/cli/lib/python-health.js +233 -0
- package/tools/cli/lib/python-provision.js +2 -2
- package/tools/cli/lib/studio.js +310 -0
- package/tools/cli/lib/update-check.js +153 -0
- package/tools/cli/lib/update-dispatch.js +182 -0
- package/tools/cli/lib/update-policy.js +90 -0
- package/tools/cli/lib/update-transaction.js +334 -0
- package/tools/release/publication-content.js +901 -0
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-07-validation.md
CHANGED
|
@@ -1,361 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Architecture compatibility guide — challenge the design
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This retained path corresponds to procedure step 7 of
|
|
4
|
+
[create-architecture](../create-architecture.md). Follow the common
|
|
5
|
+
[execution guide](../../../shared/execution.md).
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
Trace a representative success journey through the proposed interfaces. Exercise
|
|
8
|
+
a relevant failure case and any migration or restart the change requires. Compare
|
|
9
|
+
each transition with the stated invariants and component ownership.
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
- 📋 YOU ARE A FACILITATOR, not a content generator
|
|
11
|
-
- 💬 FOCUS on validating architectural coherence and completeness
|
|
12
|
-
- ✅ VALIDATE all requirements are covered by architectural decisions
|
|
13
|
-
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
|
14
|
-
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
11
|
+
Record contradictions, unspecified behavior and consequential assumptions. Use
|
|
12
|
+
bounded experiments only when useful and authorized, and retain actual outcomes.
|
|
13
|
+
A walkthrough does not prove load capacity, security or a successful deployment.
|
|
15
14
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
- ⚠️ Present A/P/C menu after generating validation results
|
|
21
|
-
- 💾 ONLY save when user chooses C (Continue)
|
|
22
|
-
- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step
|
|
23
|
-
- 🚫 FORBIDDEN to load next step until C is selected
|
|
24
|
-
|
|
25
|
-
## COLLABORATION MENUS (A/P/C):
|
|
26
|
-
|
|
27
|
-
This step will generate content and present choices:
|
|
28
|
-
|
|
29
|
-
- **A (Advanced Elicitation)**: Use discovery protocols to address complex architectural issues found during validation
|
|
30
|
-
- **P (Party Mode)**: Bring multiple perspectives to resolve validation concerns
|
|
31
|
-
- **C (Continue)**: Save the validation results and complete the architecture
|
|
32
|
-
|
|
33
|
-
## PROTOCOL INTEGRATION:
|
|
34
|
-
|
|
35
|
-
- When 'A' selected: Invoke the `bmad-advanced-elicitation` skill
|
|
36
|
-
- When 'P' selected: Invoke the `bmad-party-mode` skill
|
|
37
|
-
- PROTOCOLS always return to display this step's A/P/C menu after the A or P have completed
|
|
38
|
-
- User accepts/rejects protocol changes before proceeding
|
|
39
|
-
|
|
40
|
-
## CONTEXT BOUNDARIES:
|
|
41
|
-
|
|
42
|
-
- Complete architecture document with all sections is available
|
|
43
|
-
- All architectural decisions, patterns, and structure are defined
|
|
44
|
-
- Focus on validation, gap analysis, and coherence checking
|
|
45
|
-
- Prepare for handoff to implementation phase
|
|
46
|
-
|
|
47
|
-
## YOUR TASK:
|
|
48
|
-
|
|
49
|
-
Validate the complete architecture for coherence, completeness, and readiness to guide AI agents through consistent implementation.
|
|
50
|
-
|
|
51
|
-
## VALIDATION SEQUENCE:
|
|
52
|
-
|
|
53
|
-
### 1. Coherence Validation
|
|
54
|
-
|
|
55
|
-
Check that all architectural decisions work together:
|
|
56
|
-
|
|
57
|
-
**Decision Compatibility:**
|
|
58
|
-
|
|
59
|
-
- Do all technology choices work together without conflicts?
|
|
60
|
-
- Are all versions compatible with each other?
|
|
61
|
-
- Do patterns align with technology choices?
|
|
62
|
-
- Are there any contradictory decisions?
|
|
63
|
-
|
|
64
|
-
**Pattern Consistency:**
|
|
65
|
-
|
|
66
|
-
- Do implementation patterns support the architectural decisions?
|
|
67
|
-
- Are naming conventions consistent across all areas?
|
|
68
|
-
- Do structure patterns align with technology stack?
|
|
69
|
-
- Are communication patterns coherent?
|
|
70
|
-
|
|
71
|
-
**Structure Alignment:**
|
|
72
|
-
|
|
73
|
-
- Does the project structure support all architectural decisions?
|
|
74
|
-
- Are boundaries properly defined and respected?
|
|
75
|
-
- Does the structure enable the chosen patterns?
|
|
76
|
-
- Are integration points properly structured?
|
|
77
|
-
|
|
78
|
-
### 2. Requirements Coverage Validation
|
|
79
|
-
|
|
80
|
-
Verify all project requirements are architecturally supported:
|
|
81
|
-
|
|
82
|
-
**From Epics (if available):**
|
|
83
|
-
|
|
84
|
-
- Does every epic have architectural support?
|
|
85
|
-
- Are all user stories implementable with these decisions?
|
|
86
|
-
- Are cross-epic dependencies handled architecturally?
|
|
87
|
-
- Are there any gaps in epic coverage?
|
|
88
|
-
|
|
89
|
-
**From FR Categories (if no epics):**
|
|
90
|
-
|
|
91
|
-
- Does every functional requirement have architectural support?
|
|
92
|
-
- Are all FR categories fully covered by architectural decisions?
|
|
93
|
-
- Are cross-cutting FRs properly addressed?
|
|
94
|
-
- Are there any missing architectural capabilities?
|
|
95
|
-
|
|
96
|
-
**Non-Functional Requirements:**
|
|
97
|
-
|
|
98
|
-
- Are performance requirements addressed architecturally?
|
|
99
|
-
- Are security requirements fully covered?
|
|
100
|
-
- Are scalability considerations properly handled?
|
|
101
|
-
- Are compliance requirements architecturally supported?
|
|
102
|
-
|
|
103
|
-
### 3. Implementation Readiness Validation
|
|
104
|
-
|
|
105
|
-
Assess if AI agents can implement consistently:
|
|
106
|
-
|
|
107
|
-
**Decision Completeness:**
|
|
108
|
-
|
|
109
|
-
- Are all critical decisions documented with versions?
|
|
110
|
-
- Are implementation patterns comprehensive enough?
|
|
111
|
-
- Are consistency rules clear and enforceable?
|
|
112
|
-
- Are examples provided for all major patterns?
|
|
113
|
-
|
|
114
|
-
**Structure Completeness:**
|
|
115
|
-
|
|
116
|
-
- Is the project structure complete and specific?
|
|
117
|
-
- Are all files and directories defined?
|
|
118
|
-
- Are integration points clearly specified?
|
|
119
|
-
- Are component boundaries well-defined?
|
|
120
|
-
|
|
121
|
-
**Pattern Completeness:**
|
|
122
|
-
|
|
123
|
-
- Are all potential conflict points addressed?
|
|
124
|
-
- Are naming conventions comprehensive?
|
|
125
|
-
- Are communication patterns fully specified?
|
|
126
|
-
- Are process patterns (error handling, etc.) complete?
|
|
127
|
-
|
|
128
|
-
### 4. Gap Analysis
|
|
129
|
-
|
|
130
|
-
Identify and document any missing elements:
|
|
131
|
-
|
|
132
|
-
**Critical Gaps:**
|
|
133
|
-
|
|
134
|
-
- Missing architectural decisions that block implementation
|
|
135
|
-
- Incomplete patterns that could cause conflicts
|
|
136
|
-
- Missing structural elements needed for development
|
|
137
|
-
- Undefined integration points
|
|
138
|
-
|
|
139
|
-
**Important Gaps:**
|
|
140
|
-
|
|
141
|
-
- Areas that need more detailed specification
|
|
142
|
-
- Patterns that could be more comprehensive
|
|
143
|
-
- Documentation that would help implementation
|
|
144
|
-
- Examples that would clarify complex decisions
|
|
145
|
-
|
|
146
|
-
**Nice-to-Have Gaps:**
|
|
147
|
-
|
|
148
|
-
- Additional patterns that would be helpful
|
|
149
|
-
- Supplementary documentation
|
|
150
|
-
- Tooling recommendations
|
|
151
|
-
- Development workflow optimizations
|
|
152
|
-
|
|
153
|
-
### 5. Address Validation Issues
|
|
154
|
-
|
|
155
|
-
For any issues found, facilitate resolution:
|
|
156
|
-
|
|
157
|
-
**Critical Issues:**
|
|
158
|
-
"I found some issues that need to be addressed before implementation:
|
|
159
|
-
|
|
160
|
-
{{critical_issue_description}}
|
|
161
|
-
|
|
162
|
-
These could cause implementation problems. How would you like to resolve this?"
|
|
163
|
-
|
|
164
|
-
**Important Issues:**
|
|
165
|
-
"I noticed a few areas that could be improved:
|
|
166
|
-
|
|
167
|
-
{{important_issue_description}}
|
|
168
|
-
|
|
169
|
-
These aren't blocking, but addressing them would make implementation smoother. Should we work on these?"
|
|
170
|
-
|
|
171
|
-
**Minor Issues:**
|
|
172
|
-
"Here are some minor suggestions for improvement:
|
|
173
|
-
|
|
174
|
-
{{minor_issue_description}}
|
|
175
|
-
|
|
176
|
-
These are optional refinements. Would you like to address any of these?"
|
|
177
|
-
|
|
178
|
-
### 6. Generate Validation Content
|
|
179
|
-
|
|
180
|
-
Prepare the content to append to the document:
|
|
181
|
-
|
|
182
|
-
#### Content Structure:
|
|
183
|
-
|
|
184
|
-
```markdown
|
|
185
|
-
## Architecture Validation Results
|
|
186
|
-
|
|
187
|
-
### Coherence Validation ✅
|
|
188
|
-
|
|
189
|
-
**Decision Compatibility:**
|
|
190
|
-
{{assessment_of_how_all_decisions_work_together}}
|
|
191
|
-
|
|
192
|
-
**Pattern Consistency:**
|
|
193
|
-
{{verification_that_patterns_support_decisions}}
|
|
194
|
-
|
|
195
|
-
**Structure Alignment:**
|
|
196
|
-
{{confirmation_that_structure_supports_architecture}}
|
|
197
|
-
|
|
198
|
-
### Requirements Coverage Validation ✅
|
|
199
|
-
|
|
200
|
-
**Epic/Feature Coverage:**
|
|
201
|
-
{{verification_that_all_epics_or_features_are_supported}}
|
|
202
|
-
|
|
203
|
-
**Functional Requirements Coverage:**
|
|
204
|
-
{{confirmation_that_all_FRs_are_architecturally_supported}}
|
|
205
|
-
|
|
206
|
-
**Non-Functional Requirements Coverage:**
|
|
207
|
-
{{verification_that_NFRs_are_addressed}}
|
|
208
|
-
|
|
209
|
-
### Implementation Readiness Validation ✅
|
|
210
|
-
|
|
211
|
-
**Decision Completeness:**
|
|
212
|
-
{{assessment_of_decision_documentation_completeness}}
|
|
213
|
-
|
|
214
|
-
**Structure Completeness:**
|
|
215
|
-
{{evaluation_of_project_structure_completeness}}
|
|
216
|
-
|
|
217
|
-
**Pattern Completeness:**
|
|
218
|
-
{{verification_of_implementation_patterns_completeness}}
|
|
219
|
-
|
|
220
|
-
### Gap Analysis Results
|
|
221
|
-
|
|
222
|
-
{{gap_analysis_findings_with_priority_levels}}
|
|
223
|
-
|
|
224
|
-
### Validation Issues Addressed
|
|
225
|
-
|
|
226
|
-
{{description_of_any_issues_found_and_resolutions}}
|
|
227
|
-
|
|
228
|
-
### Architecture Completeness Checklist
|
|
229
|
-
|
|
230
|
-
Mark each item `[x]` only if validation confirms it; leave `[ ]` if it is missing, partial, or unverified. Any unchecked item must be reflected in the Gap Analysis above and in the Overall Status below.
|
|
231
|
-
|
|
232
|
-
**Requirements Analysis**
|
|
233
|
-
|
|
234
|
-
- [ ] Project context thoroughly analyzed
|
|
235
|
-
- [ ] Scale and complexity assessed
|
|
236
|
-
- [ ] Technical constraints identified
|
|
237
|
-
- [ ] Cross-cutting concerns mapped
|
|
238
|
-
|
|
239
|
-
**Architectural Decisions**
|
|
240
|
-
|
|
241
|
-
- [ ] Critical decisions documented with versions
|
|
242
|
-
- [ ] Technology stack fully specified
|
|
243
|
-
- [ ] Integration patterns defined
|
|
244
|
-
- [ ] Performance considerations addressed
|
|
245
|
-
|
|
246
|
-
**Implementation Patterns**
|
|
247
|
-
|
|
248
|
-
- [ ] Naming conventions established
|
|
249
|
-
- [ ] Structure patterns defined
|
|
250
|
-
- [ ] Communication patterns specified
|
|
251
|
-
- [ ] Process patterns documented
|
|
252
|
-
|
|
253
|
-
**Project Structure**
|
|
254
|
-
|
|
255
|
-
- [ ] Complete directory structure defined
|
|
256
|
-
- [ ] Component boundaries established
|
|
257
|
-
- [ ] Integration points mapped
|
|
258
|
-
- [ ] Requirements to structure mapping complete
|
|
259
|
-
|
|
260
|
-
### Architecture Readiness Assessment
|
|
261
|
-
|
|
262
|
-
**Overall Status:** {{READY FOR IMPLEMENTATION | READY WITH MINOR GAPS | NOT READY}} (choose READY FOR IMPLEMENTATION only when all 16 checklist items are `[x]` and no Critical Gaps remain; choose NOT READY when any Critical Gap is open or any Requirements Analysis or Architectural Decisions item is unchecked; otherwise READY WITH MINOR GAPS)
|
|
263
|
-
|
|
264
|
-
**Confidence Level:** {{high/medium/low}} based on validation results
|
|
265
|
-
|
|
266
|
-
**Key Strengths:**
|
|
267
|
-
{{list_of_architecture_strengths}}
|
|
268
|
-
|
|
269
|
-
**Areas for Future Enhancement:**
|
|
270
|
-
{{areas_that_could_be_improved_later}}
|
|
271
|
-
|
|
272
|
-
### Implementation Handoff
|
|
273
|
-
|
|
274
|
-
**AI Agent Guidelines:**
|
|
275
|
-
|
|
276
|
-
- Follow all architectural decisions exactly as documented
|
|
277
|
-
- Use implementation patterns consistently across all components
|
|
278
|
-
- Respect project structure and boundaries
|
|
279
|
-
- Refer to this document for all architectural questions
|
|
280
|
-
|
|
281
|
-
**First Implementation Priority:**
|
|
282
|
-
{{starter_template_command_or_first_architectural_step}}
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
### 7. Present Content and Menu
|
|
286
|
-
|
|
287
|
-
Show the validation results and present choices:
|
|
288
|
-
|
|
289
|
-
"I've completed a comprehensive validation of your architecture.
|
|
290
|
-
|
|
291
|
-
**Validation Summary:**
|
|
292
|
-
|
|
293
|
-
- ✅ Coherence: All decisions work together
|
|
294
|
-
- ✅ Coverage: All requirements are supported
|
|
295
|
-
- ✅ Readiness: AI agents can implement consistently
|
|
296
|
-
|
|
297
|
-
**Here's what I'll add to complete the architecture document:**
|
|
298
|
-
|
|
299
|
-
[Show the complete markdown content from step 6]
|
|
300
|
-
|
|
301
|
-
**What would you like to do?**
|
|
302
|
-
[A] Advanced Elicitation - Address any complex architectural concerns
|
|
303
|
-
[P] Party Mode - Review validation from different implementation perspectives
|
|
304
|
-
[C] Continue - Complete the architecture and finish workflow
|
|
305
|
-
|
|
306
|
-
### 8. Handle Menu Selection
|
|
307
|
-
|
|
308
|
-
#### If 'A' (Advanced Elicitation):
|
|
309
|
-
|
|
310
|
-
- Invoke the `bmad-advanced-elicitation` skill with validation issues
|
|
311
|
-
- Process enhanced solutions for complex concerns
|
|
312
|
-
- Ask user: "Accept these architectural improvements? (y/n)"
|
|
313
|
-
- If yes: Update content, then return to A/P/C menu
|
|
314
|
-
- If no: Keep original content, then return to A/P/C menu
|
|
315
|
-
|
|
316
|
-
#### If 'P' (Party Mode):
|
|
317
|
-
|
|
318
|
-
- Invoke the `bmad-party-mode` skill with validation context
|
|
319
|
-
- Process collaborative insights on implementation readiness
|
|
320
|
-
- Ask user: "Accept these changes to the validation results? (y/n)"
|
|
321
|
-
- If yes: Update content, then return to A/P/C menu
|
|
322
|
-
- If no: Keep original content, then return to A/P/C menu
|
|
323
|
-
|
|
324
|
-
#### If 'C' (Continue):
|
|
325
|
-
|
|
326
|
-
- Append the final content to `{planning_artifacts}/architecture.md`
|
|
327
|
-
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]`
|
|
328
|
-
- Load `./step-08-complete.md`
|
|
329
|
-
|
|
330
|
-
## APPEND TO DOCUMENT:
|
|
331
|
-
|
|
332
|
-
When user selects 'C', append the content directly to the document using the structure from step 6.
|
|
333
|
-
|
|
334
|
-
## SUCCESS METRICS:
|
|
335
|
-
|
|
336
|
-
✅ All architectural decisions validated for coherence
|
|
337
|
-
✅ Complete requirements coverage verified
|
|
338
|
-
✅ Implementation readiness confirmed
|
|
339
|
-
✅ All gaps identified and addressed
|
|
340
|
-
✅ Comprehensive validation checklist completed
|
|
341
|
-
✅ A/P/C menu presented and handled correctly
|
|
342
|
-
✅ Content properly appended to document when C selected
|
|
343
|
-
|
|
344
|
-
## FAILURE MODES:
|
|
345
|
-
|
|
346
|
-
❌ Skipping validation of decision compatibility
|
|
347
|
-
❌ Not verifying all requirements are architecturally supported
|
|
348
|
-
❌ Missing potential implementation conflicts
|
|
349
|
-
❌ Not addressing gaps found during validation
|
|
350
|
-
❌ Providing incomplete validation checklist
|
|
351
|
-
❌ Not presenting A/P/C menu after content generation
|
|
352
|
-
|
|
353
|
-
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
354
|
-
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
355
|
-
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
356
|
-
|
|
357
|
-
## NEXT STEP:
|
|
358
|
-
|
|
359
|
-
After user selects 'C' and content is saved to document, load `./step-08-complete.md` to complete the workflow and provide implementation guidance.
|
|
360
|
-
|
|
361
|
-
Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
|
15
|
+
This part is complete when required constraints have a consistent design or a
|
|
16
|
+
clearly named unresolved dependency, with concrete validation work identified.
|
|
17
|
+
After changed inputs, repeat the affected walkthroughs and preserve the reason
|
|
18
|
+
earlier conclusions no longer apply.
|
package/src/bmad-plus/packs/pack-dev-studio/categories/architecture/steps/step-08-complete.md
CHANGED
|
@@ -1,82 +1,17 @@
|
|
|
1
|
-
|
|
1
|
+
# Architecture compatibility guide — hand off the design
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This retained path corresponds to procedure step 8 of
|
|
4
|
+
[create-architecture](../create-architecture.md). Follow the common
|
|
5
|
+
[execution guide](../../../shared/execution.md).
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
Review the report for consistency between requirements, decisions, interfaces and
|
|
8
|
+
delivery order. Keep actual validation results separate from proposed checks.
|
|
9
|
+
Identify which decisions are accepted, provisional or superseded.
|
|
6
10
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
- 💬 FOCUS on successful workflow completion and implementation handoff
|
|
11
|
-
- 🎯 PROVIDE clear next steps for implementation phase
|
|
12
|
-
- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
|
|
13
|
-
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
11
|
+
State the first useful implementation slice, its acceptance path and any unresolved
|
|
12
|
+
prerequisite. The report may be delivered as a draft when a consequential decision
|
|
13
|
+
lacks evidence. Do not turn document completion into a claim of verified software.
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
- 🎯 Present completion summary and implementation guidance
|
|
19
|
-
- 📖 Update frontmatter with final workflow state
|
|
20
|
-
- 🚫 THIS IS THE FINAL STEP IN THIS WORKFLOW
|
|
21
|
-
|
|
22
|
-
## YOUR TASK:
|
|
23
|
-
|
|
24
|
-
Complete the architecture workflow, provide a comprehensive completion summary, and guide the user to the next phase of their project development.
|
|
25
|
-
|
|
26
|
-
## COMPLETION SEQUENCE:
|
|
27
|
-
|
|
28
|
-
### 1. Congratulate the User on Completion
|
|
29
|
-
|
|
30
|
-
Both you and the User completed something amazing here - give a summary of what you achieved together and really congratulate the user on a job well done.
|
|
31
|
-
|
|
32
|
-
### 2. Update the created document's frontmatter
|
|
33
|
-
|
|
34
|
-
```yaml
|
|
35
|
-
stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]
|
|
36
|
-
workflowType: 'architecture'
|
|
37
|
-
lastStep: 8
|
|
38
|
-
status: 'complete'
|
|
39
|
-
completedAt: '{{current_date}}'
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### 3. Next Steps Guidance
|
|
43
|
-
|
|
44
|
-
Architecture complete. Invoke the `bmad-help` skill.
|
|
45
|
-
|
|
46
|
-
Upon Completion of task output: offer to answer any questions about the Architecture Document.
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
## SUCCESS METRICS:
|
|
50
|
-
|
|
51
|
-
✅ Complete architecture document delivered with all sections
|
|
52
|
-
✅ All architectural decisions documented and validated
|
|
53
|
-
✅ Implementation patterns and consistency rules finalized
|
|
54
|
-
✅ Project structure complete with all files and directories
|
|
55
|
-
✅ User provided with clear next steps and implementation guidance
|
|
56
|
-
✅ Workflow status properly updated
|
|
57
|
-
✅ User collaboration maintained throughout completion process
|
|
58
|
-
|
|
59
|
-
## FAILURE MODES:
|
|
60
|
-
|
|
61
|
-
❌ Not providing clear implementation guidance
|
|
62
|
-
❌ Missing final validation of document completeness
|
|
63
|
-
❌ Not updating workflow status appropriately
|
|
64
|
-
❌ Failing to celebrate the successful completion
|
|
65
|
-
❌ Not providing specific next steps for the user
|
|
66
|
-
❌ Rushing completion without proper summary
|
|
67
|
-
|
|
68
|
-
❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
|
|
69
|
-
❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
|
|
70
|
-
❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
|
|
71
|
-
|
|
72
|
-
## WORKFLOW COMPLETE:
|
|
73
|
-
|
|
74
|
-
This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation.
|
|
75
|
-
|
|
76
|
-
The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle.
|
|
77
|
-
|
|
78
|
-
## On Complete
|
|
79
|
-
|
|
80
|
-
<!-- Adapted for BMAD+: original script dependency removed -->
|
|
81
|
-
|
|
82
|
-
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
|
15
|
+
Preserve human additions and provide the changed artifact locations. Continuation
|
|
16
|
+
starts by comparing current inputs with this handoff, then resumes the earliest
|
|
17
|
+
affected work. This path does not commit, publish or start another workflow.
|
|
@@ -1,68 +1,55 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
2
|
name: bmad-checkpoint-preview
|
|
3
|
-
description:
|
|
3
|
+
description: Prepare a focused walkthrough of a change with actual evidence and explicit review decisions.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# Checkpoint
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
57
|
-
|
|
58
|
-
Activation is complete. Begin the workflow below.
|
|
59
|
-
|
|
60
|
-
## Global Step Rules (apply to every step)
|
|
61
|
-
|
|
62
|
-
- **Path:line format** — Every code reference must use CWD-relative `path:line` format (no leading `/`) so it is clickable in IDE-embedded terminals (e.g., `src/auth/middleware.ts:42`).
|
|
63
|
-
- **Front-load then shut up** — Present the entire output for the current step in a single coherent message. Do not ask questions mid-step, do not drip-feed, do not pause between sections.
|
|
64
|
-
- **Language** — Speak in `{communication_language}`. Write any file output in `{document_output_language}`.
|
|
65
|
-
|
|
66
|
-
## FIRST STEP
|
|
67
|
-
|
|
68
|
-
Read fully and follow `./step-01-orientation.md` to begin.
|
|
6
|
+
# Checkpoint preview
|
|
7
|
+
|
|
8
|
+
Read the [execution guide](../../shared/execution.md) and
|
|
9
|
+
[Oholiab's role](dev-agent.md).
|
|
10
|
+
|
|
11
|
+
## Inputs
|
|
12
|
+
|
|
13
|
+
A change artifact or request identifying the work to preview. Inspect the actual
|
|
14
|
+
diff, intended behavior and available verification results. Establish the
|
|
15
|
+
revision or working-tree state the preview describes.
|
|
16
|
+
|
|
17
|
+
## Procedure
|
|
18
|
+
|
|
19
|
+
1. Identify the reviewer's decision and the changed user or system behavior.
|
|
20
|
+
Read the relevant implementation and existing checks. Separate a requested
|
|
21
|
+
walkthrough from approval to publish, merge or modify the product.
|
|
22
|
+
2. Select the few paths that best demonstrate acceptance and consequential
|
|
23
|
+
failure behavior. Explain the prior and current behavior using actual inputs
|
|
24
|
+
and outputs, not an invented demo scenario presented as executed evidence.
|
|
25
|
+
3. Prepare a reproducible local preview using the project's existing commands
|
|
26
|
+
and suitable test data. Check what those commands do before running them.
|
|
27
|
+
Execute within the task's scope and avoid exposing credentials or user data.
|
|
28
|
+
4. Inspect the preview with the host capabilities that exist. For a UI, check
|
|
29
|
+
relevant interaction, states and accessibility with an actual browser when
|
|
30
|
+
available. For a CLI or API, show observed results. If execution is unavailable,
|
|
31
|
+
provide source-backed guidance and label runtime behavior unreviewed.
|
|
32
|
+
5. Show the evidence and focus attention on meaningful decisions, tradeoffs or
|
|
33
|
+
residual uncertainty. State which acceptance criteria were exercised and which
|
|
34
|
+
remain unverified. A screenshot alone does not establish interaction behavior.
|
|
35
|
+
6. Record feedback and the resulting action. Apply follow-up changes already
|
|
36
|
+
authorized by the user, then refresh affected evidence. If an essential new
|
|
37
|
+
decision is required, preserve the preview as reviewable work while that
|
|
38
|
+
dependent action waits.
|
|
39
|
+
|
|
40
|
+
## Output and acceptance
|
|
41
|
+
|
|
42
|
+
Write the report for checkpoint-preview with baseline, review purpose, setup and
|
|
43
|
+
reproduction steps, observed before/after behavior, evidence locations, unresolved
|
|
44
|
+
checks and decisions. Include actual preview URLs only when a running or deployed
|
|
45
|
+
preview exists; state its limitations and lifetime when known.
|
|
46
|
+
|
|
47
|
+
The result is useful when another reviewer can understand the change and reproduce
|
|
48
|
+
the relevant checks. Record an actual approval only when the authorized reviewer
|
|
49
|
+
gave it; absence of feedback is not approval.
|
|
50
|
+
|
|
51
|
+
## Continue
|
|
52
|
+
|
|
53
|
+
Compare the current revision with the preview baseline. Rebuild or rerun affected
|
|
54
|
+
scenarios after changes and preserve prior feedback. Do not reuse screenshots,
|
|
55
|
+
test results or approval for behavior that changed after they were recorded.
|