bmad-method 6.0.0-alpha.4 → 6.0.0-alpha.5
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/.claude/commands/bmad/bmm/agents/architect.md +0 -1
- package/.claude/commands/bmad/bmm/agents/sm.md +1 -1
- package/.claude/commands/bmad/bmm/agents/tech-writer.md +82 -0
- package/.claude/commands/bmad/bmm/workflows/README.md +1 -1
- package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +15 -0
- package/.claude/commands/bmad/core/workflows/README.md +10 -0
- package/.claude/settings.local.json +4 -8
- package/CHANGELOG.md +305 -0
- package/README.md +88 -39
- package/bmad/_cfg/agent-manifest.csv +2 -1
- package/bmad/_cfg/agents/bmm-tech-writer.customize.yaml +42 -0
- package/bmad/_cfg/files-manifest.csv +40 -62
- package/bmad/_cfg/ides/claude-code.yaml +1 -1
- package/bmad/_cfg/manifest.yaml +4 -3
- package/bmad/_cfg/task-manifest.csv +4 -1
- package/bmad/_cfg/tool-manifest.csv +1 -0
- package/bmad/_cfg/workflow-manifest.csv +3 -1
- package/bmad/bmb/config.yaml +2 -2
- package/bmad/bmb/workflows/audit-workflow/instructions.md +1 -1
- package/bmad/bmm/README.md +79 -120
- package/bmad/bmm/README.md.bak +169 -0
- package/bmad/bmm/agents/analyst.md.bak +67 -0
- package/bmad/bmm/agents/architect.md +0 -1
- package/bmad/bmm/agents/architect.md.bak +73 -0
- package/bmad/bmm/agents/dev.md.bak +69 -0
- package/bmad/bmm/agents/pm.md.bak +76 -0
- package/bmad/bmm/agents/sm.md +1 -1
- package/bmad/bmm/agents/sm.md.bak +85 -0
- package/bmad/bmm/agents/tea.md.bak +72 -0
- package/bmad/bmm/agents/tech-writer.md +82 -0
- package/bmad/bmm/agents/ux-designer.md.bak +71 -0
- package/bmad/bmm/config.yaml +2 -2
- package/bmad/bmm/docs/README.md +235 -0
- package/bmad/bmm/docs/agents-guide.md +1057 -0
- package/bmad/bmm/docs/brownfield-guide.md +471 -972
- package/bmad/bmm/docs/enterprise-agentic-development.md +680 -0
- package/bmad/bmm/docs/faq.md +589 -0
- package/bmad/bmm/docs/glossary.md +321 -0
- package/bmad/bmm/docs/party-mode.md +224 -0
- package/bmad/bmm/docs/quick-spec-flow.md +64 -57
- package/bmad/bmm/docs/quick-start.md +72 -47
- package/bmad/bmm/docs/scale-adaptive-system.md +332 -778
- package/bmad/bmm/docs/troubleshooting.md +680 -0
- package/bmad/bmm/{workflows/3-solutioning/architecture/README.md → docs/workflow-architecture-reference.md} +130 -77
- package/bmad/bmm/{workflows/document-project/README.md → docs/workflow-document-project-reference.md} +45 -2
- package/bmad/bmm/docs/workflows-analysis.md +670 -0
- package/bmad/bmm/docs/workflows-implementation.md +1758 -0
- package/bmad/bmm/docs/workflows-planning.md +1086 -0
- package/bmad/bmm/docs/workflows-solutioning.md +726 -0
- package/bmad/bmm/tasks/daily-standup.xml +1 -1
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml.bak +60 -0
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
- package/bmad/bmm/workflows/techdoc/documentation-standards.md +2 -1
- package/bmad/bmm/workflows/techdoc/documentation-standards.md.bak +238 -0
- package/bmad/bmm/workflows/workflow-status/init/instructions.md +623 -242
- package/bmad/bmm/workflows/workflow-status/init/workflow.yaml.bak +27 -0
- package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
- package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
- package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
- package/{src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
- package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
- package/bmad/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
- package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
- package/bmad/cis/agents/brainstorming-coach.md.bak +62 -0
- package/bmad/cis/agents/creative-problem-solver.md.bak +62 -0
- package/bmad/cis/agents/design-thinking-coach.md.bak +62 -0
- package/bmad/cis/agents/innovation-strategist.md.bak +62 -0
- package/bmad/cis/agents/storyteller.md.bak +59 -0
- package/bmad/cis/config.yaml +2 -2
- package/bmad/core/agents/bmad-master.md.bak +15 -13
- package/bmad/core/config.yaml +2 -2
- package/bmad/core/tasks/workflow.xml +1 -11
- package/package.json +1 -1
- package/src/core/tasks/workflow.xml +1 -11
- package/src/modules/bmb/workflows/audit-workflow/instructions.md +1 -1
- package/src/modules/bmm/README.md +1 -1
- package/src/modules/bmm/agents/architect.agent.yaml +0 -4
- package/src/modules/bmm/agents/game-dev.agent.yaml +8 -12
- package/src/modules/bmm/agents/sm.agent.yaml +1 -1
- package/src/modules/bmm/agents/{paige.agent.yaml → tech-writer.agent.yaml} +4 -4
- package/src/modules/bmm/docs/README.md +9 -9
- package/src/modules/bmm/docs/agents-guide.md +46 -98
- package/src/modules/bmm/docs/brownfield-guide.md +211 -90
- package/src/modules/bmm/docs/enterprise-agentic-development.md +380 -740
- package/src/modules/bmm/docs/faq.md +10 -10
- package/src/modules/bmm/docs/glossary.md +36 -42
- package/src/modules/bmm/docs/party-mode.md +110 -1122
- package/src/modules/bmm/docs/quick-spec-flow.md +33 -33
- package/src/modules/bmm/docs/quick-start.md +29 -29
- package/src/modules/bmm/docs/scale-adaptive-system.md +303 -453
- package/src/modules/bmm/docs/troubleshooting.md +1 -1
- package/src/modules/bmm/docs/workflows-implementation.md +20 -21
- package/src/modules/bmm/docs/workflows-solutioning.md +1 -1
- package/src/modules/bmm/tasks/daily-standup.xml +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
- package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
- package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
- package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
- package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
- package/src/modules/bmm/workflows/techdoc/documentation-standards.md +1 -1
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +623 -242
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
- package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
- package/{bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
- package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
- package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
- package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
- package/bmad/bmm/tasks/retrospective.xml +0 -104
- package/bmad/bmm/testarch/README.md +0 -311
- package/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -113
- package/bmad/bmm/workflows/1-analysis/product-brief/README.md +0 -180
- package/bmad/bmm/workflows/1-analysis/research/README.md +0 -454
- package/bmad/bmm/workflows/2-plan-workflows/README.md +0 -258
- package/bmad/bmm/workflows/3-solutioning/README.md +0 -1
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
- package/bmad/bmm/workflows/4-implementation/README.md +0 -221
- package/bmad/bmm/workflows/4-implementation/code-review/README.md +0 -69
- package/bmad/bmm/workflows/4-implementation/correct-course/README.md +0 -73
- package/bmad/bmm/workflows/4-implementation/create-story/README.md +0 -146
- package/bmad/bmm/workflows/4-implementation/dev-story/README.md +0 -206
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
- package/bmad/bmm/workflows/4-implementation/retrospective/README.md +0 -77
- package/bmad/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
- package/bmad/bmm/workflows/4-implementation/story-context/README.md +0 -234
- package/bmad/bmm/workflows/README.md +0 -256
- package/bmad/bmm/workflows/document-project/templates/README.md +0 -38
- package/bmad/bmm/workflows/testarch/README.md +0 -26
- package/bmad/bmm/workflows/testarch/atdd/README.md +0 -672
- package/bmad/bmm/workflows/testarch/automate/README.md +0 -869
- package/bmad/bmm/workflows/testarch/ci/README.md +0 -493
- package/bmad/bmm/workflows/testarch/framework/README.md +0 -340
- package/bmad/bmm/workflows/testarch/nfr-assess/README.md +0 -469
- package/bmad/bmm/workflows/testarch/test-design/README.md +0 -493
- package/bmad/bmm/workflows/testarch/test-review/README.md +0 -775
- package/bmad/bmm/workflows/testarch/trace/README.md +0 -802
- package/bmad/bmm/workflows/workflow-status/README.md +0 -260
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
- package/src/modules/bmm/docs/brownfield-guide.md.backup +0 -1324
- package/src/modules/bmm/docs/workflows-testing.md +0 -1572
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
- /package/bmad/bmm/agents/{paige.md → paige.md.bak} +0 -0
|
@@ -8,60 +8,67 @@
|
|
|
8
8
|
|
|
9
9
|
## What is Quick Spec Flow?
|
|
10
10
|
|
|
11
|
-
Quick Spec Flow is a **streamlined alternative** to the full BMad Method for
|
|
11
|
+
Quick Spec Flow is a **streamlined alternative** to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go **straight to a context-aware technical specification** and start coding.
|
|
12
12
|
|
|
13
13
|
### When to Use Quick Spec Flow
|
|
14
14
|
|
|
15
|
-
✅ **Use Quick
|
|
15
|
+
✅ **Use Quick Flow track when:**
|
|
16
16
|
|
|
17
|
-
- Single bug fix or small enhancement
|
|
18
|
-
- Small feature with
|
|
17
|
+
- Single bug fix or small enhancement
|
|
18
|
+
- Small feature with clear scope (typically 1-15 stories)
|
|
19
19
|
- Rapid prototyping or experimentation
|
|
20
20
|
- Adding to existing brownfield codebase
|
|
21
21
|
- You know exactly what you want to build
|
|
22
22
|
|
|
23
|
-
❌ **Use
|
|
23
|
+
❌ **Use BMad Method or Enterprise tracks when:**
|
|
24
24
|
|
|
25
|
-
- Building new products or major features
|
|
25
|
+
- Building new products or major features
|
|
26
26
|
- Need stakeholder alignment
|
|
27
27
|
- Complex multi-team coordination
|
|
28
28
|
- Requires extensive planning and architecture
|
|
29
29
|
|
|
30
|
-
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's
|
|
30
|
+
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs!
|
|
31
31
|
|
|
32
32
|
---
|
|
33
33
|
|
|
34
34
|
## Quick Spec Flow Overview
|
|
35
35
|
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
36
|
+
```mermaid
|
|
37
|
+
flowchart TD
|
|
38
|
+
START[Step 1: Run Tech-Spec Workflow]
|
|
39
|
+
DETECT[Detects project stack<br/>package.json, requirements.txt, etc.]
|
|
40
|
+
ANALYZE[Analyzes brownfield codebase<br/>if exists]
|
|
41
|
+
TEST[Detects test frameworks<br/>and conventions]
|
|
42
|
+
CONFIRM[Confirms conventions<br/>with you]
|
|
43
|
+
GENERATE[Generates context-rich<br/>tech-spec]
|
|
44
|
+
STORIES[Creates ready-to-implement<br/>stories]
|
|
45
|
+
|
|
46
|
+
OPTIONAL[Step 2: Optional<br/>Generate Story Context<br/>SM Agent<br/>For complex scenarios only]
|
|
47
|
+
|
|
48
|
+
IMPL[Step 3: Implement<br/>DEV Agent<br/>Code, test, commit]
|
|
49
|
+
|
|
50
|
+
DONE[DONE! 🚀]
|
|
51
|
+
|
|
52
|
+
START --> DETECT
|
|
53
|
+
DETECT --> ANALYZE
|
|
54
|
+
ANALYZE --> TEST
|
|
55
|
+
TEST --> CONFIRM
|
|
56
|
+
CONFIRM --> GENERATE
|
|
57
|
+
GENERATE --> STORIES
|
|
58
|
+
STORIES --> OPTIONAL
|
|
59
|
+
OPTIONAL -.->|Optional| IMPL
|
|
60
|
+
STORIES --> IMPL
|
|
61
|
+
IMPL --> DONE
|
|
62
|
+
|
|
63
|
+
style START fill:#bfb,stroke:#333,stroke-width:2px
|
|
64
|
+
style OPTIONAL fill:#ffb,stroke:#333,stroke-width:2px,stroke-dasharray: 5 5
|
|
65
|
+
style IMPL fill:#bbf,stroke:#333,stroke-width:2px
|
|
66
|
+
style DONE fill:#f9f,stroke:#333,stroke-width:3px
|
|
60
67
|
```
|
|
61
68
|
|
|
62
69
|
---
|
|
63
70
|
|
|
64
|
-
##
|
|
71
|
+
## Single Atomic Change
|
|
65
72
|
|
|
66
73
|
**Best for:** Bug fixes, single file changes, isolated improvements
|
|
67
74
|
|
|
@@ -97,7 +104,7 @@ DONE! 🚀
|
|
|
97
104
|
- ✅ Auto-validates quality
|
|
98
105
|
- ✅ Story context optional (tech-spec is comprehensive!)
|
|
99
106
|
|
|
100
|
-
### Example
|
|
107
|
+
### Example Single Change Scenarios
|
|
101
108
|
|
|
102
109
|
- "Fix the login validation bug"
|
|
103
110
|
- "Add email field to user registration form"
|
|
@@ -106,13 +113,13 @@ DONE! 🚀
|
|
|
106
113
|
|
|
107
114
|
---
|
|
108
115
|
|
|
109
|
-
##
|
|
116
|
+
## Coherent Small Feature
|
|
110
117
|
|
|
111
118
|
**Best for:** Small features with 2-3 related user stories
|
|
112
119
|
|
|
113
120
|
### What You Get
|
|
114
121
|
|
|
115
|
-
1. **tech-spec.md** - Same comprehensive spec as
|
|
122
|
+
1. **tech-spec.md** - Same comprehensive spec as single change projects
|
|
116
123
|
2. **epics.md** - Epic organization with story breakdown
|
|
117
124
|
3. **story-[epic-slug]-1.md** - First story
|
|
118
125
|
4. **story-[epic-slug]-2.md** - Second story
|
|
@@ -140,7 +147,7 @@ Stories are **automatically validated** to ensure proper sequence:
|
|
|
140
147
|
- ✅ Infrastructure → Features → Polish order
|
|
141
148
|
- ✅ Backend → Frontend flow
|
|
142
149
|
|
|
143
|
-
### Example
|
|
150
|
+
### Example Small Feature Scenarios
|
|
144
151
|
|
|
145
152
|
- "Add OAuth social login (Google, GitHub, Twitter)"
|
|
146
153
|
- "Build user profile page with avatar upload"
|
|
@@ -295,7 +302,7 @@ Generates scores:
|
|
|
295
302
|
- Implementation Readiness: ✅ Ready
|
|
296
303
|
```
|
|
297
304
|
|
|
298
|
-
### Story Validation (
|
|
305
|
+
### Story Validation (Multi-Story Features)
|
|
299
306
|
|
|
300
307
|
Checks:
|
|
301
308
|
|
|
@@ -310,7 +317,7 @@ Checks:
|
|
|
310
317
|
|
|
311
318
|
## Complete User Journey
|
|
312
319
|
|
|
313
|
-
### Scenario 1: Bug Fix (
|
|
320
|
+
### Scenario 1: Bug Fix (Single Change)
|
|
314
321
|
|
|
315
322
|
**Goal:** Fix login validation bug
|
|
316
323
|
|
|
@@ -335,7 +342,7 @@ Checks:
|
|
|
335
342
|
|
|
336
343
|
---
|
|
337
344
|
|
|
338
|
-
### Scenario 2: Small Feature (
|
|
345
|
+
### Scenario 2: Small Feature (Multi-Story)
|
|
339
346
|
|
|
340
347
|
**Goal:** Add OAuth social login (Google, GitHub)
|
|
341
348
|
|
|
@@ -385,7 +392,7 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
|
|
385
392
|
### sprint-planning (SM Agent)
|
|
386
393
|
|
|
387
394
|
- ✅ Works with epics.md from tech-spec
|
|
388
|
-
- ✅ Organizes
|
|
395
|
+
- ✅ Organizes multi-story features for coordinated implementation
|
|
389
396
|
- ✅ Tracks progress through sprint-status.yaml
|
|
390
397
|
|
|
391
398
|
### dev-story (DEV Agent)
|
|
@@ -398,7 +405,7 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
|
|
398
405
|
|
|
399
406
|
## Comparison: Quick Spec vs Full BMM
|
|
400
407
|
|
|
401
|
-
| Aspect | Quick
|
|
408
|
+
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
|
402
409
|
| --------------------- | ---------------------------- | ---------------------------------- |
|
|
403
410
|
| **Setup** | None (standalone) | workflow-init recommended |
|
|
404
411
|
| **Planning Docs** | tech-spec.md only | Product Brief → PRD → Architecture |
|
|
@@ -412,18 +419,18 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
|
|
412
419
|
|
|
413
420
|
---
|
|
414
421
|
|
|
415
|
-
## When to Graduate from Quick
|
|
422
|
+
## When to Graduate from Quick Flow to BMad Method
|
|
416
423
|
|
|
417
|
-
Start with Quick
|
|
424
|
+
Start with Quick Flow, but switch to BMad Method when:
|
|
418
425
|
|
|
419
|
-
- ❌ Project grows beyond
|
|
426
|
+
- ❌ Project grows beyond initial scope
|
|
420
427
|
- ❌ Multiple teams need coordination
|
|
421
428
|
- ❌ Stakeholders need formal documentation
|
|
422
429
|
- ❌ Product vision is unclear
|
|
423
430
|
- ❌ Architectural decisions need deep analysis
|
|
424
431
|
- ❌ Compliance/regulatory requirements exist
|
|
425
432
|
|
|
426
|
-
💡 **Tip:** You can always run `workflow-init` later to transition from Quick
|
|
433
|
+
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
|
427
434
|
|
|
428
435
|
---
|
|
429
436
|
|
|
@@ -459,8 +466,8 @@ Start with Quick Spec, but switch to Full BMM when:
|
|
|
459
466
|
|
|
460
467
|
### 🎯 **Focus**
|
|
461
468
|
|
|
462
|
-
-
|
|
463
|
-
-
|
|
469
|
+
- Single atomic changes
|
|
470
|
+
- Coherent small features
|
|
464
471
|
- No scope creep
|
|
465
472
|
- Fast iteration
|
|
466
473
|
|
|
@@ -493,7 +500,7 @@ Start with Quick Spec, but switch to Full BMM when:
|
|
|
493
500
|
|
|
494
501
|
Quick Spec Flow is **fully standalone**:
|
|
495
502
|
|
|
496
|
-
- Detects if
|
|
503
|
+
- Detects if it's a single change or multi-story feature
|
|
497
504
|
- Asks for greenfield vs brownfield
|
|
498
505
|
- Works without status file tracking
|
|
499
506
|
- Perfect for rapid prototyping
|
|
@@ -518,13 +525,13 @@ Quick Spec Flow is **fully standalone**:
|
|
|
518
525
|
|
|
519
526
|
**A:** Absolutely! Quick Spec Flow captures UX/UI considerations, component changes, and accessibility requirements.
|
|
520
527
|
|
|
521
|
-
### Q: What if my
|
|
528
|
+
### Q: What if my Quick Flow project grows?
|
|
522
529
|
|
|
523
|
-
**A:** No problem! You can always transition to
|
|
530
|
+
**A:** No problem! You can always transition to BMad Method by running workflow-init and create-prd. Your tech-spec becomes input for the PRD.
|
|
524
531
|
|
|
525
532
|
### Q: Do I need story-context for every story?
|
|
526
533
|
|
|
527
|
-
**A:** Usually no! Tech-spec is comprehensive enough for most
|
|
534
|
+
**A:** Usually no! Tech-spec is comprehensive enough for most Quick Flow projects. Only use story-context for complex edge cases.
|
|
528
535
|
|
|
529
536
|
### Q: Can I skip validation?
|
|
530
537
|
|
|
@@ -559,13 +566,13 @@ When validation runs, read the scores. They tell you if your spec is production-
|
|
|
559
566
|
|
|
560
567
|
### 5. **Story Context is Optional**
|
|
561
568
|
|
|
562
|
-
For
|
|
569
|
+
For single changes, try going directly to dev-story first. Only add story-context if you hit complexity.
|
|
563
570
|
|
|
564
|
-
### 6. **Keep
|
|
571
|
+
### 6. **Keep Single Changes Truly Atomic**
|
|
565
572
|
|
|
566
|
-
If your "single change" needs 3+ files, it might be
|
|
573
|
+
If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you.
|
|
567
574
|
|
|
568
|
-
### 7. **Validate Story Sequence for
|
|
575
|
+
### 7. **Validate Story Sequence for Multi-Story Features**
|
|
569
576
|
|
|
570
577
|
When you get multiple stories, check the dependency validation output. Proper sequence matters!
|
|
571
578
|
|
|
@@ -573,7 +580,7 @@ When you get multiple stories, check the dependency validation output. Proper se
|
|
|
573
580
|
|
|
574
581
|
## Real-World Examples
|
|
575
582
|
|
|
576
|
-
### Example 1: Adding Logging (
|
|
583
|
+
### Example 1: Adding Logging (Single Change)
|
|
577
584
|
|
|
578
585
|
**Input:** "Add structured logging to payment processing"
|
|
579
586
|
|
|
@@ -589,7 +596,7 @@ When you get multiple stories, check the dependency validation output. Proper se
|
|
|
589
596
|
|
|
590
597
|
---
|
|
591
598
|
|
|
592
|
-
### Example 2: Search Feature (
|
|
599
|
+
### Example 2: Search Feature (Multi-Story)
|
|
593
600
|
|
|
594
601
|
**Input:** "Add search to product catalog with filters"
|
|
595
602
|
|
|
@@ -19,7 +19,7 @@ BMad Method (BMM) helps you build software through guided workflows with special
|
|
|
19
19
|
|
|
20
20
|
1. **Phase 1: Analysis** (Optional) - Brainstorming, Research, Product Brief
|
|
21
21
|
2. **Phase 2: Planning** (Required) - Create your requirements (tech-spec or PRD)
|
|
22
|
-
3. **Phase 3:
|
|
22
|
+
3. **Phase 3: Solutioning** (Track-dependent) - Design the architecture for BMad Method and Enterprise tracks
|
|
23
23
|
4. **Phase 4: Implementation** (Required) - Build your software Epic by Epic, Story by Story
|
|
24
24
|
|
|
25
25
|
## Installation
|
|
@@ -54,28 +54,28 @@ During workflow-init, you'll describe:
|
|
|
54
54
|
- Whether there's an existing codebase or this is a new project
|
|
55
55
|
- The general size and complexity (you can adjust this later)
|
|
56
56
|
|
|
57
|
-
####
|
|
57
|
+
#### Planning Tracks
|
|
58
58
|
|
|
59
|
-
Based on your description, the workflow will suggest a
|
|
59
|
+
Based on your description, the workflow will suggest a track and let you choose from:
|
|
60
60
|
|
|
61
|
-
**
|
|
61
|
+
**Three Planning Tracks:**
|
|
62
62
|
|
|
63
|
-
- **
|
|
64
|
-
- **
|
|
65
|
-
- **
|
|
66
|
-
|
|
67
|
-
|
|
63
|
+
- **Quick Flow** - Fast implementation (tech-spec only) - bug fixes, simple features, clear scope (typically 1-15 stories)
|
|
64
|
+
- **BMad Method** - Full planning (PRD + Architecture + UX) - products, platforms, complex features (typically 10-50+ stories)
|
|
65
|
+
- **Enterprise Method** - Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance, multi-tenant (typically 30+ stories)
|
|
66
|
+
|
|
67
|
+
**Note**: Story counts are guidance, not definitions. Tracks are chosen based on planning needs, not story math.
|
|
68
68
|
|
|
69
69
|
#### What gets created?
|
|
70
70
|
|
|
71
|
-
Once you confirm your
|
|
71
|
+
Once you confirm your track, the `bmm-workflow-status.yaml` file will be created in your project's docs folder (assuming default install location). This file tracks your progress through all phases.
|
|
72
72
|
|
|
73
73
|
**Important notes:**
|
|
74
74
|
|
|
75
|
-
- Every
|
|
75
|
+
- Every track has different paths through the phases
|
|
76
76
|
- Story counts can still change based on overall complexity as you work
|
|
77
|
-
- For this guide, we'll assume a
|
|
78
|
-
- This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for
|
|
77
|
+
- For this guide, we'll assume a BMad Method track project
|
|
78
|
+
- This workflow will guide you through Phase 1 (optional), Phase 2 (required), and Phase 3 (required for BMad Method and Enterprise tracks)
|
|
79
79
|
|
|
80
80
|
### Step 2: Work Through Phases 1-3
|
|
81
81
|
|
|
@@ -100,12 +100,12 @@ Phase 1 (Analysis) is entirely optional. All workflows are optional or recommend
|
|
|
100
100
|
The next TRULY REQUIRED step is:
|
|
101
101
|
- PRD (Product Requirements Document) in Phase 2 - Planning
|
|
102
102
|
- Agent: pm
|
|
103
|
-
- Command:
|
|
103
|
+
- Command: prd
|
|
104
104
|
```
|
|
105
105
|
|
|
106
106
|
#### How to Run Workflows in Phases 1-3
|
|
107
107
|
|
|
108
|
-
When an agent tells you to run a workflow (like
|
|
108
|
+
When an agent tells you to run a workflow (like `prd`):
|
|
109
109
|
|
|
110
110
|
1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](../docs/ide-info/) for your IDE's specific instructions
|
|
111
111
|
2. **Wait for the menu** to appear
|
|
@@ -121,21 +121,21 @@ The agents in V6 are very good with fuzzy menu matching!
|
|
|
121
121
|
For v4 users or those who prefer to skip workflow-status guidance:
|
|
122
122
|
|
|
123
123
|
- **Analyst** → Brainstorming, Product Brief
|
|
124
|
-
- **PM** → PRD (
|
|
124
|
+
- **PM** → PRD (BMad Method/Enterprise tracks) OR tech-spec (Quick Flow track)
|
|
125
125
|
- **UX-Designer** → UX Design Document (if UI-heavy)
|
|
126
|
-
- **Architect** → Architecture (
|
|
126
|
+
- **Architect** → Architecture (BMad Method/Enterprise tracks)
|
|
127
127
|
|
|
128
128
|
#### Phase 2: Planning - Creating the PRD
|
|
129
129
|
|
|
130
|
-
**For
|
|
130
|
+
**For BMad Method and Enterprise tracks:**
|
|
131
131
|
|
|
132
132
|
1. Load the **PM agent** in a new chat
|
|
133
133
|
2. Tell it to run the PRD workflow
|
|
134
|
-
3. Once complete, you'll have
|
|
134
|
+
3. Once complete, you'll have:
|
|
135
135
|
- **PRD.md** - Your Product Requirements Document
|
|
136
|
-
-
|
|
136
|
+
- Epic breakdown
|
|
137
137
|
|
|
138
|
-
**For
|
|
138
|
+
**For Quick Flow track:**
|
|
139
139
|
|
|
140
140
|
- Use **tech-spec** instead of PRD (no architecture needed)
|
|
141
141
|
|
|
@@ -149,7 +149,7 @@ If your project has a user interface:
|
|
|
149
149
|
|
|
150
150
|
#### Phase 3: Architecture
|
|
151
151
|
|
|
152
|
-
**For
|
|
152
|
+
**For BMad Method and Enterprise tracks:**
|
|
153
153
|
|
|
154
154
|
1. Load the **Architect agent** in a new chat
|
|
155
155
|
2. Tell it to run the create-architecture workflow
|
|
@@ -261,7 +261,7 @@ The agent creates documents, asks questions, and helps you make decisions throug
|
|
|
261
261
|
|
|
262
262
|
BMad creates two files to track your progress:
|
|
263
263
|
|
|
264
|
-
**1. bmm-workflow-status.
|
|
264
|
+
**1. bmm-workflow-status.yaml**
|
|
265
265
|
|
|
266
266
|
- Shows which phase you're in and what's next
|
|
267
267
|
- Created by workflow-init
|
|
@@ -280,28 +280,59 @@ BMad creates two files to track your progress:
|
|
|
280
280
|
|
|
281
281
|
## The Complete Flow Visualized
|
|
282
282
|
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
283
|
+
```mermaid
|
|
284
|
+
flowchart LR
|
|
285
|
+
subgraph P1["Phase 1 (Optional)<br/>Analysis"]
|
|
286
|
+
direction TB
|
|
287
|
+
A1[Brainstorm]
|
|
288
|
+
A2[Research]
|
|
289
|
+
A3[Brief]
|
|
290
|
+
A4[Analyst]
|
|
291
|
+
A1 ~~~ A2 ~~~ A3 ~~~ A4
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
subgraph P2["Phase 2 (Required)<br/>Planning"]
|
|
295
|
+
direction TB
|
|
296
|
+
B1[Quick Flow:<br/>tech-spec]
|
|
297
|
+
B2[Method/Enterprise:<br/>PRD]
|
|
298
|
+
B3[UX opt]
|
|
299
|
+
B4[PM, UX]
|
|
300
|
+
B1 ~~~ B2 ~~~ B3 ~~~ B4
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
subgraph P3["Phase 3 (Track-dependent)<br/>Solutioning"]
|
|
304
|
+
direction TB
|
|
305
|
+
C1[Method/Enterprise:<br/>architecture]
|
|
306
|
+
C2[gate-check]
|
|
307
|
+
C3[Architect]
|
|
308
|
+
C1 ~~~ C2 ~~~ C3
|
|
309
|
+
end
|
|
310
|
+
|
|
311
|
+
subgraph P4["Phase 4 (Required)<br/>Implementation"]
|
|
312
|
+
direction TB
|
|
313
|
+
D1[Per Epic:<br/>epic context]
|
|
314
|
+
D2[Per Story:<br/>create-story]
|
|
315
|
+
D3[story-context]
|
|
316
|
+
D4[dev-story]
|
|
317
|
+
D5[code-review]
|
|
318
|
+
D6[SM, DEV]
|
|
319
|
+
D1 ~~~ D2 ~~~ D3 ~~~ D4 ~~~ D5 ~~~ D6
|
|
320
|
+
end
|
|
321
|
+
|
|
322
|
+
P1 --> P2
|
|
323
|
+
P2 --> P3
|
|
324
|
+
P3 --> P4
|
|
325
|
+
|
|
326
|
+
style P1 fill:#bbf,stroke:#333,stroke-width:2px
|
|
327
|
+
style P2 fill:#bfb,stroke:#333,stroke-width:2px
|
|
328
|
+
style P3 fill:#ffb,stroke:#333,stroke-width:2px
|
|
329
|
+
style P4 fill:#fbf,stroke:#333,stroke-width:2px
|
|
299
330
|
```
|
|
300
331
|
|
|
301
332
|
## Common Questions
|
|
302
333
|
|
|
303
334
|
**Q: Do I always need architecture?**
|
|
304
|
-
A: Only for
|
|
335
|
+
A: Only for BMad Method and Enterprise tracks. Quick Flow projects skip straight from tech-spec to implementation.
|
|
305
336
|
|
|
306
337
|
**Q: Can I change my plan later?**
|
|
307
338
|
A: Yes! The SM agent has a "correct-course" workflow for handling scope changes.
|
|
@@ -328,14 +359,8 @@ A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directl
|
|
|
328
359
|
|
|
329
360
|
✅ **Always use fresh chats** - Load agents in new chats for each workflow to avoid context issues
|
|
330
361
|
✅ **Let workflow-status guide you** - Load any agent and ask for status when unsure what's next
|
|
331
|
-
✅ **
|
|
362
|
+
✅ **Track matters** - Quick Flow uses tech-spec, BMad Method/Enterprise need PRD and architecture
|
|
332
363
|
✅ **Tracking is automatic** - The status files update themselves, no manual editing needed
|
|
333
364
|
✅ **Agents are flexible** - Use menu numbers, shortcuts (\*prd), or natural language
|
|
334
365
|
|
|
335
366
|
**Ready to start building?** Install BMad, load the Analyst, run workflow-init, and let the agents guide you!
|
|
336
|
-
|
|
337
|
-
---
|
|
338
|
-
|
|
339
|
-
**Version**: v6-alpha
|
|
340
|
-
**Last Updated**: 2025-01
|
|
341
|
-
**For detailed documentation**: [Complete BMM Workflows Guide](../src/modules/bmm/workflows/README.md)
|