bmad-method 6.0.0-alpha.1 → 6.0.0-alpha.3

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.
Files changed (48) hide show
  1. package/.claude/settings.local.json +11 -1
  2. package/README.md +115 -165
  3. package/docs/BMad-Method-V6-Quick-Start.md +341 -0
  4. package/docs/index.md +229 -0
  5. package/docs/v4-to-v6-upgrade.md +9 -7
  6. package/package.json +1 -1
  7. package/src/modules/bmb/README.md +135 -73
  8. package/src/modules/bmb/workflows/create-agent/README.md +126 -243
  9. package/src/modules/bmb/workflows/create-agent/instructions.md +25 -12
  10. package/src/modules/bmb/workflows/create-module/README.md +163 -154
  11. package/src/modules/bmb/workflows/create-workflow/instructions.md +16 -8
  12. package/src/modules/bmm/README.md +86 -83
  13. package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +45 -26
  14. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/README.md +100 -16
  15. package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +42 -23
  16. package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +42 -28
  17. package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +38 -27
  18. package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +24 -34
  19. package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +23 -34
  20. package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +30 -14
  21. package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +23 -34
  22. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +42 -24
  23. package/src/modules/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md +35 -22
  24. package/src/modules/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +73 -22
  25. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +45 -63
  26. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +46 -62
  27. package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +46 -53
  28. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +78 -47
  29. package/src/modules/bmm/workflows/4-implementation/create-story/README.md +99 -82
  30. package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +2 -0
  31. package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +3 -0
  32. package/src/modules/bmm/workflows/README.md +149 -511
  33. package/src/modules/bmm/workflows/workflow-status/README.md +38 -19
  34. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +117 -24
  35. package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +2 -2
  36. package/src/modules/bmm/workflows/workflow-status/instructions.md +173 -111
  37. package/src/modules/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +49 -0
  38. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +31 -0
  39. package/src/modules/bmm/workflows/workflow-status/workflow.yaml +3 -3
  40. package/src/modules/cis/README.md +153 -0
  41. package/src/modules/cis/workflows/README.md +102 -30
  42. package/src/modules/cis/workflows/storytelling/instructions.md +10 -2
  43. package/tools/bmad-npx-wrapper.js +10 -98
  44. package/tools/cli/installers/lib/core/manifest-generator.js +4 -1
  45. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.md +0 -30
  46. package/src/modules/cis/readme.md +0 -86
  47. /package/src/modules/bmm/sub-modules/claude-code/{readme.md → README.md} +0 -0
  48. /package/src/modules/bmm/workflows/3-solutioning/architecture/{readme.md → README.md} +0 -0
@@ -19,7 +19,7 @@ The workflow status system provides:
19
19
  workflow-status/
20
20
  ├── workflow.yaml # Main configuration
21
21
  ├── instructions.md # Status checker (99 lines)
22
- ├── workflow-status-template.md # Clean key-value template
22
+ ├── workflow-status-template.yaml # Clean YAML status template
23
23
  ├── project-levels.yaml # Source of truth for scale definitions
24
24
  └── paths/ # Modular workflow definitions
25
25
  ├── greenfield-level-0.yaml through level-4.yaml
@@ -61,25 +61,44 @@ workflow-init/
61
61
 
62
62
  ## Status File Format
63
63
 
