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.
- package/.claude/settings.local.json +11 -1
- package/README.md +115 -165
- package/docs/BMad-Method-V6-Quick-Start.md +341 -0
- package/docs/index.md +229 -0
- package/docs/v4-to-v6-upgrade.md +9 -7
- package/package.json +1 -1
- package/src/modules/bmb/README.md +135 -73
- package/src/modules/bmb/workflows/create-agent/README.md +126 -243
- package/src/modules/bmb/workflows/create-agent/instructions.md +25 -12
- package/src/modules/bmb/workflows/create-module/README.md +163 -154
- package/src/modules/bmb/workflows/create-workflow/instructions.md +16 -8
- package/src/modules/bmm/README.md +86 -83
- package/src/modules/bmm/workflows/1-analysis/brainstorm-game/instructions.md +45 -26
- package/src/modules/bmm/workflows/1-analysis/brainstorm-project/README.md +100 -16
- package/src/modules/bmm/workflows/1-analysis/brainstorm-project/instructions.md +42 -23
- package/src/modules/bmm/workflows/1-analysis/game-brief/instructions.md +42 -28
- package/src/modules/bmm/workflows/1-analysis/product-brief/instructions.md +38 -27
- package/src/modules/bmm/workflows/1-analysis/research/instructions-deep-prompt.md +24 -34
- package/src/modules/bmm/workflows/1-analysis/research/instructions-market.md +23 -34
- package/src/modules/bmm/workflows/1-analysis/research/instructions-router.md +30 -14
- package/src/modules/bmm/workflows/1-analysis/research/instructions-technical.md +23 -34
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +42 -24
- package/src/modules/bmm/workflows/2-plan-workflows/gdd/instructions-gdd.md +35 -22
- package/src/modules/bmm/workflows/2-plan-workflows/narrative/instructions-narrative.md +73 -22
- package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +45 -63
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +46 -62
- package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +46 -53
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +78 -47
- package/src/modules/bmm/workflows/4-implementation/create-story/README.md +99 -82
- package/src/modules/bmm/workflows/4-implementation/create-story/instructions.md +2 -0
- package/src/modules/bmm/workflows/4-implementation/story-context/instructions.md +3 -0
- package/src/modules/bmm/workflows/README.md +149 -511
- package/src/modules/bmm/workflows/workflow-status/README.md +38 -19
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +117 -24
- package/src/modules/bmm/workflows/workflow-status/init/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/workflow-status/instructions.md +173 -111
- package/src/modules/bmm/workflows/workflow-status/sample-level-3-workflow.yaml +49 -0
- package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +31 -0
- package/src/modules/bmm/workflows/workflow-status/workflow.yaml +3 -3
- package/src/modules/cis/README.md +153 -0
- package/src/modules/cis/workflows/README.md +102 -30
- package/src/modules/cis/workflows/storytelling/instructions.md +10 -2
- package/tools/bmad-npx-wrapper.js +10 -98
- package/tools/cli/installers/lib/core/manifest-generator.js +4 -1
- package/src/modules/bmm/workflows/workflow-status/workflow-status-template.md +0 -30
- package/src/modules/cis/readme.md +0 -86
- /package/src/modules/bmm/sub-modules/claude-code/{readme.md → README.md} +0 -0
- /package/src/modules/bmm/workflows/3-solutioning/architecture/{readme.md → README.md} +0 -0
|
@@ -1,577 +1,215 @@
|
|
|
1
|
-
|
|
2
|
-
last-redoc-date: 2025-10-12
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# BMM Workflows - The Complete v6 Flow
|
|
6
|
-
|
|
7
|
-
The BMM (BMAD Method Module) orchestrates software development through four distinct phases, each with specialized workflows that adapt to project scale (Level 0-4) and context (greenfield vs brownfield). This document serves as the master guide for understanding how these workflows interconnect to deliver the revolutionary v6 methodology.
|
|
8
|
-
|
|
9
|
-
## Core v6 Innovations
|
|
10
|
-
|
|
11
|
-
**Scale-Adaptive Planning**: Projects automatically route through different workflows based on complexity (Level 0-4), ensuring appropriate documentation and process overhead.
|
|
12
|
-
|
|
13
|
-
**Just-In-Time Design**: Technical specifications are created one epic at a time during implementation, not all upfront, incorporating learnings as the project evolves.
|
|
14
|
-
|
|
15
|
-
**Dynamic Expertise Injection**: Story-context workflows provide targeted technical guidance per story, replacing static documentation with contextual expertise.
|
|
16
|
-
|
|
17
|
-
**Continuous Learning Loop**: Retrospectives feed improvements back into workflows, making each epic smoother than the last.
|
|
18
|
-
|
|
19
|
-
## The Four Phases (Plus Documentation Prerequisite)
|
|
20
|
-
|
|
21
|
-
```
|
|
22
|
-
┌──────────────────────────────────────────────────────────────┐
|
|
23
|
-
│ PREREQUISITE: PROJECT DOCUMENTATION (Conditional) │
|
|
24
|
-
│ For brownfield projects without adequate docs │
|
|
25
|
-
│ OR post-completion cleanup │
|
|
26
|
-
├──────────────────────────────────────────────────────────────┤
|
|
27
|
-
│ document-project ──→ Comprehensive project documentation │
|
|
28
|
-
└────────────────────────────────────────────────────────┼─────┘
|
|
29
|
-
↓
|
|
30
|
-
┌──────────────────────────────────────────────────────────────┐
|
|
31
|
-
│ PHASE 1: ANALYSIS │
|
|
32
|
-
│ (Optional) │
|
|
33
|
-
├──────────────────────────────────────────────────────────────┤
|
|
34
|
-
│ brainstorm-game ──┐ │
|
|
35
|
-
│ brainstorm-project ├──→ research ──→ product-brief ──┐ │
|
|
36
|
-
│ game-brief ────────┘ game-brief │
|
|
37
|
-
└────────────────────────────────────────────────────────┼─────┘
|
|
38
|
-
↓
|
|
39
|
-
┌──────────────────────────────────────────────────────────────┐
|
|
40
|
-
│ PHASE 2: PLANNING │
|
|
41
|
-
│ (Scale-Adaptive Router - by type) │
|
|
42
|
-
├──────────────────────────────────────────────────────────────┤
|
|
43
|
-
│ SOFTWARE: prd/tech-spec GAMES: gdd/narrative │
|
|
44
|
-
│ ├──→ Level 0: tech-spec only ├──→ GDD (all levels) │
|
|
45
|
-
│ ├──→ Level 1: tech-spec only └──→ Narrative (opt) │
|
|
46
|
-
│ ├──→ Level 2: PRD + Epics ──────────────────────────┐ │
|
|
47
|
-
│ └──→ Level 3-4: PRD + Epics ────────────────────────┼┐ │
|
|
48
|
-
│ UX: create-ux-design (conditional) ││ │
|
|
49
|
-
└──────────────────────────────────────────────────────────┼┼──┘
|
|
50
|
-
↓↓
|
|
51
|
-
┌──────────────────────────────────────────────────────────────┐
|
|
52
|
-
│ PHASE 3: SOLUTIONING │
|
|
53
|
-
│ (Software Levels 2-4 / Complex Games) │
|
|
54
|
-
├──────────────────────────────────────────────────────────────┤
|
|
55
|
-
│ create-architecture ──→ architecture.md │
|
|
56
|
-
│ validate-architecture (optional) │
|
|
57
|
-
│ solutioning-gate-check (recommended/required) │
|
|
58
|
-
└────────────────────────────────────────────────────────────┬─┘
|
|
59
|
-
↓
|
|
60
|
-
┌──────────────────────────────────────────────────────────────┐
|
|
61
|
-
│ PHASE 4: IMPLEMENTATION │
|
|
62
|
-
│ (Sprint-Based Cycle) │
|
|
63
|
-
├──────────────────────────────────────────────────────────────┤
|
|
64
|
-
│ sprint-planning ──→ sprint-status.yaml │
|
|
65
|
-
│ ↓ │
|
|
66
|
-
│ ┌─→ epic-tech-context (per epic) │
|
|
67
|
-
│ │ ↓ │
|
|
68
|
-
│ │ create-story ──→ story-context ──→ dev-story ─┐ │
|
|
69
|
-
│ │ ↓ │
|
|
70
|
-
│ │ retrospective ←── [epic done] ←─── code-review │
|
|
71
|
-
│ │ ↓ │
|
|
72
|
-
│ └──────────── correct-course ←──[if issues]───────┘ │
|
|
73
|
-
└──────────────────────────────────────────────────────────────┘
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
## Universal Entry Point: workflow-status
|
|
77
|
-
|
|
78
|
-
**Before starting any workflow, check your status!**
|
|
79
|
-
|
|
80
|
-
The `workflow-status` workflow is the **universal entry point** for all BMM workflows, if you have not already set up your workflow, run `workflow-init`, but even if you just run the workflow-status and the file does not exist you should still be directed to run workflow-init.
|
|
81
|
-
|
|
82
|
-
**What it does:**
|
|
1
|
+
# BMM Workflows - Complete v6 Guide
|
|
83
2
|
|
|
84
|
-
-
|
|
85
|
-
- ✅ Displays current phase, progress, and next action
|
|
86
|
-
- ✅ Helps new users plan their workflow approach
|
|
87
|
-
- ✅ Guides brownfield projects to documentation first
|
|
88
|
-
- ✅ Routes to appropriate workflows based on context
|
|
3
|
+
Master guide for BMM's four-phase methodology that adapts to project scale (Level 0-4) and context (greenfield/brownfield).
|
|
89
4
|
|
|
90
|
-
|
|
5
|
+
## Table of Contents
|
|
91
6
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
---
|
|
7
|
+
- [Core Innovations](#core-innovations)
|
|
8
|
+
- [Universal Entry Point](#universal-entry-point)
|
|
9
|
+
- [Four Phases Overview](#four-phases-overview)
|
|
10
|
+
- [Phase Details](#phase-details)
|
|
11
|
+
- [Documentation Prerequisite](#documentation-prerequisite)
|
|
12
|
+
- [Phase 1: Analysis](#phase-1-analysis)
|
|
13
|
+
- [Phase 2: Planning](#phase-2-planning)
|
|
14
|
+
- [Phase 3: Solutioning](#phase-3-solutioning)
|
|
15
|
+
- [Phase 4: Implementation](#phase-4-implementation)
|
|
16
|
+
- [Scale Levels](#scale-levels)
|
|
17
|
+
- [Greenfield vs Brownfield](#greenfield-vs-brownfield)
|
|
18
|
+
- [Critical Rules](#critical-rules)
|
|
105
19
|
|
|
106
|
-
##
|
|
20
|
+
## Core Innovations
|
|
107
21
|
|
|
108
|
-
|
|
22
|
+
- **Scale-Adaptive Planning** - Automatic routing based on complexity (Level 0-4)
|
|
23
|
+
- **Just-In-Time Design** - Tech specs created per epic during implementation
|
|
24
|
+
- **Dynamic Expertise Injection** - Story-specific technical guidance
|
|
25
|
+
- **Continuous Learning Loop** - Retrospectives improve each cycle
|
|
109
26
|
|
|
110
|
-
|
|
27
|
+
## Universal Entry Point
|
|
111
28
|
|
|
112
|
-
|
|
29
|
+
**Always start with `workflow-status` or `workflow-init`**
|
|
113
30
|
|
|
114
|
-
|
|
115
|
-
2. **Post-Phase 4 Documentation (Any Project)**: Run AFTER completion to create superior documentation that replaces scattered PRD/architecture/story artifacts
|
|
31
|
+
### workflow-status
|
|
116
32
|
|
|
117
|
-
|
|
33
|
+
- Checks for existing workflow status file
|
|
34
|
+
- Displays current phase and progress
|
|
35
|
+
- Routes to appropriate next workflow
|
|
36
|
+
- Shows Phase 4 implementation state
|
|
118
37
|
|
|
119
|
-
|
|
120
|
-
| -------------------- | ------- | ----------------------------------- | ----------------------------------- | -------------------------------------------------------------- |
|
|
121
|
-
| **document-project** | Analyst | Analyze and document entire project | Comprehensive project documentation | Brownfield without docs OR post-completion cleanup (any scale) |
|
|
38
|
+
### workflow-init
|
|
122
39
|
|
|
123
|
-
|
|
40
|
+
- Creates initial bmm-workflow-status.md
|
|
41
|
+
- Detects greenfield vs brownfield
|
|
42
|
+
- Routes undocumented brownfield to document-project
|
|
43
|
+
- Sets up workflow tracking
|
|
124
44
|
|
|
125
|
-
|
|
45
|
+
## Four Phases Overview
|
|
126
46
|
|
|
127
47
|
```
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
Produces clean, LLM-optimized docs > scattered phase artifacts
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
**Why it's superior**: Creates comprehensive, consistent documentation that both humans and LLMs can use to understand projects of any size or complexity - often better than manually-maintained PRDs, architecture docs, and story files.
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
## Phase 1: Analysis (Optional)
|
|
150
|
-
|
|
151
|
-
Optional workflows for project discovery and requirements gathering. Output feeds into Phase 2 planning.
|
|
152
|
-
|
|
153
|
-
### Workflows
|
|
154
|
-
|
|
155
|
-
| Workflow | Agent | Purpose | Output | When to Use |
|
|
156
|
-
| ---------------------- | ------------- | ------------------------------------------- | ------------------------- | --------------------- |
|
|
157
|
-
| **workflow-status** | Analyst | Universal entry point and status checker | Status display + guidance | **Start here!** |
|
|
158
|
-
| **workflow-init** | Analyst | Generate an initial workflow status file | Status display + guidance | **OR start here!** |
|
|
159
|
-
| **brainstorm-game** | Game Designer | Game concept ideation using 5 methodologies | Concept proposals | New game projects |
|
|
160
|
-
| **brainstorm-project** | Analyst | Software solution exploration | Architecture proposals | New software projects |
|
|
161
|
-
| **game-brief** | Game Designer | Structured game design foundation | Game brief document | Before GDD creation |
|
|
162
|
-
| **product-brief** | Analyst | Strategic product planning culmination | Product brief | End of analysis phase |
|
|
163
|
-
| **research** | Analyst | Multi-mode research (market/technical/deep) | Research artifacts | When evidence needed |
|
|
164
|
-
|
|
165
|
-
### Flow
|
|
166
|
-
|
|
167
|
-
```
|
|
168
|
-
workflow-status (check) → Brainstorming → Research → Brief → Planning (Phase 2)
|
|
48
|
+
PREREQUISITE: document-project (brownfield without docs)
|
|
49
|
+
↓
|
|
50
|
+
PHASE 1: Analysis (optional)
|
|
51
|
+
brainstorm → research → brief
|
|
52
|
+
↓
|
|
53
|
+
PHASE 2: Planning (required, scale-adaptive)
|
|
54
|
+
Level 0-1: tech-spec only
|
|
55
|
+
Level 2-4: PRD + epics
|
|
56
|
+
↓
|
|
57
|
+
PHASE 3: Solutioning (Level 2-4 only)
|
|
58
|
+
architecture → validation → gate-check
|
|
59
|
+
↓
|
|
60
|
+
PHASE 4: Implementation (iterative)
|
|
61
|
+
sprint-planning → epic-context → story cycle
|
|
169
62
|
```
|
|
170
63
|
|
|
171
|
-
## Phase
|
|
172
|
-
|
|
173
|
-
### Scale Levels
|
|
64
|
+
## Phase Details
|
|
174
65
|
|
|
175
|
-
|
|
176
|
-
| ----- | ------------------------ | ------------------------------ | ------------------------------ |
|
|
177
|
-
| **0** | Single atomic change | tech-spec + 1 story | → Implementation |
|
|
178
|
-
| **1** | 1-10 stories, 1 epic | tech-spec + epic + 2-3 stories | → Implementation |
|
|
179
|
-
| **2** | 5-15 stories, 1-2 epics | PRD + epics | → Solutioning → Implementation |
|
|
180
|
-
| **3** | 12-40 stories, 2-5 epics | PRD + epics | → Solutioning → Implementation |
|
|
181
|
-
| **4** | 40+ stories, 5+ epics | PRD + epics | → Solutioning → Implementation |
|
|
66
|
+
### Documentation Prerequisite
|
|
182
67
|
|
|
183
|
-
|
|
68
|
+
**When:** Brownfield projects without documentation OR post-completion cleanup
|
|
184
69
|
|
|
185
|
-
| Workflow
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
| **tech-spec** | PM | Technical specification | tech-spec.md | 0-1 |
|
|
189
|
-
| **gdd** | PM | Game Design Document | GDD.md | Games (all) |
|
|
190
|
-
| **narrative** | PM | Game narrative design | narrative.md | Games (opt) |
|
|
191
|
-
| **create-ux-design** | UX Designer | User experience and interface design | ux-design.md | Conditional |
|
|
70
|
+
| Workflow | Purpose | Output |
|
|
71
|
+
| ---------------- | ----------------------------- | ------------------ |
|
|
72
|
+
| document-project | Analyze and document codebase | Comprehensive docs |
|
|
192
73
|
|
|
193
|
-
|
|
74
|
+
**Use Cases:**
|
|
194
75
|
|
|
195
|
-
-
|
|
196
|
-
-
|
|
197
|
-
- **tech-spec.md**: Technical specification (Levels 0-1)
|
|
198
|
-
- **story-{slug}.md**: Single user story (Level 0)
|
|
199
|
-
- **story-{slug}-1.md, story-{slug}-2.md, story-{slug}-3.md**: User stories (Level 1)
|
|
200
|
-
- **GDD.md**: Game Design Document (game projects)
|
|
201
|
-
- **narrative.md**: Narrative design (game projects, optional)
|
|
202
|
-
- **ux-design.md**: UX specification (conditional, UI-heavy projects)
|
|
203
|
-
- **bmm-workflow-status.md**: Versioned workflow state tracking
|
|
76
|
+
1. **Pre-Phase 1**: Understand existing brownfield code
|
|
77
|
+
2. **Post-Phase 4**: Create clean documentation replacing scattered artifacts
|
|
204
78
|
|
|
205
|
-
|
|
79
|
+
### Phase 1: Analysis
|
|
206
80
|
|
|
207
|
-
|
|
81
|
+
**Optional workflows for discovery and requirements gathering**
|
|
208
82
|
|
|
209
|
-
|
|
83
|
+
| Workflow | Agent | Purpose | Output |
|
|
84
|
+
| ------------------ | ------------- | --------------------- | ---------------------- |
|
|
85
|
+
| brainstorm-project | Analyst | Software ideation | Architecture proposals |
|
|
86
|
+
| brainstorm-game | Game Designer | Game concept ideation | Concept proposals |
|
|
87
|
+
| research | Analyst | Multi-mode research | Research artifacts |
|
|
88
|
+
| product-brief | Analyst | Strategic planning | Product brief |
|
|
89
|
+
| game-brief | Game Designer | Game foundation | Game brief |
|
|
210
90
|
|
|
211
|
-
|
|
212
|
-
| -------------------------- | --------- | -------------------------------- | ------------------------- | ----------- |
|
|
213
|
-
| **create-architecture** | Architect | Create system-wide architecture | architecture.md with ADRs | Levels 2-4 |
|
|
214
|
-
| **validate-architecture** | Architect | Validate architecture design | Validation report | Optional |
|
|
215
|
-
| **solutioning-gate-check** | Architect | Validate PRD + UX + architecture | Gate check report | Recommended |
|
|
91
|
+
### Phase 2: Planning
|
|
216
92
|
|
|
217
|
-
|
|
93
|
+
**Required phase with scale-adaptive routing**
|
|
218
94
|
|
|
219
|
-
|
|
220
|
-
|
|
95
|
+
| Workflow | Agent | Output | Levels |
|
|
96
|
+
| ---------------- | ------------- | -------------- | ----------- |
|
|
97
|
+
| prd | PM | PRD.md + epics | 2-4 |
|
|
98
|
+
| tech-spec | PM | tech-spec.md | 0-1 |
|
|
99
|
+
| gdd | Game Designer | GDD.md | Games |
|
|
100
|
+
| create-ux-design | UX | ux-design.md | Conditional |
|
|
221
101
|
|
|
222
|
-
|
|
102
|
+
### Phase 3: Solutioning
|
|
223
103
|
|
|
224
|
-
|
|
104
|
+
**Architecture phase for Level 2-4 projects**
|
|
225
105
|
|
|
226
|
-
|
|
106
|
+
| Workflow | Agent | Purpose | Output |
|
|
107
|
+
| ---------------------- | --------- | ----------------- | ---------------------- |
|
|
108
|
+
| create-architecture | Architect | System design | architecture.md + ADRs |
|
|
109
|
+
| validate-architecture | Architect | Design validation | Validation report |
|
|
110
|
+
| solutioning-gate-check | Architect | PRD/UX/arch check | Gate report |
|
|
227
111
|
|
|
228
|
-
Phase 4
|
|
112
|
+
### Phase 4: Implementation
|
|
229
113
|
|
|
230
|
-
**
|
|
114
|
+
**Sprint-based development cycle**
|
|
231
115
|
|
|
232
|
-
|
|
233
|
-
2. Creates ordered status tracking for every work item
|
|
234
|
-
3. Auto-detects existing story files and contexts
|
|
235
|
-
4. Maintains status through the development lifecycle
|
|
116
|
+
#### Sprint Status System
|
|
236
117
|
|
|
237
|
-
|
|
118
|
+
**Epic Flow:** `backlog → contexted`
|
|
238
119
|
|
|
239
|
-
|
|
120
|
+
**Story Flow:** `backlog → drafted → ready-for-dev → in-progress → review → done`
|
|
240
121
|
|
|
241
|
-
|
|
122
|
+
#### Implementation Workflows
|
|
242
123
|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
124
|
+
| Workflow | Agent | Purpose | Status Updates |
|
|
125
|
+
| ----------------- | ----- | ----------------------- | ------------------------------------------- |
|
|
126
|
+
| sprint-planning | SM | Initialize tracking | Creates sprint-status.yaml |
|
|
127
|
+
| epic-tech-context | SM | Epic technical context | Epic: backlog → contexted |
|
|
128
|
+
| create-story | SM | Draft story files | Story: backlog → drafted |
|
|
129
|
+
| story-context | SM | Implementation guidance | Story: drafted → ready-for-dev |
|
|
130
|
+
| dev-story | DEV | Implement | Story: ready-for-dev → in-progress → review |
|
|
131
|
+
| code-review | DEV | Quality validation | No auto update |
|
|
132
|
+
| retrospective | SM | Capture learnings | Retrospective: optional → completed |
|
|
133
|
+
| correct-course | SM | Handle issues | Adaptive |
|
|
246
134
|
|
|
247
|
-
|
|
135
|
+
#### Implementation Loop
|
|
248
136
|
|
|
249
137
|
```
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
138
|
+
sprint-planning (creates sprint-status.yaml)
|
|
139
|
+
↓
|
|
140
|
+
For each epic:
|
|
141
|
+
epic-tech-context
|
|
142
|
+
↓
|
|
143
|
+
For each story:
|
|
144
|
+
create-story → story-context → dev-story → code-review
|
|
145
|
+
↓
|
|
146
|
+
Mark done in sprint-status.yaml
|
|
147
|
+
↓
|
|
148
|
+
retrospective (epic complete)
|
|
257
149
|
```
|
|
258
150
|
|
|
259
|
-
|
|
151
|
+
## Scale Levels
|
|
260
152
|
|
|
261
|
-
|
|
153
|
+
| Level | Scope | Documentation | Path |
|
|
154
|
+
| ----- | ------------- | --------------------- | --------------- |
|
|
155
|
+
| 0 | Single change | tech-spec only | Phase 2 → 4 |
|
|
156
|
+
| 1 | 1-10 stories | tech-spec only | Phase 2 → 4 |
|
|
157
|
+
| 2 | 5-15 stories | PRD + architecture | Phase 2 → 3 → 4 |
|
|
158
|
+
| 3 | 12-40 stories | PRD + full arch | Phase 2 → 3 → 4 |
|
|
159
|
+
| 4 | 40+ stories | PRD + enterprise arch | Phase 2 → 3 → 4 |
|
|
262
160
|
|
|
263
|
-
|
|
264
|
-
- **contexted**: Epic technical context created (prerequisite for drafting stories)
|
|
161
|
+
## Greenfield vs Brownfield
|
|
265
162
|
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
- **backlog**: Story only exists in epic file, not yet drafted
|
|
269
|
-
- **drafted**: Story file created (e.g., `stories/1-3-plant-naming.md`)
|
|
270
|
-
- **ready-for-dev**: Draft approved + story context created
|
|
271
|
-
- **in-progress**: Developer actively working on implementation
|
|
272
|
-
- **review**: Under SM review (via code-review workflow)
|
|
273
|
-
- **done**: Story completed and deployed
|
|
274
|
-
|
|
275
|
-
**Retrospective Statuses:**
|
|
276
|
-
|
|
277
|
-
- **optional**: Can be done but not required
|
|
278
|
-
- **completed**: Retrospective has been completed
|
|
279
|
-
|
|
280
|
-
### The Implementation Loop
|
|
163
|
+
### Greenfield (New Projects)
|
|
281
164
|
|
|
282
165
|
```
|
|
283
|
-
Phase
|
|
284
|
-
↓
|
|
285
|
-
┌─────────────────────────────────────────────────┐
|
|
286
|
-
│ SM: sprint-planning │
|
|
287
|
-
│ Creates: sprint-status.yaml with all epics/ │
|
|
288
|
-
│ stories set to 'backlog' │
|
|
289
|
-
└───────────────────┬─────────────────────────────┘
|
|
290
|
-
↓
|
|
291
|
-
┌─────────────────────────────────────────────────┐
|
|
292
|
-
│ SM: epic-tech-context (for current epic) │
|
|
293
|
-
│ Creates: epic-N-context.md │
|
|
294
|
-
│ Updates: Epic status to 'contexted' │
|
|
295
|
-
└───────────────────┬─────────────────────────────┘
|
|
296
|
-
↓
|
|
297
|
-
┌─────────────────────────────────────────────────┐
|
|
298
|
-
│ SM: create-story (drafts next backlog story) │
|
|
299
|
-
│ Creates: story-{key}.md │
|
|
300
|
-
│ Updates: Story status to 'drafted' │
|
|
301
|
-
└───────────────────┬─────────────────────────────┘
|
|
302
|
-
↓
|
|
303
|
-
┌─────────────────────────────────────────────────┐
|
|
304
|
-
│ SM: story-context (creates implementation ctx) │
|
|
305
|
-
│ Creates: story-{key}-context.md │
|
|
306
|
-
│ Updates: Story status to 'ready-for-dev' │
|
|
307
|
-
└───────────────────┬─────────────────────────────┘
|
|
308
|
-
↓
|
|
309
|
-
┌─────────────────────────────────────────────────┐
|
|
310
|
-
│ DEV: dev-story (implements story) │
|
|
311
|
-
│ Reads: story + context files │
|
|
312
|
-
│ Updates: Story status to 'in-progress' │
|
|
313
|
-
│ then to 'review' when complete │
|
|
314
|
-
└───────────────────┬─────────────────────────────┘
|
|
315
|
-
↓
|
|
316
|
-
┌─────────────────────────────────────────────────┐
|
|
317
|
-
│ DEV: code-review (validates implementation) │
|
|
318
|
-
│ Reviews: Code changes against DoD │
|
|
319
|
-
│ Feedback: Iteration or approval │
|
|
320
|
-
└───────────────────┬─────────────────────────────┘
|
|
321
|
-
↓
|
|
322
|
-
┌─────────────────────────────────────────────────┐
|
|
323
|
-
│ DEV/SM: Updates story status to 'done' │
|
|
324
|
-
│ Manual update to sprint-status.yaml │
|
|
325
|
-
└───────────────────┬─────────────────────────────┘
|
|
326
|
-
↓
|
|
327
|
-
┌───────┴────────┐
|
|
328
|
-
│ More stories? │
|
|
329
|
-
└───────┬─────────┘
|
|
330
|
-
┌───┴───┐
|
|
331
|
-
↓ ↓
|
|
332
|
-
[Yes: Loop] [No: Epic Complete]
|
|
333
|
-
↓
|
|
334
|
-
┌─────────────────┐
|
|
335
|
-
│ SM: retrospective│
|
|
336
|
-
│ Updates: epic-N- │
|
|
337
|
-
│ retrospective to │
|
|
338
|
-
│ 'completed' │
|
|
339
|
-
└─────────────────┘
|
|
166
|
+
Phase 1 (optional) → Phase 2 → Phase 3 (L2-4) → Phase 4
|
|
340
167
|
```
|
|
341
168
|
|
|
342
|
-
|
|
169
|
+
- Clean slate for design
|
|
170
|
+
- No existing constraints
|
|
171
|
+
- Direct to planning
|
|
343
172
|
|
|
344
|
-
|
|
345
|
-
| --------------------- | ----- | -------------------------------------- | ------------------------------------------- |
|
|
346
|
-
| **sprint-planning** | SM | Initialize sprint status tracking | Creates sprint-status.yaml |
|
|
347
|
-
| **epic-tech-context** | SM | Create epic-specific technical context | Epic: backlog → contexted |
|
|
348
|
-
| **create-story** | SM | Draft individual story files | Story: backlog → drafted |
|
|
349
|
-
| **story-context** | SM | Generate implementation context/XML | Story: drafted → ready-for-dev |
|
|
350
|
-
| **dev-story** | DEV | Implement story | Story: ready-for-dev → in-progress → review |
|
|
351
|
-
| **code-review** | SM/SR | Quality validation and feedback | (No automatic state change) |
|
|
352
|
-
| **retrospective** | SM | Capture epic learnings | Retrospective: optional → completed |
|
|
353
|
-
| **correct-course** | SM | Handle issues/scope changes | (Adaptive based on situation) |
|
|
354
|
-
|
|
355
|
-
### Key Guidelines
|
|
356
|
-
|
|
357
|
-
1. **Epic Context First**: Epics should be `contexted` before their stories can be `drafted`
|
|
358
|
-
2. **Sequential by Default**: Stories are typically worked in order within an epic
|
|
359
|
-
3. **Parallel Work Supported**: Multiple stories can be `in-progress` if team capacity allows
|
|
360
|
-
4. **Learning Transfer**: SM drafts next story after previous is `done` to incorporate learnings
|
|
361
|
-
5. **Flexible Status Updates**: Agents and users can manually update sprint-status.yaml as needed
|
|
362
|
-
|
|
363
|
-
## Greenfield vs Brownfield Paths
|
|
364
|
-
|
|
365
|
-
### Greenfield Projects (New Code)
|
|
366
|
-
|
|
367
|
-
**Path:** Phase 1 (optional) → Phase 2 → Phase 3 (Levels 2-4) → Phase 4
|
|
368
|
-
|
|
369
|
-
- **Level 0-1**: Skip Phase 3, go straight to implementation with tech-spec
|
|
370
|
-
- **Level 2-4**: Full solutioning with architecture before implementation
|
|
371
|
-
- Clean slate for architectural decisions
|
|
372
|
-
- No existing patterns to constrain design
|
|
373
|
-
|
|
374
|
-
### Brownfield Projects (Existing Code)
|
|
375
|
-
|
|
376
|
-
**Path:** Documentation Prerequisite (if undocumented) → Phase 1 (optional) → Phase 2 → Phase 3 (Levels 2-4) → Phase 4
|
|
377
|
-
|
|
378
|
-
**Documentation Prerequisite (Conditional):**
|
|
173
|
+
### Brownfield (Existing Code)
|
|
379
174
|
|
|
380
175
|
```
|
|
381
|
-
|
|
382
|
-
├─→ Check: Is existing codebase documented?
|
|
383
|
-
│ ├─→ YES: Proceed to Phase 1 or 2
|
|
384
|
-
│ └─→ NO: REQUIRED - Run document-project workflow first
|
|
385
|
-
│ ├─→ Analyzes existing code
|
|
386
|
-
│ ├─→ Documents current architecture
|
|
387
|
-
│ ├─→ Identifies technical debt
|
|
388
|
-
│ ├─→ Creates comprehensive baseline documentation
|
|
389
|
-
│ └─→ Produces superior docs for LLM + human understanding
|
|
390
|
-
└─→ Continue with scale-adaptive planning (Phases 1-4)
|
|
176
|
+
document-project (if needed) → Phase 1 (optional) → Phase 2 → Phase 3 (L2-4) → Phase 4
|
|
391
177
|
```
|
|
392
178
|
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
-
|
|
396
|
-
- Integration points need documentation
|
|
397
|
-
- Technical debt must be visible in planning
|
|
398
|
-
- Constraints from existing system affect scale decisions
|
|
399
|
-
|
|
400
|
-
**Post-Completion Option**: After Phase 4 completes, run `document-project` again to create clean source-of-truth documentation that supersedes scattered phase artifacts.
|
|
179
|
+
- Must understand existing patterns
|
|
180
|
+
- Documentation prerequisite if undocumented
|
|
181
|
+
- Consider technical debt in planning
|
|
401
182
|
|
|
402
|
-
##
|
|
183
|
+
## Critical Rules
|
|
403
184
|
|
|
404
|
-
|
|
405
|
-
| ---------------------------------- | ---------------------- | -------------------- | ------------------------------------------- |
|
|
406
|
-
| **Prerequisite: Documentation** | Analyst | - | document-project (conditional) |
|
|
407
|
-
| **Phase 1: Analysis** | Analyst, Game Designer | PM, Researcher | brainstorm-_, research, _-brief |
|
|
408
|
-
| **Phase 2: Planning** | PM | UX Designer, Analyst | prd, tech-spec, gdd, narrative |
|
|
409
|
-
| **Phase 3: Solutioning** | Architect | PM, Tech Lead | create-architecture, solutioning-gate-check |
|
|
410
|
-
| **Phase 4: Implementation** | SM, DEV | SR (code-review) | sprint-planning, create-story, dev-story |
|
|
411
|
-
| **Post-Completion: Documentation** | Analyst | - | document-project (optional cleanup) |
|
|
185
|
+
### Phase Transitions
|
|
412
186
|
|
|
413
|
-
|
|
187
|
+
1. **Check workflow-status** before any Phase 1-3 workflow
|
|
188
|
+
2. **Document brownfield** before planning if undocumented
|
|
189
|
+
3. **Complete planning** before solutioning
|
|
190
|
+
4. **Complete architecture** (L2-4) before implementation
|
|
414
191
|
|
|
415
|
-
###
|
|
192
|
+
### Implementation Rules
|
|
416
193
|
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
- Project metadata and configuration
|
|
194
|
+
1. **Epic context first** - Must context epic before drafting stories
|
|
195
|
+
2. **Sequential by default** - Work stories in order within epic
|
|
196
|
+
3. **Learning transfer** - Draft next story after previous done
|
|
197
|
+
4. **Manual status updates** - Update sprint-status.yaml as needed
|
|
422
198
|
|
|
423
|
-
|
|
424
|
-
- All epics, stories, and retrospectives
|
|
425
|
-
- Current status for each item (backlog → done)
|
|
426
|
-
- Single source of truth for Phase 4 progression
|
|
427
|
-
- Updated by agents as work progresses
|
|
199
|
+
### Story Management
|
|
428
200
|
|
|
429
|
-
|
|
201
|
+
1. **Single source of truth** - sprint-status.yaml tracks everything
|
|
202
|
+
2. **No story search** - Agents read exact story from status file
|
|
203
|
+
3. **Context injection** - Each story gets specific technical guidance
|
|
204
|
+
4. **Retrospective learning** - Capture improvements per epic
|
|
430
205
|
|
|
431
|
-
###
|
|
206
|
+
### Best Practices
|
|
432
207
|
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
- **Phase 1**:
|
|
438
|
-
- Product briefs, game briefs, research documents
|
|
439
|
-
|
|
440
|
-
- **Phase 2**:
|
|
441
|
-
- Level 0: tech-spec.md + story-{slug}.md
|
|
442
|
-
- Level 1: tech-spec.md + epic breakdown + story-{slug}-N.md files
|
|
443
|
-
- Level 2-4: PRD.md + epics.md (+ optional ux-design.md, narrative.md)
|
|
444
|
-
|
|
445
|
-
- **Phase 3**:
|
|
446
|
-
- architecture.md (with ADRs)
|
|
447
|
-
- Validation reports
|
|
448
|
-
- Gate check documentation
|
|
449
|
-
|
|
450
|
-
- **Phase 4**:
|
|
451
|
-
- sprint-status.yaml (tracking file)
|
|
452
|
-
- epic-N-context.md files (per epic)
|
|
453
|
-
- story-{key}.md files (per story)
|
|
454
|
-
- story-{key}-context.md files (per story)
|
|
455
|
-
- Implemented code and tests
|
|
456
|
-
|
|
457
|
-
## Best Practices
|
|
458
|
-
|
|
459
|
-
### 1. Respect the Scale
|
|
460
|
-
|
|
461
|
-
- Don't create PRDs for Level 0-1 changes (use tech-spec only)
|
|
462
|
-
- Don't skip architecture for Level 2-4 projects
|
|
463
|
-
- Let the workflow paths determine appropriate artifacts
|
|
464
|
-
- Level 2 still requires Phase 3 solutioning (lighter than 3-4)
|
|
465
|
-
|
|
466
|
-
### 2. Use Sprint Planning Effectively
|
|
467
|
-
|
|
468
|
-
- Run sprint-planning at the start of Phase 4
|
|
469
|
-
- Context epics before drafting their stories (epic-tech-context)
|
|
470
|
-
- Update sprint-status.yaml as work progresses
|
|
471
|
-
- Re-run sprint-planning to auto-detect new files/contexts
|
|
472
|
-
|
|
473
|
-
### 3. Maintain Flow Integrity
|
|
474
|
-
|
|
475
|
-
- Stories must be defined in Epics.md before sprint-planning
|
|
476
|
-
- Complete epic context before story drafting
|
|
477
|
-
- Create story context before implementation
|
|
478
|
-
- Each phase completes before the next begins
|
|
479
|
-
|
|
480
|
-
### 4. Document Brownfield First (Prerequisite)
|
|
481
|
-
|
|
482
|
-
- Never plan without understanding existing code
|
|
483
|
-
- Run document-project if codebase is undocumented (PREREQUISITE, not Phase 0)
|
|
484
|
-
- Technical debt must be visible in planning
|
|
485
|
-
- Integration points need documentation
|
|
486
|
-
- Can also run post-Phase 4 for superior final documentation
|
|
487
|
-
|
|
488
|
-
### 5. Learn Continuously
|
|
489
|
-
|
|
490
|
-
- Run retrospectives after each epic
|
|
491
|
-
- Incorporate learnings into next story drafts
|
|
492
|
-
- Update workflows based on team feedback
|
|
493
|
-
- Share patterns across teams
|
|
494
|
-
|
|
495
|
-
## Common Pitfalls and Solutions
|
|
496
|
-
|
|
497
|
-
| Pitfall | Solution |
|
|
498
|
-
| ------------------------------------- | ----------------------------------------------------- |
|
|
499
|
-
| Skipping sprint-planning | Always run at Phase 4 start - it creates status file |
|
|
500
|
-
| Creating stories without epic context | Run epic-tech-context before create-story |
|
|
501
|
-
| Skipping story-context generation | Always run after create-story for better dev guidance |
|
|
502
|
-
| Not updating sprint-status.yaml | Update statuses as work progresses |
|
|
503
|
-
| Thinking Level 2 skips Phase 3 | Level 2 DOES require architecture (just lighter) |
|
|
504
|
-
| Planning brownfield without docs | Run document-project first if undocumented |
|
|
505
|
-
| Not running retrospectives | Complete after every epic for learning transfer |
|
|
506
|
-
| Manually tracking stories elsewhere | Use sprint-status.yaml as single source of truth |
|
|
507
|
-
|
|
508
|
-
## Quick Reference Commands
|
|
509
|
-
|
|
510
|
-
```bash
|
|
511
|
-
# Universal Entry Point (Start Here!)
|
|
512
|
-
bmad analyst workflow-status # Check status and get recommendations
|
|
513
|
-
|
|
514
|
-
# Documentation Prerequisite (Brownfield without docs OR post-completion cleanup)
|
|
515
|
-
bmad analyst document-project
|
|
516
|
-
|
|
517
|
-
# Phase 1: Analysis (Optional)
|
|
518
|
-
bmad analyst brainstorm-project # Software ideation
|
|
519
|
-
bmad game-designer brainstorm-game # Game ideation
|
|
520
|
-
bmad analyst research # Market/technical research
|
|
521
|
-
bmad analyst product-brief # Software brief
|
|
522
|
-
bmad game-designer game-brief # Game brief
|
|
523
|
-
|
|
524
|
-
# Phase 2: Planning (Required)
|
|
525
|
-
bmad pm prd # Level 2-4 software projects
|
|
526
|
-
bmad pm tech-spec # Level 0-1 software projects
|
|
527
|
-
bmad pm gdd # Game projects (all levels)
|
|
528
|
-
bmad pm narrative # Game narrative (optional)
|
|
529
|
-
bmad ux-designer create-ux-design # UI-heavy projects
|
|
530
|
-
|
|
531
|
-
# Phase 3: Solutioning (Levels 2-4)
|
|
532
|
-
bmad architect create-architecture # System architecture
|
|
533
|
-
bmad architect validate-architecture # Validation (optional)
|
|
534
|
-
bmad architect solutioning-gate-check # Gate check
|
|
535
|
-
|
|
536
|
-
# Phase 4: Implementation (Sprint-Based)
|
|
537
|
-
bmad sm sprint-planning # FIRST: Initialize sprint tracking
|
|
538
|
-
bmad sm epic-tech-context # Create epic context (per epic)
|
|
539
|
-
bmad sm create-story # Draft story file
|
|
540
|
-
bmad sm story-context # Create story context
|
|
541
|
-
bmad dev dev-story # Implement story
|
|
542
|
-
bmad sm code-review # Quality validation
|
|
543
|
-
# (Update sprint-status.yaml to 'done' manually or via workflow)
|
|
544
|
-
bmad sm retrospective # After epic complete
|
|
545
|
-
bmad sm correct-course # If issues arise
|
|
546
|
-
```
|
|
547
|
-
|
|
548
|
-
## Future Enhancements
|
|
549
|
-
|
|
550
|
-
### Coming Soon
|
|
551
|
-
|
|
552
|
-
- **Automated status updates**: Workflows automatically update sprint-status.yaml
|
|
553
|
-
- **Workflow orchestration**: Automatic phase transitions and validation
|
|
554
|
-
- **Progress dashboards**: Real-time workflow status visualization
|
|
555
|
-
- **Team synchronization**: Multi-developer story coordination
|
|
556
|
-
|
|
557
|
-
### Under Consideration
|
|
558
|
-
|
|
559
|
-
- AI-assisted retrospectives with pattern detection
|
|
560
|
-
- Automated story sizing based on historical data
|
|
561
|
-
- Predictive epic planning with risk assessment
|
|
562
|
-
- Cross-project learning transfer
|
|
563
|
-
- Enhanced brownfield analysis with architectural debt scoring
|
|
208
|
+
1. **Trust the process** - Let workflows guide you
|
|
209
|
+
2. **Respect scale** - Don't over-document small projects
|
|
210
|
+
3. **Use status tracking** - Always know where you are
|
|
211
|
+
4. **Iterate and learn** - Each epic improves the next
|
|
564
212
|
|
|
565
213
|
---
|
|
566
214
|
|
|
567
|
-
|
|
568
|
-
**Last Updated**: 2025-10-26
|
|
569
|
-
|
|
570
|
-
This document serves as the authoritative guide to BMM v6a workflow execution. For detailed information about individual workflows, see their respective README files in the workflow folders.
|
|
571
|
-
|
|
572
|
-
## Related Documentation
|
|
573
|
-
|
|
574
|
-
- **Workflow Paths**: See `workflow-status/paths/` for detailed greenfield/brownfield routing by level
|
|
575
|
-
- **Phase 2 Planning**: See `2-plan-workflows/README.md` for scale-adaptive planning details
|
|
576
|
-
- **Phase 4 Sprint Planning**: See `4-implementation/sprint-planning/README.md` for sprint status system
|
|
577
|
-
- **Individual Workflows**: Each workflow directory contains its own README with specific instructions
|
|
215
|
+
For specific workflow details, see individual workflow READMEs in their respective directories.
|