64
- Simple key-value pairs for instant parsing:
65
-
66
- ```markdown
67
- PROJECT_NAME: MyProject
68
- PROJECT_TYPE: software
69
- PROJECT_LEVEL: 2
70
- FIELD_TYPE: greenfield
71
- CURRENT_PHASE: 2-Planning
72
- CURRENT_WORKFLOW: prd
73
- NEXT_ACTION: Continue PRD
74
- NEXT_COMMAND: prd
75
- NEXT_AGENT: pm
64
+ Clean YAML format with all workflows listed up front:
65
+
66
+ ```yaml
67
+ # generated: 2025-10-29
68
+ # project: MyProject
69
+ # project_type: software
70
+ # project_level: 2
71
+ # field_type: greenfield
72
+ # workflow_path: greenfield-level-2.yaml
73
+
74
+ workflow_status:
75
+ # Phase 1: Analysis
76
+ brainstorm-project: optional
77
+ research: optional
78
+ product-brief: recommended
79
+
80
+ # Phase 2: Planning
81
+ prd: docs/prd.md
82
+ validate-prd: optional
83
+ create-design: conditional
84
+
85
+ # Phase 3: Solutioning
86
+ create-architecture: required
87
+ validate-architecture: optional
88
+ solutioning-gate-check: required
76
89
  ```
77
90
 
78
- Any agent can instantly grep what they need:
91
+ **Status Values:**
79
92
 
80
- - Any: `grep 'NEXT_ACTION:' status.md`
81
- - Any: `grep 'CURRENT_PHASE:' status.md`
82
- - Any: `grep 'NEXT_COMMAND:' status.md`
93
+ - `required` / `optional` / `recommended` / `conditional` - Not yet started
94
+ - `{file-path}` - Completed (e.g., `docs/prd.md`)
95
+ - `skipped` - Optional workflow that was skipped
96
+
97
+ Any agent can instantly parse what they need:
98
+
99
+ - Read YAML to see all workflows and their status
100
+ - Check which workflows are completed vs pending
101
+ - Auto-detect existing work by scanning for output files
83
102
 
84
103
  ## Project Levels
85
104
 
@@ -213,10 +232,10 @@ Other workflows read the status to coordinate:
213
232
  **Phase 4 (Implementation):**
214
233
 
215
234
  - workflow-status only tracks sprint-planning completion
216
- - After sprint-planning, all story/epic tracking happens in the sprint plan output file
235
+ - After sprint-planning, all story/epic tracking happens in sprint-status.yaml
217
236
  - Phase 4 workflows do NOT read/write workflow-status (except sprint-planning for prerequisite verification)
218
237
 
219
- The status file is the single source of truth for Phases 1-3 and the hub that keeps all agents synchronized.
238
+ The workflow-status.yaml file is the single source of truth for Phases 1-3, and sprint-status.yaml takes over for Phase 4 implementation tracking.
220
239
 
221
240
  ## Benefits
222
241
 
@@ -261,36 +261,129 @@ Here's the complexity scale for reference:
261
261
  <template-output>workflow_path_file</template-output>
262
262
  </step>
263
263
 
264
- <step n="5" goal="Generate workflow summary">
265
- <action>Build workflow from loaded path file</action>
266
- <action>Display phases and workflows</action>
267
- <action>Set initial values for status file</action>
268
-
269
- <template-output>current_phase</template-output>
270
- <template-output>current_workflow</template-output>
271
- <template-output>current_agent</template-output>
272
- <template-output>next_action</template-output>
273
- <template-output>next_command</template-output>
274
- <template-output>next_agent</template-output>
264
+ <step n="5" goal="Build workflow status YAML structure">
265
+ <action>Parse the loaded workflow path file and extract all workflows</action>
266
+
267
+ <action>For each phase in the path file:
268
+
269
+ - Extract phase number and name
270
+ - Extract all workflows in that phase
271
+ - For each workflow, determine its status type:
272
+ - required: true → status = "required"
273
+ - recommended: true → status = "recommended"
274
+ - conditional: "if_has_ui" → status = "conditional"
275
+ - optional: true → status = "optional"
276
+ - Default if not specified → status = "required"
277
+ </action>
278
+
279
+ <action>Build the workflow_items list in this format:
280
+
281
+ For each phase:
282
+
283
+ 1. Add comment header: ` # Phase {n}: {Phase Name}`
284
+ 2. For each workflow in phase:
285
+ - Add entry: ` {workflow-id}: {status}`
286
+ 3. Add blank line between phases
287
+
288
+ Example structure:
289
+
290
+ ```
291
+ # Phase 1: Analysis
292
+ brainstorm-project: optional
293
+ research: optional
294
+ product-brief: recommended
295
+
296
+ # Phase 2: Planning
297
+ prd: required
298
+ validate-prd: optional
299
+ create-design: conditional
300
+ ```
301
+
302
+ </action>
303
+
304
+ <action>Scan for existing workflow output files to auto-detect completion:
305
+
306
+ For each workflow in the list, check common output locations:
307
+
308
+ - {output_folder}/brainstorm-\*.md for brainstorm-project
309
+ - {output_folder}/research-\*.md for research
310
+ - {output_folder}/product-brief.md for product-brief
311
+ - {output_folder}/prd.md for prd
312
+ - {output_folder}/ux-design.md for create-design
313
+ - {output_folder}/architecture.md for create-architecture
314
+ - {output_folder}/tech-spec.md for tech-spec
315
+ - {output_folder}/sprint-status.yaml for sprint-planning
316
+
317
+ CRITICAL: If file exists, replace status with ONLY the file path - nothing else.
318
+ Example: product-brief: docs/product-brief.md
319
+ NOT: product-brief: "completed - docs/product-brief.md" or any other text.
320
+ </action>
321
+
322
+ <template-output>workflow_items</template-output>
275
323
  </step>
276
324
 
277
- <step n="6" goal="Create status file">
278
- <action>Initialize all status values</action>
279
- <template-output>start_date</template-output>
280
- <template-output>last_updated</template-output>
281
- <template-output>phase_1_complete</template-output>
282
- <template-output>phase_2_complete</template-output>
283
- <template-output>phase_3_complete</template-output>
284
- <template-output>phase_4_complete</template-output>
325
+ <step n="6" goal="Create workflow status file">
326
+ <action>Set generated date to current date</action>
327
+ <template-output>generated</template-output>
328
+
329
+ <action>Prepare all template variables for workflow-status-template.yaml:
330
+
331
+ - generated: {current_date}
332
+ - project_name: {project_name}
333
+ - project_type: {project_type}
334
+ - project_level: {project_level}
335
+ - field_type: {field_type}
336
+ - workflow_path_file: {workflow_path_file}
337
+ - workflow_items: {workflow_items from step 5}
338
+ </action>
339
+
340
+ <action>Display a preview of what will be created:
341
+
342
+ Show the first workflow in each phase and total count:
343
+
344
+ "Ready to create workflow status tracking:
345
+
346
+ - Phase 1 ({phase_1_workflow_count} workflows): Starting with {first_workflow_phase_1}
347
+ - Phase 2 ({phase_2_workflow_count} workflows): Starting with {first_workflow_phase_2}
348
+ - Phase 3 ({phase_3_workflow_count} workflows): Starting with {first_workflow_phase_3}
349
+ - Phase 4 (Implementation tracked separately in sprint-status.yaml)
350
+
351
+ {{#if detected_completed_workflows}}
352
+ Found existing work:
353
+ {{#each detected_files}}
354
+
355
+ - {{workflow_name}}: {{file_path}}
356
+ {{/each}}
357
+ {{/if}}"
358
+ </action>
285
359
 
286
360
  <ask>Ready to create your workflow status file? (y/n)</ask>
287
361
 
288
362
  <check if="answer == y">
289
- <action>Save status file to {output_folder}/bmm-workflow-status.md</action>
290
- <output>✅ Status file created! Next up: {{next_agent}} agent, run `{{next_command}}`</output>
291
- <check if="next_agent !== current_agent">
292
- <output>It is strongly recommended to clear the context or start a new chat and load the next agent to execute the next command from that agents help menu, unless there is something else I can do for you first.</output>
293
- </check>
363
+ <action>Generate YAML from workflow-status-template.yaml with all variables</action>
364
+ <action>Save status file to {output_folder}/bmm-workflow-status.yaml</action>
365
+
366
+ <action>Identify the first non-completed workflow in the list</action>
367
+ <action>Look up that workflow's agent and command from the path file</action>
368
+
369
+ <output>✅ Workflow status file created at {output_folder}/bmm-workflow-status.yaml
370
+
371
+ **Next Steps:**
372
+
373
+ {{#if detected_completed_workflows}}
374
+ You have {{detected_count}} workflow(s) already completed. Great progress!
375
+ {{/if}}
376
+
377
+ **Next Workflow:** {{next_workflow_name}}
378
+
379
+ **Agent:** {{next_agent}}
380
+
381
+ **Command:** /bmad:bmm:workflows:{{next_workflow_id}}
382
+
383
+ {{#if next_agent !== 'pm'}}
384
+ It is recommended to start a new chat and load the {{next_agent}} agent before running the next workflow.
385
+ {{/if}}
386
+ </output>
294
387
  </check>
295
388
  </step>
296
389
 
@@ -16,13 +16,13 @@ date: system-generated
16
16
  # Workflow components
17
17
  installed_path: "{project-root}/bmad/bmm/workflows/workflow-status/init"
18
18
  instructions: "{installed_path}/instructions.md"
19
- template: "{project-root}/bmad/bmm/workflows/workflow-status/workflow-status-template.md"
19
+ template: "{project-root}/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml"
20
20
 
21
21
  # Path data files
22
22
  path_files: "{project-root}/bmad/bmm/workflows/workflow-status/paths/"
23
23
 
24
24
  # Output configuration
25
- default_output_file: "{output_folder}/bmm-workflow-status.md"
25
+ default_output_file: "{output_folder}/bmm-workflow-status.yaml"
26
26
 
27
27
  standalone: true
28
28
  web_bundle: false