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.
Files changed (162) hide show
  1. package/.claude/commands/bmad/bmm/agents/architect.md +0 -1
  2. package/.claude/commands/bmad/bmm/agents/sm.md +1 -1
  3. package/.claude/commands/bmad/bmm/agents/tech-writer.md +82 -0
  4. package/.claude/commands/bmad/bmm/workflows/README.md +1 -1
  5. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +15 -0
  6. package/.claude/commands/bmad/core/workflows/README.md +10 -0
  7. package/.claude/settings.local.json +4 -8
  8. package/CHANGELOG.md +305 -0
  9. package/README.md +88 -39
  10. package/bmad/_cfg/agent-manifest.csv +2 -1
  11. package/bmad/_cfg/agents/bmm-tech-writer.customize.yaml +42 -0
  12. package/bmad/_cfg/files-manifest.csv +40 -62
  13. package/bmad/_cfg/ides/claude-code.yaml +1 -1
  14. package/bmad/_cfg/manifest.yaml +4 -3
  15. package/bmad/_cfg/task-manifest.csv +4 -1
  16. package/bmad/_cfg/tool-manifest.csv +1 -0
  17. package/bmad/_cfg/workflow-manifest.csv +3 -1
  18. package/bmad/bmb/config.yaml +2 -2
  19. package/bmad/bmb/workflows/audit-workflow/instructions.md +1 -1
  20. package/bmad/bmm/README.md +79 -120
  21. package/bmad/bmm/README.md.bak +169 -0
  22. package/bmad/bmm/agents/analyst.md.bak +67 -0
  23. package/bmad/bmm/agents/architect.md +0 -1
  24. package/bmad/bmm/agents/architect.md.bak +73 -0
  25. package/bmad/bmm/agents/dev.md.bak +69 -0
  26. package/bmad/bmm/agents/pm.md.bak +76 -0
  27. package/bmad/bmm/agents/sm.md +1 -1
  28. package/bmad/bmm/agents/sm.md.bak +85 -0
  29. package/bmad/bmm/agents/tea.md.bak +72 -0
  30. package/bmad/bmm/agents/tech-writer.md +82 -0
  31. package/bmad/bmm/agents/ux-designer.md.bak +71 -0
  32. package/bmad/bmm/config.yaml +2 -2
  33. package/bmad/bmm/docs/README.md +235 -0
  34. package/bmad/bmm/docs/agents-guide.md +1057 -0
  35. package/bmad/bmm/docs/brownfield-guide.md +471 -972
  36. package/bmad/bmm/docs/enterprise-agentic-development.md +680 -0
  37. package/bmad/bmm/docs/faq.md +589 -0
  38. package/bmad/bmm/docs/glossary.md +321 -0
  39. package/bmad/bmm/docs/party-mode.md +224 -0
  40. package/bmad/bmm/docs/quick-spec-flow.md +64 -57
  41. package/bmad/bmm/docs/quick-start.md +72 -47
  42. package/bmad/bmm/docs/scale-adaptive-system.md +332 -778
  43. package/bmad/bmm/docs/troubleshooting.md +680 -0
  44. package/bmad/bmm/{workflows/3-solutioning/architecture/README.md → docs/workflow-architecture-reference.md} +130 -77
  45. package/bmad/bmm/{workflows/document-project/README.md → docs/workflow-document-project-reference.md} +45 -2
  46. package/bmad/bmm/docs/workflows-analysis.md +670 -0
  47. package/bmad/bmm/docs/workflows-implementation.md +1758 -0
  48. package/bmad/bmm/docs/workflows-planning.md +1086 -0
  49. package/bmad/bmm/docs/workflows-solutioning.md +726 -0
  50. package/bmad/bmm/tasks/daily-standup.xml +1 -1
  51. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml.bak +60 -0
  52. package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
  53. package/bmad/bmm/workflows/techdoc/documentation-standards.md +2 -1
  54. package/bmad/bmm/workflows/techdoc/documentation-standards.md.bak +238 -0
  55. package/bmad/bmm/workflows/workflow-status/init/instructions.md +623 -242
  56. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml.bak +27 -0
  57. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
  58. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
  59. package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
  60. package/{src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
  61. package/{src/modules/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → bmad/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
  62. package/bmad/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  63. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
  64. package/bmad/cis/agents/brainstorming-coach.md.bak +62 -0
  65. package/bmad/cis/agents/creative-problem-solver.md.bak +62 -0
  66. package/bmad/cis/agents/design-thinking-coach.md.bak +62 -0
  67. package/bmad/cis/agents/innovation-strategist.md.bak +62 -0
  68. package/bmad/cis/agents/storyteller.md.bak +59 -0
  69. package/bmad/cis/config.yaml +2 -2
  70. package/bmad/core/agents/bmad-master.md.bak +15 -13
  71. package/bmad/core/config.yaml +2 -2
  72. package/bmad/core/tasks/workflow.xml +1 -11
  73. package/package.json +1 -1
  74. package/src/core/tasks/workflow.xml +1 -11
  75. package/src/modules/bmb/workflows/audit-workflow/instructions.md +1 -1
  76. package/src/modules/bmm/README.md +1 -1
  77. package/src/modules/bmm/agents/architect.agent.yaml +0 -4
  78. package/src/modules/bmm/agents/game-dev.agent.yaml +8 -12
  79. package/src/modules/bmm/agents/sm.agent.yaml +1 -1
  80. package/src/modules/bmm/agents/{paige.agent.yaml → tech-writer.agent.yaml} +4 -4
  81. package/src/modules/bmm/docs/README.md +9 -9
  82. package/src/modules/bmm/docs/agents-guide.md +46 -98
  83. package/src/modules/bmm/docs/brownfield-guide.md +211 -90
  84. package/src/modules/bmm/docs/enterprise-agentic-development.md +380 -740
  85. package/src/modules/bmm/docs/faq.md +10 -10
  86. package/src/modules/bmm/docs/glossary.md +36 -42
  87. package/src/modules/bmm/docs/party-mode.md +110 -1122
  88. package/src/modules/bmm/docs/quick-spec-flow.md +33 -33
  89. package/src/modules/bmm/docs/quick-start.md +29 -29
  90. package/src/modules/bmm/docs/scale-adaptive-system.md +303 -453
  91. package/src/modules/bmm/docs/troubleshooting.md +1 -1
  92. package/src/modules/bmm/docs/workflows-implementation.md +20 -21
  93. package/src/modules/bmm/docs/workflows-solutioning.md +1 -1
  94. package/src/modules/bmm/tasks/daily-standup.xml +1 -1
  95. package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
  96. package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
  97. package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
  98. package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
  99. package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
  100. package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
  101. package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +2 -2
  102. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
  103. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
  104. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
  105. package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
  106. package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
  107. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
  108. package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
  109. package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
  110. package/src/modules/bmm/workflows/techdoc/documentation-standards.md +1 -1
  111. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +623 -242
  112. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
  113. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
  114. package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-3.yaml → src/modules/bmm/workflows/workflow-status/paths/method-brownfield.yaml} +33 -31
  115. package/{bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
  116. package/{bmad/bmm/workflows/workflow-status/paths/brownfield-level-1.yaml → src/modules/bmm/workflows/workflow-status/paths/quick-flow-brownfield.yaml} +18 -18
  117. package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  118. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
  119. package/bmad/bmm/tasks/retrospective.xml +0 -104
  120. package/bmad/bmm/testarch/README.md +0 -311
  121. package/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -113
  122. package/bmad/bmm/workflows/1-analysis/product-brief/README.md +0 -180
  123. package/bmad/bmm/workflows/1-analysis/research/README.md +0 -454
  124. package/bmad/bmm/workflows/2-plan-workflows/README.md +0 -258
  125. package/bmad/bmm/workflows/3-solutioning/README.md +0 -1
  126. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
  127. package/bmad/bmm/workflows/4-implementation/README.md +0 -221
  128. package/bmad/bmm/workflows/4-implementation/code-review/README.md +0 -69
  129. package/bmad/bmm/workflows/4-implementation/correct-course/README.md +0 -73
  130. package/bmad/bmm/workflows/4-implementation/create-story/README.md +0 -146
  131. package/bmad/bmm/workflows/4-implementation/dev-story/README.md +0 -206
  132. package/bmad/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
  133. package/bmad/bmm/workflows/4-implementation/retrospective/README.md +0 -77
  134. package/bmad/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
  135. package/bmad/bmm/workflows/4-implementation/story-context/README.md +0 -234
  136. package/bmad/bmm/workflows/README.md +0 -256
  137. package/bmad/bmm/workflows/document-project/templates/README.md +0 -38
  138. package/bmad/bmm/workflows/testarch/README.md +0 -26
  139. package/bmad/bmm/workflows/testarch/atdd/README.md +0 -672
  140. package/bmad/bmm/workflows/testarch/automate/README.md +0 -869
  141. package/bmad/bmm/workflows/testarch/ci/README.md +0 -493
  142. package/bmad/bmm/workflows/testarch/framework/README.md +0 -340
  143. package/bmad/bmm/workflows/testarch/nfr-assess/README.md +0 -469
  144. package/bmad/bmm/workflows/testarch/test-design/README.md +0 -493
  145. package/bmad/bmm/workflows/testarch/test-review/README.md +0 -775
  146. package/bmad/bmm/workflows/testarch/trace/README.md +0 -802
  147. package/bmad/bmm/workflows/workflow-status/README.md +0 -260
  148. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  149. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  150. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  151. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  152. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  153. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  154. package/src/modules/bmm/docs/brownfield-guide.md.backup +0 -1324
  155. package/src/modules/bmm/docs/workflows-testing.md +0 -1572
  156. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  157. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  158. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  159. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  160. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  161. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  162. /package/bmad/bmm/agents/{paige.md → paige.md.bak} +0 -0
@@ -1,823 +1,468 @@
1
1
  # BMad Method Scale Adaptive System
2
2
 
3
- **Automatically adapts workflows to project complexity - from bug fixes to enterprise systems**
3
+ **Automatically adapts workflows to project complexity - from quick fixes to enterprise systems**
4
4
 
5
5
  ---
6
6
 
7
7
  ## Overview
8
8
 
9
- The **Scale Adaptive System** is BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project size and complexity.
9
+ The **Scale Adaptive System** intelligently routes projects to the right planning methodology based on complexity, not arbitrary story counts.
10
10
 
11
- ### The Problem It Solves
11
+ ### The Problem
12
12
 
13
13
  Traditional methodologies apply the same process to every project:
14
14
 
15
- - ❌ **Overkill:** Bug fix requires full design docs
16
- - ❌ **Insufficient:** Enterprise system built with minimal planning
17
- - ❌ **One-Size-Fits-None:** Same process for 1 story and 100 stories
15
+ - Bug fix requires full design docs
16
+ - Enterprise system built with minimal planning
17
+ - One-size-fits-none approach
18
18
 
19
19
  ### The Solution
20
20
 
21
- BMad Method **adapts workflows to match project scale**:
21
+ BMad Method adapts to three distinct planning tracks:
22
22
 
23
- - **Level 0 (1 story):** Tech-spec only, implement immediately
24
- - **Level 2 (10 stories):** PRD + Architecture, structured approach
25
- - **Level 4 (100+ stories):** Full enterprise planning, comprehensive docs
23
+ - **Quick Flow**: Tech-spec only, implement immediately
24
+ - **BMad Method**: PRD + Architecture, structured approach
25
+ - **Enterprise Method**: Full planning with security/devops/test
26
26
 
27
- **Result:** Right amount of planning for every project - no more, no less.
27
+ **Result**: Right planning depth for every project.
28
28
 
29
29
  ---
30
30
 
31
- ## Key Terminology
31
+ ## Quick Reference
32
32
 
33
- ### Analysis Phase
33
+ ### Three Tracks at a Glance
34
34
 
35
- **What it is:** Discovery and research phase that informs planning decisions.
35
+ | Track | Planning Depth | Time Investment | Best For |
36
+ | --------------------- | --------------------- | --------------- | ------------------------------------------ |
37
+ | **Quick Flow** | Tech-spec only | Hours to 1 day | Simple features, bug fixes, clear scope |
38
+ | **BMad Method** | PRD + Arch + UX | 1-3 days | Products, platforms, complex features |
39
+ | **Enterprise Method** | Method + Test/Sec/Ops | 3-7 days | Enterprise needs, compliance, multi-tenant |
36
40
 
37
- **Activities:**
41
+ ### Decision Tree
38
42
 
39
- - **Brainstorming:** Ideation and creative exploration
40
- - **Research:** Market analysis, technical investigation, user research
41
- - **Product Brief:** High-level vision and requirements capture
43
+ ```mermaid
44
+ flowchart TD
45
+ START{Describe your project}
42
46
 
43
- **When used:**
47
+ START -->|Bug fix, simple feature| Q1{Scope crystal clear?}
48
+ START -->|Product, platform, complex| M[BMad Method<br/>PRD + Architecture]
49
+ START -->|Enterprise, compliance| E[Enterprise Method<br/>Extended Planning]
44
50
 
45
- - Optional for Level 0-1 (quick changes)
46
- - Recommended for Level 2 (provides context)
47
- - Required for Level 3-4 (critical for complex systems)
51
+ Q1 -->|Yes| QF[Quick Flow<br/>Tech-spec only]
52
+ Q1 -->|Uncertain| M
48
53
 
49
- ---
50
-
51
- ### Tech-Spec (Technical Specification)
52
-
53
- **What it is:** Comprehensive technical plan for implementing changes or features. Serves as the **primary planning document** for Level 0-1 projects.
54
-
55
- **Contents:**
56
-
57
- - Problem statement and solution approach
58
- - Source tree changes (specific files)
59
- - Technical implementation details
60
- - Detected stack and conventions (brownfield)
61
- - UX/UI considerations (if user-facing)
62
- - Testing strategy
63
- - Developer resources
64
-
65
- **When used:**
54
+ style QF fill:#bfb,stroke:#333,stroke-width:2px
55
+ style M fill:#bbf,stroke:#333,stroke-width:2px
56
+ style E fill:#f9f,stroke:#333,stroke-width:2px
57
+ ```
66
58
 
67
- - **Level 0:** Single story technical plan
68
- - **Level 1:** Feature technical plan with epic
69
- - **Level 2-4:** Not used (PRD + Architecture instead)
59
+ ### Quick Keywords
70
60
 
71
- **Replacement at Level 2+:** Tech-spec is **replaced by PRD + Architecture** for proper product and system planning.
61
+ - **Quick Flow**: fix, bug, simple, add, clear scope
62
+ - **BMad Method**: product, platform, dashboard, complex, multiple features
63
+ - **Enterprise Method**: enterprise, multi-tenant, compliance, security, audit
72
64
 
73
65
  ---
74
66
 
75
- ### Epic-Tech-Spec (Epic Technical Specification)
67
+ ## How Track Selection Works
76
68
 
77
- **What it is:** Detailed technical planning document created **during implementation** for each epic in Level 2-4 projects.
69
+ When you run `workflow-init`, it guides you through an educational choice:
78
70
 
79
- **Difference from Tech-Spec:**
71
+ ### 1. Description Analysis
80
72
 
81
- - **Tech-spec (Level 0-1):** Created upfront, serves as primary planning doc
82
- - **Epic-tech-spec (Level 2-4):** Created just-before-implementation per epic, supplements PRD + Architecture
73
+ Analyzes your project description for complexity indicators and suggests an appropriate track.
83
74
 
84
- **Contents:**
75
+ ### 2. Educational Presentation
85
76
 
86
- - Epic-specific technical details
87
- - Detailed implementation approach for this epic
88
- - Code-level design decisions
89
- - Epic-scoped testing strategy
90
- - Integration points with other epics
77
+ Shows all three tracks with:
91
78
 
92
- **When used:**
79
+ - Time investment
80
+ - Planning approach
81
+ - Benefits and trade-offs
82
+ - AI agent support level
83
+ - Concrete examples
93
84
 
94
- - **Recommended** for Level 2-4 during implementation phase
95
- - Created as each epic is worked on
96
- - Particularly important for:
97
- - Complex epics with many stories
98
- - Novel technical approaches
99
- - Integration-heavy epics
100
- - Performance-critical features
85
+ ### 3. Honest Recommendation
101
86
 
102
- ---
87
+ Provides tailored recommendation based on:
103
88
 
104
- ### Architecture Document
89
+ - Complexity keywords
90
+ - Greenfield vs brownfield
91
+ - User's description
105
92
 
106
- **What it is:** System-wide design document that defines structure, components, and interactions.
93
+ ### 4. User Choice
107
94
 
108
- **Scale-Adaptive:**
95
+ You choose the track that fits your situation. The system guides but never forces.
109
96
 
110
- - **Level 0-1:** Not used
111
- - **Level 2:** Optional - lightweight architecture if needed
112
- - **Level 3:** Required - comprehensive system architecture
113
- - **Level 4:** Required - enterprise-grade architecture
97
+ **Example:**
114
98
 
115
- **Contents:**
99
+ ```
100
+ workflow-init: "Based on 'Add user dashboard with analytics', I recommend BMad Method.
101
+ This involves multiple features and system design. The PRD + Architecture
102
+ gives AI agents complete context for better code generation."
116
103
 
117
- - System components and their responsibilities
118
- - Data models and schemas
119
- - Integration patterns
120
- - Security architecture
121
- - Performance considerations
122
- - Deployment architecture
123
- - **Scales in complexity** with project level
104
+ You: "Actually, this is simpler than it sounds. Quick Flow."
124
105
 
125
- **Note:** Architecture document takes the place of tech-spec for system-level planning in Level 2-4 projects.
106
+ workflow-init: "Got it! Using Quick Flow with tech-spec."
107
+ ```
126
108
 
127
109
  ---
128
110
 
129
- ### Document-Project Workflow
130
-
131
- **What it is:** Brownfield codebase analysis workflow that creates comprehensive documentation of existing code.
132
-
133
- **Output:** `docs/index.md` with sharded sections covering:
134
-
135
- - Project structure
136
- - Key modules and services
137
- - Existing patterns
138
- - Dependencies
139
- - Configuration
140
-
141
- **Critical for Brownfield:**
142
- 🚨 **Run document-project BEFORE starting any brownfield project (Level 0-4)**
111
+ ## The Three Tracks
143
112
 
144
- **Why it matters:**
113
+ ### Track 1: Quick Flow
145
114
 
146
- - Tech-spec workflow uses this for brownfield analysis
147
- - PRD workflow references it for context
148
- - Architecture workflow builds on existing structure
149
- - Epic-tech-specs reference existing code
115
+ **Definition**: Fast implementation with tech-spec planning.
150
116
 
151
- **When to run:**
117
+ **Time**: Hours to 1 day of planning
152
118
 
153
- - Before workflow-init for brownfield projects
154
- - When joining an existing codebase
155
- - After major refactors (to update docs)
119
+ **Planning Docs**:
156
120
 
157
- ---
158
-
159
- ## The Five Levels
160
-
161
- ### Level 0: Single Atomic Change
121
+ - Tech-spec.md (implementation-focused)
122
+ - Story files (1-15 typically, auto-detects epic structure)
162
123
 
163
- **Examples:** Bug fixes, typos, single-file changes
164
-
165
- | Aspect | Details |
166
- | ------------------- | ------------------------------------------------ |
167
- | **Stories** | 1 story |
168
- | **Planning Docs** | Tech-spec only |
169
- | **Architecture** | None |
170
- | **Best For** | Bug fixes, small patches, quick updates |
171
- | **Brownfield Prep** | Run document-project first (if not already done) |
172
-
173
- **Workflow:**
124
+ **Workflow Path**:
174
125
 
175
126
  ```
176
- (Brownfield: document-project first)
127
+ (Brownfield: document-project first if needed)
177
128
 
178
- Analysis (optional) → Tech-Spec → Implement
129
+ Tech-Spec → Implement
179
130
  ```
180
131
 
181
- **Keywords:** fix, bug, typo, small change, quick update, patch
182
-
183
- ---
132
+ **Use For**:
184
133
 
185
- ### Level 1: Small Feature
134
+ - Bug fixes
135
+ - Simple features
136
+ - Enhancements with clear scope
137
+ - Quick additions
186
138
 
187
- **Examples:** OAuth login, search feature, user profile page
139
+ **Story Count**: Typically 1-15 stories (guidance, not rule)
188
140
 
189
- | Aspect | Details |
190
- | ------------------- | --------------------------------------------------- |
191
- | **Stories** | 1-10 stories (typically 2-3) |
192
- | **Planning Docs** | Tech-spec with epic |
193
- | **Architecture** | None |
194
- | **UX Design** | Optional - can be included in tech-spec or separate |
195
- | **Best For** | Small coherent features, rapid prototyping |
196
- | **Brownfield Prep** | Run document-project first (if not already done) |
141
+ **Example**: "Fix authentication token expiration bug"
197
142
 
198
- **Workflow:**
143
+ **AI Agent Support**: Basic - minimal context provided
199
144
 
200
- ```
201
- (Brownfield: document-project first)
202
-
203
- Analysis (optional) → Tech-Spec + Epic → (Optional UX Design) → Implement
204
- ```
145
+ **Trade-off**: Less planning = higher rework risk if complexity emerges
205
146
 
206
- **UX Note:** Level 1 tech-spec can include UX/UI considerations inline, or you can optionally run separate UX Design workflow if the UI is complex.
147
+ ---
207
148
 
208
- **Keywords:** simple, basic, small feature, add, minor
149
+ ### Track 2: BMad Method (RECOMMENDED)
209
150
 
210
- ---
151
+ **Definition**: Full product + system design planning.
211
152
 
212
- ### Level 2: Medium Project
153
+ **Time**: 1-3 days of planning
213
154
 
214
- **Examples:** Admin dashboard, customer portal, reporting system
155
+ **Planning Docs**:
215
156
 
216
- | Aspect | Details |
217
- | ------------------- | ----------------------------------------------------------- |
218
- | **Stories** | 5-15 stories across multiple epics |
219
- | **Planning Docs** | PRD + Epics |
220
- | **Architecture** | Optional - lightweight architecture if system design needed |
221
- | **UX Design** | Optional - recommended for UI-heavy projects |
222
- | **Epic-Tech-Specs** | Recommended during implementation per epic |
223
- | **Best For** | Multiple related features, focused products |
224
- | **Brownfield Prep** | Run document-project first (if not already done) |
157
+ - PRD.md (product requirements)
158
+ - Architecture.md (system design)
159
+ - UX Design (if UI components)
160
+ - Epic breakdown with stories
225
161
 
226
- **Workflow:**
162
+ **Workflow Path**:
227
163
 
228
164
  ```
229
- (Brownfield: document-project first)
165
+ (Brownfield: document-project first if needed)
230
166
 
231
- Analysis (recommended) PRD + Epics (Optional) UX Design → (Optional) Architecture → Implement
232
-
233
- Epic-Tech-Spec per epic (recommended)
234
-
235
- Retrospective after each epic (if >1 epic)
167
+ (Optional: Analysis phase - brainstorm, research, product brief)
168
+
169
+ PRD (Optional UX) → Architecture → Gate Check → Implement
236
170
  ```
237
171
 
238
- **Architecture Note:** Level 2 uses optional **Architecture document** (not tech-spec) if system design is needed. For projects that don't need architecture, PRD + Epics are sufficient.
239
-
240
- **Epic-Tech-Specs:** As you implement each epic, create epic-tech-spec for detailed technical guidance. If you have 3 epics, you'll create 3 epic-tech-specs during implementation.
172
+ **Use For**:
241
173
 
242
- **Retrospectives:** After completing each epic (when there are multiple), run retrospective to capture learnings before starting the next epic.
174
+ **Greenfield**:
243
175
 
244
- **Keywords:** dashboard, several features, admin panel, medium
176
+ - Products
177
+ - Platforms
178
+ - Multi-feature initiatives
245
179
 
246
- ---
180
+ **Brownfield**:
247
181
 
248
- ### Level 3: Complex System
182
+ - Complex additions (new UIs + APIs)
183
+ - Major refactors
184
+ - New modules
249
185
 
250
- **Examples:** E-commerce platform, SaaS product, multi-module system
186
+ **Story Count**: Typically 10-50+ stories (guidance, not rule)
251
187
 
252
- | Aspect | Details |
253
- | ------------------- | -------------------------------------------------- |
254
- | **Stories** | 12-40 stories with subsystems |
255
- | **Planning Docs** | PRD + Epics + System Architecture |
256
- | **Architecture** | Required - comprehensive system design |
257
- | **UX Design** | Recommended for user-facing systems |
258
- | **Epic-Tech-Specs** | Recommended during implementation per epic |
259
- | **Gate Checks** | Required - validate cohesion before implementation |
260
- | **Best For** | Complex integrations, multi-subsystem products |
261
- | **Brownfield Prep** | Run document-project first (if not already done) |
188
+ **Examples**:
262
189
 
263
- **Workflow:**
190
+ - "User dashboard with analytics and preferences"
191
+ - "Add real-time collaboration to existing document editor"
192
+ - "Payment integration system"
264
193
 
265
- ```
266
- (Brownfield: document-project first)
267
-
268
- Analysis + Research → PRD + Epics → (Recommended) UX Design → Architecture (required) → Gate Check → Implement
269
-
270
- Epic-Tech-Spec per epic (recommended)
271
-
272
- Retrospective after each epic
273
- ```
194
+ **AI Agent Support**: Exceptional - complete context for coding partnership
274
195
 
275
- **Gate Check:** Validates PRD + UX + Architecture cohesion before starting implementation. Prevents costly rework.
196
+ **Why Architecture for Brownfield?**
276
197
 
277
- **Epic-Tech-Specs:** For complex epics, create detailed epic-tech-spec before implementation. These provide code-level design decisions that Architecture doesn't cover.
198
+ Your brownfield documentation might be huge. Architecture workflow distills massive codebase context into a focused solution design specific to YOUR project. This keeps AI agents focused without getting lost in existing code.
278
199
 
279
- **Additional Detail Docs:** For very novel or complex subsystems, you may create additional technical design documents beyond epic-tech-specs. These are created as-needed, not upfront.
200
+ **Benefits**:
280
201
 
281
- **Keywords:** platform, integration, complex, system, architecture
202
+ - Complete AI agent context
203
+ - Prevents architectural drift
204
+ - Fewer surprises during implementation
205
+ - Better code quality
206
+ - Faster overall delivery (planning pays off)
282
207
 
283
208
  ---
284
209
 
285
- ### Level 4: Enterprise Scale
210
+ ### Track 3: Enterprise Method
286
211
 
287
- **Examples:** Multi-product suite, enterprise ecosystem, platform with multiple apps
212
+ **Definition**: Extended planning with security, devops, and test strategy.
288
213
 
289
- | Aspect | Details |
290
- | ------------------- | -------------------------------------------------------------- |
291
- | **Stories** | 40+ stories across products |
292
- | **Planning Docs** | Comprehensive PRD + Epics + Enterprise Architecture |
293
- | **Architecture** | Required - enterprise-grade system design |
294
- | **UX Design** | Recommended - design system and patterns |
295
- | **Epic-Tech-Specs** | Recommended during implementation per epic |
296
- | **Gate Checks** | Required - multiple validation gates |
297
- | **Best For** | Multi-tenant systems, product ecosystems, enterprise platforms |
298
- | **Brownfield Prep** | Run document-project first (if not already done) |
214
+ **Time**: 3-7 days of planning
299
215
 
300
- **Workflow:**
216
+ **Planning Docs**:
217
+
218
+ - All BMad Method docs PLUS:
219
+ - Security Architecture
220
+ - DevOps Strategy
221
+ - Test Strategy
222
+ - Compliance documentation
223
+
224
+ **Workflow Path**:
301
225
 
302
226
  ```
303
- (Brownfield: document-project first)
227
+ (Brownfield: document-project nearly mandatory)
228
+
229
+ Analysis (recommended/required) → PRD → UX → Architecture
304
230
 
305
- Analysis + Research PRD + Epics UX Design → Enterprise Architecture → Gate Check → Implement
306
-
307
- Epic-Tech-Spec per epic (recommended)
308
-
309
- Additional design docs for complex subsystems
310
-
311
- Retrospective after each epic
231
+ Security ArchitectureDevOps StrategyTest Strategy
232
+
233
+ Gate Check Implement
312
234
  ```
313
235
 
314
- **Enterprise Architecture:** More comprehensive than Level 3, includes:
315
-
316
- - Multi-tenancy design
317
- - Security architecture
318
- - Scalability planning
319
- - Integration architecture
320
- - Data architecture
321
- - Deployment architecture
236
+ **Use For**:
322
237
 
323
- **Additional Design Documents:** For enterprise complexity, you may need supplementary technical documents:
238
+ - Enterprise requirements
239
+ - Multi-tenant systems
240
+ - Compliance needs (HIPAA, SOC2, etc.)
241
+ - Mission-critical systems
242
+ - Security-sensitive applications
324
243
 
325
- - Detailed subsystem designs
326
- - Integration specifications
327
- - Performance optimization plans
328
- - Security implementation guides
244
+ **Story Count**: Typically 30+ stories (but defined by enterprise needs, not count)
329
245
 
330
- These are created **during implementation** as needed, not all upfront.
246
+ **Examples**:
331
247
 
332
- **Keywords:** enterprise, multi-tenant, multiple products, ecosystem, scale
248
+ - "Multi-tenant SaaS platform"
249
+ - "HIPAA-compliant patient portal"
250
+ - "Add SOC2 audit logging to enterprise app"
333
251
 
334
- ---
252
+ **AI Agent Support**: Elite - comprehensive enterprise planning
335
253
 
336
- ## Workflow Comparison
254
+ **Critical for Enterprise**:
337
255
 
338
- | Level | Analysis | Planning | Architecture | Epic-Tech-Specs | Stories | Retrospectives |
339
- | ----- | ----------- | ---------------- | ------------ | ----------------- | ------- | ----------------------- |
340
- | **0** | Optional | Tech-spec | None | N/A (no epics) | 1 | N/A |
341
- | **1** | Optional | Tech-spec + Epic | None | N/A (single epic) | 2-3 | N/A |
342
- | **2** | Recommended | PRD | Optional | Recommended | 5-15 | After each epic (if >1) |
343
- | **3** | Required | PRD | Required | Recommended | 12-40 | After each epic |
344
- | **4** | Required | PRD | Required | Recommended | 40+ | After each epic |
256
+ - Security architecture and threat modeling
257
+ - DevOps pipeline planning
258
+ - Comprehensive test strategy
259
+ - Risk assessment
260
+ - Compliance mapping
345
261
 
346
262
  ---
347
263
 
348
- ## Documentation Progression
349
-
350
- ### Level 0-1: Tech-Spec as Primary Doc
264
+ ## Planning Documents by Track
351
265
 
352
- **Why tech-spec for Level 0-1?**
266
+ ### Quick Flow Documents
353
267
 
354
- - Changes are focused and atomic
355
- - Context is specific to implementation
356
- - Speed is priority
357
- - Full product planning is overkill
268
+ **Created**: Upfront in Planning Phase
358
269
 
359
- **Tech-spec contents:**
270
+ **Tech-Spec**:
360
271
 
361
- - Technical approach
362
- - File-level changes
363
- - Implementation guide
272
+ - Problem statement and solution
273
+ - Source tree changes
274
+ - Technical implementation details
275
+ - Detected stack and conventions (brownfield)
276
+ - UX/UI considerations (if user-facing)
364
277
  - Testing strategy
365
- - **Includes UX considerations** if user-facing
366
278
 
367
- **Created:** Upfront, serves as complete planning doc
279
+ **Serves as**: Complete planning document (replaces PRD + Architecture)
368
280
 
369
281
  ---
370
282
 
371
- ### Level 2: PRD + Optional Architecture
372
-
373
- **Why PRD instead of tech-spec?**
283
+ ### BMad Method Documents
374
284
 
375
- - Multiple features need coordination
376
- - Product vision and requirements matter
377
- - Stakeholder alignment needed
378
- - Feature interdependencies exist
285
+ **Created**: Upfront in Planning and Solutioning Phases
379
286
 
380
- **PRD contents:**
287
+ **PRD (Product Requirements Document)**:
381
288
 
382
289
  - Product vision and goals
383
290
  - Feature requirements
384
- - Epics and story breakdown
291
+ - Epic breakdown with stories
385
292
  - Success criteria
386
293
  - User experience considerations
294
+ - Business context
387
295
 
388
- **Architecture (optional):**
389
-
390
- - Only if system design needed
391
- - Lightweight architectural decisions
392
- - Component interactions
393
- - Data models
394
-
395
- **Epic-tech-specs (recommended during implementation):**
396
-
397
- - Created as each epic is worked on
398
- - Detailed technical guidance per epic
399
- - Supplements PRD with implementation details
296
+ **Architecture Document**:
400
297
 
401
- **Created:** PRD upfront, epic-tech-specs during implementation
402
-
403
- ---
404
-
405
- ### Level 3-4: PRD + Architecture + Epic-Tech-Specs
406
-
407
- **Why comprehensive planning?**
408
-
409
- - Complex integrations
410
- - Multiple subsystems
411
- - Long-term maintainability
412
- - Risk management
413
- - Team coordination
414
-
415
- **PRD contents:**
416
-
417
- - Comprehensive product vision
418
- - Detailed requirements
419
- - Business objectives
420
- - Market considerations
421
- - Complete epic breakdown
422
-
423
- **Architecture (required):**
424
-
425
- - System design
426
- - Component architecture
427
- - Data models
298
+ - System components and responsibilities
299
+ - Data models and schemas
428
300
  - Integration patterns
429
- - Security design
430
- - Performance requirements
431
- - **Scales with complexity** (Level 3 vs Level 4)
432
-
433
- **Epic-tech-specs (recommended during implementation):**
434
-
435
- - Created before implementing each epic
436
- - Code-level design decisions
437
- - Epic-specific implementation approach
438
- - Detailed testing strategy
439
-
440
- **Additional design docs (as-needed):**
441
-
442
- - For novel or complex subsystems
443
- - Created during implementation
444
- - Not all created upfront
445
- - Examples: detailed integration specs, performance optimization plans
446
-
447
- **Created:** PRD + Architecture upfront, epic-tech-specs and detail docs during implementation
448
-
449
- ---
450
-
451
- ## Brownfield Projects: Document-Project First
452
-
453
- ### Critical Workflow Step
454
-
455
- 🚨 **For ALL brownfield projects (Level 0-4):**
456
-
457
- **BEFORE running any workflow:**
458
-
459
- 1. Run `document-project` workflow
460
- 2. This analyzes your codebase and creates `docs/index.md`
461
- 3. Output includes sharded documentation of:
462
- - Project structure
463
- - Key modules
464
- - Existing patterns
465
- - Dependencies
466
- - Configuration
467
-
468
- **Why it's critical:**
469
-
470
- - **Tech-spec workflow** (Level 0-1) uses this for auto-detection
471
- - **PRD workflow** (Level 2-4) references existing code
472
- - **Architecture workflow** (Level 3-4) builds on existing structure
473
- - **Epic-tech-specs** reference existing implementations
474
-
475
- ### Brownfield Workflow Pattern
476
-
477
- ```
478
- Step 1: document-project (FIRST!)
479
-
480
- Creates docs/index.md with codebase analysis
481
-
482
- Step 2: workflow-init OR tech-spec directly
483
-
484
- Uses docs/index.md for context
485
-
486
- Step 3: Continue with level-appropriate workflows
487
- ```
488
-
489
- **Without document-project:**
490
-
491
- - Workflows can't detect existing patterns
492
- - Convention analysis won't work
493
- - Integration planning is incomplete
494
- - You'll miss existing code to reuse
495
-
496
- ---
497
-
498
- ## Tech-Spec vs Epic-Tech-Spec
499
-
500
- ### When to Use Each
501
-
502
- | Document | Level | Created When | Purpose |
503
- | ------------------ | ----- | ------------------------ | ----------------------------------------------- |
504
- | **Tech-Spec** | 0-1 | Upfront (Planning Phase) | Primary planning doc for small changes/features |
505
- | **Epic-Tech-Spec** | 2-4 | During Implementation | Detailed technical guidance per epic |
506
-
507
- ### Tech-Spec (Level 0-1)
508
-
509
- **Characteristics:**
510
-
511
- - Created in Planning Phase
512
- - Serves as primary/only planning document
513
- - Comprehensive for the entire change/feature
514
- - Includes all context needed for implementation
515
- - Can include UX considerations inline
516
-
517
- **Workflow context:**
518
-
519
- ```
520
- Planning Phase: Tech-Spec created here
521
-
522
- Implementation Phase: Stories implemented using tech-spec
523
- ```
524
-
525
- ### Epic-Tech-Spec (Level 2-4)
526
-
527
- **Characteristics:**
528
-
529
- - Created in Implementation Phase
530
- - Supplements PRD + Architecture
531
- - Focused on single epic
532
- - Detailed code-level design
533
- - References architecture decisions
534
-
535
- **Workflow context:**
536
-
537
- ```
538
- Planning Phase: PRD + Architecture created here
539
-
540
- Implementation Phase:
541
- - Epic 1 starts
542
- - Create epic-tech-spec-1 (just-before-implementation)
543
- - Implement stories for epic 1
544
- - Retrospective
545
- - Epic 2 starts
546
- - Create epic-tech-spec-2
547
- - Implement stories for epic 2
548
- - Retrospective
549
- - ...
550
- ```
551
-
552
- **Why not created upfront?**
301
+ - Security architecture
302
+ - Performance considerations
303
+ - Deployment architecture
553
304
 
554
- - Implementation learnings inform later epic-tech-specs
555
- - Avoids over-planning details that may change
556
- - Keeps specs fresh and relevant
557
- - Retrospectives provide input for next epic-tech-spec
305
+ **For Brownfield**: Acts as focused "solution design" that distills existing codebase into integration plan
558
306
 
559
307
  ---
560
308
 
561
- ## Level 2 Architecture vs Tech-Spec
309
+ ### Enterprise Method Documents
562
310
 
563
- ### The Question
311
+ **Created**: Extended planning across multiple phases
564
312
 
565
- "What takes the place of architecture with Level 2 since there is no tech-spec?"
313
+ Includes all BMad Method documents PLUS:
566
314
 
567
- ### The Answer
315
+ **Security Architecture**:
568
316
 
569
- Level 2 uses **Architecture document (optional)** instead of tech-spec for system-level planning.
317
+ - Threat modeling
318
+ - Authentication/authorization design
319
+ - Data protection strategy
320
+ - Audit requirements
570
321
 
571
- **Comparison:**
322
+ **DevOps Strategy**:
572
323
 
573
- | Aspect | Tech-Spec (Level 0-1) | Architecture (Level 2) |
574
- | ------------ | ------------------------------------ | ---------------------------------- |
575
- | **Purpose** | Implementation plan for small change | System design for medium project |
576
- | **Scope** | Single change or small feature | Multiple epics and features |
577
- | **Focus** | Code-level details | System-level design |
578
- | **When** | Replaces need for PRD+Arch | Supplements PRD |
579
- | **Required** | Yes (primary doc) | Optional (if system design needed) |
324
+ - CI/CD pipeline design
325
+ - Infrastructure architecture
326
+ - Monitoring and alerting
327
+ - Disaster recovery
580
328
 
581
- **Level 2 Documentation Options:**
329
+ **Test Strategy**:
582
330
 
583
- **Option A: PRD Only (no architecture)**
584
-
585
- - For projects that don't need system design
586
- - Features are independent
587
- - No complex integrations
588
- - Example: Admin dashboard with CRUD screens
589
-
590
- **Option B: PRD + Architecture**
591
-
592
- - For projects needing system design
593
- - Components interact
594
- - Integrations exist
595
- - Example: Customer portal with notifications, webhooks, reporting
596
-
597
- **Plus Epic-Tech-Specs (recommended):**
598
-
599
- - Created during implementation
600
- - One per epic
601
- - Detailed technical guidance
602
- - References Architecture decisions (if architecture exists)
331
+ - Test approach and coverage
332
+ - Automation strategy
333
+ - Quality gates
334
+ - Performance testing
603
335
 
604
336
  ---
605
337
 
606
- ## Retrospectives in Multi-Epic Projects
607
-
608
- ### When to Run Retrospectives
609
-
610
- **Trigger:** After completing each epic in Level 2-4 projects **when there are multiple epics**
611
-
612
- **Example:**
613
-
614
- - Level 2 project with 3 epics
615
- - Complete Epic 1 → Retrospective
616
- - Complete Epic 2 → Retrospective
617
- - Complete Epic 3 → Final retrospective
618
-
619
- **Purpose:**
620
-
621
- - Capture learnings from completed epic
622
- - Identify improvements for next epic
623
- - Adjust approach based on what worked/didn't
624
- - Feed insights into next epic-tech-spec
625
-
626
- ### Retrospective Contents
627
-
628
- - What went well?
629
- - What could be improved?
630
- - Technical insights gained
631
- - Process adjustments needed
632
- - Input for next epic planning
338
+ ## Workflow Comparison
633
339
 
634
- **Output feeds into:**
340
+ | Track | Analysis | Planning | Architecture | Security/Ops | Typical Stories |
341
+ | --------------- | ----------- | --------- | ------------ | ------------ | --------------- |
342
+ | **Quick Flow** | Optional | Tech-spec | None | None | 1-15 |
343
+ | **BMad Method** | Recommended | PRD + UX | Required | None | 10-50+ |
344
+ | **Enterprise** | Required | PRD + UX | Required | Required | 30+ |
635
345
 
636
- - Next epic-tech-spec
637
- - Architecture refinements
638
- - Team process improvements
346
+ **Note**: Story counts are GUIDANCE based on typical usage, NOT definitions of tracks.
639
347
 
640
348
  ---
641
349
 
642
- ## How Level Detection Works
643
-
644
- ### Automatic Detection (workflow-init)
645
-
646
- When you run `workflow-init`, it analyzes your project description using:
647
-
648
- #### 1. **Keyword Analysis**
649
-
650
- Scans for level-specific keywords:
651
-
652
- **Level 0 Keywords:**
653
-
654
- - fix, bug, typo, small change, quick update, patch
655
-
656
- **Level 1 Keywords:**
657
-
658
- - simple, basic, small feature, add, minor
659
-
660
- **Level 2 Keywords:**
661
-
662
- - dashboard, several features, admin panel, medium
663
-
664
- **Level 3 Keywords:**
665
-
666
- - platform, integration, complex, system, architecture
667
-
668
- **Level 4 Keywords:**
669
-
670
- - enterprise, multi-tenant, multiple products, ecosystem, scale
671
-
672
- #### 2. **Story Count Estimation**
350
+ ## Brownfield Projects
673
351
 
674
- Asks about expected scope:
352
+ ### Critical First Step
675
353
 
676
- | Level | Story Range |
677
- | ------- | ------------- |
678
- | Level 0 | 1 story |
679
- | Level 1 | 1-10 stories |
680
- | Level 2 | 5-15 stories |
681
- | Level 3 | 12-40 stories |
682
- | Level 4 | 40+ stories |
354
+ For ALL brownfield projects: Run `document-project` BEFORE planning workflows.
683
355
 
684
- #### 3. **Complexity Indicators**
356
+ ### Why document-project is Critical
685
357
 
686
- - Multiple teams involved?
687
- - External integrations?
688
- - Compliance requirements?
689
- - Multi-tenant needs?
690
- - Existing system modifications? (triggers brownfield)
358
+ **Quick Flow** uses it for:
691
359
 
692
- ### Manual Override
360
+ - Auto-detecting existing patterns
361
+ - Understanding codebase structure
362
+ - Confirming conventions
693
363
 
694
- You can always override the detected level if workflow-init gets it wrong. The system is a guide, not a constraint.
364
+ **BMad Method** uses it for:
695
365
 
696
- ---
697
-
698
- ## Field Types: Greenfield vs Brownfield
699
-
700
- Each level has **two workflow paths**:
701
-
702
- ### Greenfield (New Project)
703
-
704
- - Starting from scratch
705
- - No existing codebase
706
- - Establishing new patterns
707
- - Freedom to choose stack
708
-
709
- **Special Features:**
366
+ - Architecture inputs (existing structure)
367
+ - Integration design
368
+ - Pattern consistency
710
369
 
711
- - Starter template recommendations
712
- - Modern best practices via WebSearch
713
- - Convention establishment
370
+ **Enterprise Method** uses it for:
714
371
 
715
- **Workflow:**
716
-
717
- ```
718
- workflow-init → Level detection → Greenfield path
719
- ```
720
-
721
- ### Brownfield (Existing Project)
372
+ - Security analysis
373
+ - Integration architecture
374
+ - Risk assessment
722
375
 
723
- - Adding to existing code
724
- - Working with established patterns
725
- - Integration with current systems
726
- - Stack already chosen
376
+ ### Brownfield Workflow Pattern
727
377
 
728
- **Special Features:**
378
+ ```mermaid
379
+ flowchart TD
380
+ START([Brownfield Project])
381
+ CHECK{Has docs/<br/>index.md?}
729
382
 
730
- - Auto-detects existing conventions
731
- - Analyzes current patterns
732
- - Confirms before deviating
733
- - Respects established standards
383
+ START --> CHECK
384
+ CHECK -->|No| DOC[document-project workflow<br/>10-30 min]
385
+ CHECK -->|Yes| TRACK[Choose Track]
734
386
 
735
- **Workflow:**
387
+ DOC --> TRACK
388
+ TRACK -->|Quick| QF[Tech-Spec]
389
+ TRACK -->|Method| M[PRD + Arch]
390
+ TRACK -->|Enterprise| E[PRD + Arch + Sec/Ops]
736
391
 
392
+ style DOC fill:#ffb,stroke:#333,stroke-width:2px
393
+ style TRACK fill:#bfb,stroke:#333,stroke-width:2px
737
394
  ```
738
- document-project (FIRST!) → workflow-init → Level detection → Brownfield path
739
- ```
740
-
741
- **Critical difference:** Brownfield requires document-project BEFORE any other workflow.
742
395
 
743
396
  ---
744
397
 
745
398
  ## Common Scenarios
746
399
 
747
- ### Scenario 1: Bug Fix (Level 0)
748
-
749
- **Input:** "Fix email validation bug in login form"
400
+ ### Scenario 1: Bug Fix (Quick Flow)
750
401
 
751
- **Detection:**
402
+ **Input**: "Fix email validation bug in login form"
752
403
 
753
- - Keywords: "fix", "bug"
754
- - Estimated stories: 1
404
+ **Detection**: Keywords "fix", "bug"
755
405
 
756
- **Result:** Level 0 → Greenfield-level-0.yaml
406
+ **Track**: Quick Flow
757
407
 
758
- **Workflow:**
408
+ **Workflow**:
759
409
 
760
410
  1. (Optional) Brief analysis
761
411
  2. Tech-spec with single story
762
412
  3. Implement immediately
763
413
 
764
- ---
414
+ **Time**: 2-4 hours total
765
415
 
766
- ### Scenario 2: Small Feature (Level 1)
416
+ ---
767
417
 
768
- **Input:** "Add OAuth social login (Google, GitHub, Facebook)"
418
+ ### Scenario 2: Small Feature (Quick Flow)
769
419
 
770
- **Detection:**
420
+ **Input**: "Add OAuth social login (Google, GitHub, Facebook)"
771
421
 
772
- - Keywords: "add", "feature"
773
- - Estimated stories: 2-3
422
+ **Detection**: Keywords "add", "feature", clear scope
774
423
 
775
- **Result:** Level 1 → Greenfield-level-1.yaml
424
+ **Track**: Quick Flow
776
425
 
777
- **Workflow:**
426
+ **Workflow**:
778
427
 
779
428
  1. (Optional) Research OAuth providers
780
- 2. Tech-spec with epic + 3 stories
781
- 3. (Optional) UX Design if UI is complex
782
- 4. Implement story-by-story
429
+ 2. Tech-spec with 3 stories
430
+ 3. Implement story-by-story
783
431
 
784
- ---
432
+ **Time**: 1-3 days
785
433
 
786
- ### Scenario 3: Customer Portal (Level 2)
434
+ ---
787
435
 
788
- **Input:** "Build customer portal with dashboard, tickets, billing"
436
+ ### Scenario 3: Customer Portal (BMad Method)
789
437
 
790
- **Detection:**
438
+ **Input**: "Build customer portal with dashboard, tickets, billing"
791
439
 
792
- - Keywords: "portal", "dashboard"
793
- - Estimated stories: 10-12
440
+ **Detection**: Keywords "portal", "dashboard", multiple features
794
441
 
795
- **Result:** Level 2 → Greenfield-level-2.yaml
442
+ **Track**: BMad Method
796
443
 
797
- **Workflow:**
444
+ **Workflow**:
798
445
 
799
- 1. Product Brief (recommended)
446
+ 1. (Recommended) Product Brief
800
447
  2. PRD with epics
801
- 3. (Optional) UX Design
802
- 4. (Optional) Architecture if system design needed
803
- 5. Implement with sprint planning
804
- 6. Create epic-tech-spec for each epic as you implement
805
- 7. Run retrospective after each epic
448
+ 3. (If UI) UX Design
449
+ 4. Architecture (system design)
450
+ 5. Gate Check
451
+ 6. Implement with sprint planning
806
452
 
807
- ---
453
+ **Time**: 1-2 weeks
808
454
 
809
- ### Scenario 4: E-commerce Platform (Level 3)
455
+ ---
810
456
 
811
- **Input:** "Build full e-commerce platform with products, cart, checkout, admin, analytics"
457
+ ### Scenario 4: E-commerce Platform (BMad Method)
812
458
 
813
- **Detection:**
459
+ **Input**: "Build e-commerce platform with products, cart, checkout, admin, analytics"
814
460
 
815
- - Keywords: "platform", "full"
816
- - Estimated stories: 30-35
461
+ **Detection**: Keywords "platform", multiple subsystems
817
462
 
818
- **Result:** Level 3 → Greenfield-level-3.yaml
463
+ **Track**: BMad Method
819
464
 
820
- **Workflow:**
465
+ **Workflow**:
821
466
 
822
467
  1. Research + Product Brief
823
468
  2. Comprehensive PRD
@@ -825,221 +470,130 @@ document-project (FIRST!) → workflow-init → Level detection → Brownfield p
825
470
  4. System Architecture (required)
826
471
  5. Gate check
827
472
  6. Implement with phased approach
828
- 7. Create epic-tech-spec per epic before implementing
829
- 8. Run retrospective after each epic
830
- 9. Create additional design docs as needed for complex subsystems
831
473
 
832
- ---
474
+ **Time**: 3-6 weeks
833
475
 
834
- ### Scenario 5: Adding Feature to Existing App (Brownfield)
476
+ ---
835
477
 
836
- **Input:** "Add search functionality to existing product catalog"
478
+ ### Scenario 5: Brownfield Addition (BMad Method)
837
479
 
838
- **Detection:**
480
+ **Input**: "Add search functionality to existing product catalog"
839
481
 
840
- - Keywords: "add", "existing"
841
- - Estimated stories: 3-4
842
- - Field type: Brownfield
482
+ **Detection**: Brownfield + moderate complexity
843
483
 
844
- **Result:** Level 1 Brownfield-level-1.yaml
484
+ **Track**: BMad Method (not Quick Flow)
845
485
 
846
- **Critical First Step:**
486
+ **Critical First Step**:
847
487
 
848
488
  1. **Run document-project** to analyze existing codebase
849
489
 
850
- **Then Workflow:** 2. Tech-spec (uses document-project output for analysis) 3. Auto-detects existing patterns 4. Confirms conventions 5. Implement following existing patterns
851
-
852
- ---
853
-
854
- ## Workflow Paths Configuration
490
+ **Then Workflow**: 2. PRD for search feature 3. Architecture (integration design - highly recommended) 4. Implement following existing patterns
855
491
 
856
- BMad Method stores workflow paths in YAML configuration files:
492
+ **Time**: 1-2 weeks
857
493
 
858
- ### Path File Structure
494
+ **Why Method not Quick Flow?**: Integration with existing catalog system benefits from architecture planning to ensure consistency.
859
495
 
860
- ```
861
- src/modules/bmm/workflows/workflow-status/paths/
862
- ├── greenfield-level-0.yaml
863
- ├── greenfield-level-1.yaml
864
- ├── greenfield-level-2.yaml
865
- ├── greenfield-level-3.yaml
866
- ├── greenfield-level-4.yaml
867
- ├── brownfield-level-0.yaml
868
- ├── brownfield-level-1.yaml
869
- ├── brownfield-level-2.yaml
870
- ├── brownfield-level-3.yaml
871
- ├── brownfield-level-4.yaml
872
- ├── game-design.yaml
873
- └── project-levels.yaml (source of truth)
874
- ```
496
+ ---
875
497
 
876
- ### Path File Format
877
-
878
- Each path file defines:
879
-
880
- ```yaml
881
- project_type: 'software'
882
- level: 2
883
- field_type: 'greenfield'
884
- description: 'Medium project - multiple epics'
885
-
886
- phases:
887
- - phase: 1
888
- name: 'Analysis'
889
- optional: true
890
- workflows:
891
- - id: 'brainstorm-project'
892
- optional: true
893
- agent: 'analyst'
894
- command: 'brainstorm-project'
895
-
896
- - phase: 2
897
- name: 'Planning'
898
- required: true
899
- workflows:
900
- - id: 'prd'
901
- required: true
902
- agent: 'pm'
903
- command: 'prd'
904
- output: 'Creates PRD with epics and stories'
905
- ```
498
+ ### Scenario 6: Multi-tenant Platform (Enterprise Method)
906
499
 
907
- ### Phase Structure
500
+ **Input**: "Add multi-tenancy to existing single-tenant SaaS platform"
908
501
 
909
- Each level defines **4 phases**:
502
+ **Detection**: Keywords "multi-tenant", enterprise scale
910
503
 
911
- 1. **Analysis Phase**
912
- - Brainstorming
913
- - Research
914
- - Product Brief
915
- - Complexity: Increases with level
504
+ **Track**: Enterprise Method
916
505
 
917
- 2. **Planning Phase**
918
- - Level 0-1: Tech-spec
919
- - Level 2-4: PRD + (optional/required) Architecture
506
+ **Workflow**:
920
507
 
921
- 3. **Solutioning Phase**
922
- - Level 0-2: Skipped or optional architecture
923
- - Level 3-4: Required architecture + gate checks
508
+ 1. Document-project (mandatory)
509
+ 2. Research (compliance, security)
510
+ 3. PRD (multi-tenancy requirements)
511
+ 4. Architecture (tenant isolation design)
512
+ 5. Security Architecture (data isolation, auth)
513
+ 6. DevOps Strategy (tenant provisioning, monitoring)
514
+ 7. Test Strategy (tenant isolation testing)
515
+ 8. Gate check
516
+ 9. Phased implementation
924
517
 
925
- 4. **Implementation Phase**
926
- - Sprint planning
927
- - Story-by-story development
928
- - Epic-tech-specs created per epic (Level 2-4)
929
- - Retrospectives after each epic (Level 2-4)
518
+ **Time**: 3-6 months
930
519
 
931
520
  ---
932
521
 
933
522
  ## Best Practices
934
523
 
935
- ### 1. **Document-Project First for Brownfield**
524
+ ### 1. Document-Project First for Brownfield
936
525
 
937
- Always run document-project before starting any brownfield workflow. This is critical for context.
526
+ Always run `document-project` before starting brownfield planning. AI agents need existing codebase context.
938
527
 
939
- ### 2. **Trust the Detection**
528
+ ### 2. Trust the Recommendation
940
529
 
941
- If workflow-init suggests Level 2, there's probably complexity you haven't considered. Review before overriding.
530
+ If `workflow-init` suggests BMad Method, there's probably complexity you haven't considered. Review carefully before overriding.
942
531
 
943
- ### 3. **Start Small, Upgrade Later**
532
+ ### 3. Start Smaller if Uncertain
944
533
 
945
- Uncertain between Level 1 and 2? Start with Level 1. You can always run PRD creation later if needed.
534
+ Uncertain between Quick Flow and Method? Start with Quick Flow. You can create PRD later if needed.
946
535
 
947
- ### 4. **Don't Skip Gate Checks**
536
+ ### 4. Don't Skip Gate Checks
948
537
 
949
- For Level 3-4, gate checks prevent costly mistakes. Invest the time upfront.
538
+ For BMad Method and Enterprise, gate checks prevent costly mistakes. Invest the time.
950
539
 
951
- ### 5. **Create Epic-Tech-Specs Just-Before-Implementation**
540
+ ### 5. Architecture is Optional but Recommended for Brownfield
952
541
 
953
- For Level 2-4, create epic-tech-spec right before implementing each epic. Don't create all upfront.
542
+ Brownfield BMad Method makes architecture optional, but it's highly recommended. It distills complex codebase into focused solution design.
954
543
 
955
- ### 6. **Run Retrospectives Between Epics**
544
+ ### 6. Discovery Phase Based on Need
956
545
 
957
- Capture learnings after each epic. Feed insights into next epic-tech-spec.
546
+ Brainstorming and research are offered regardless of track. Use them when you need to think through the problem space.
958
547
 
959
- ### 7. **Optional UX for Level 1**
548
+ ### 7. Product Brief for Greenfield Method
960
549
 
961
- If your Level 1 feature has complex UI, run separate UX Design. Otherwise, include UX notes in tech-spec.
962
-
963
- ### 8. **Architecture Scales**
964
-
965
- Level 2 architecture is lighter than Level 3, which is lighter than Level 4. Don't over-architect.
550
+ Product Brief is only offered for greenfield BMad Method and Enterprise. It's optional but helps with strategic thinking.
966
551
 
967
552
  ---
968
553
 
969
- ## FAQ
970
-
971
- ### Q: What's the difference between tech-spec and epic-tech-spec?
972
-
973
- **A:**
974
-
975
- - **Tech-spec (Level 0-1):** Created upfront in Planning Phase, serves as primary planning doc
976
- - **Epic-tech-spec (Level 2-4):** Created during Implementation Phase per epic, supplements PRD + Architecture
977
-
978
- ### Q: Why no tech-spec at Level 2+?
554
+ ## Key Differences from Legacy System
979
555
 
980
- **A:** At Level 2+, you need product-level planning (PRD) and optionally system-level design (Architecture). Tech-spec is too narrow. Instead, use epic-tech-specs during implementation for detailed technical guidance per epic.
556
+ ### Old System (Levels 0-4)
981
557
 
982
- ### Q: Do I always need Architecture at Level 2?
558
+ - Arbitrary story count thresholds
559
+ - Level 2 vs Level 3 based on story count
560
+ - Confusing overlap zones (5-10 stories, 12-40 stories)
561
+ - Tech-spec and PRD shown as conflicting options
983
562
 
984
- **A:** No, it's optional. Only create Architecture if you need system-level design. Many Level 2 projects can work with just PRD + epic-tech-specs.
563
+ ### New System (3 Tracks)
985
564
 
986
- ### Q: What if I forget to run document-project on brownfield?
987
-
988
- **A:** Workflows will lack context about existing code. Run document-project and restart your workflow to get proper brownfield analysis.
989
-
990
- ### Q: Can Level 1 include UX Design?
991
-
992
- **A:** Yes! You can either:
993
-
994
- - Include UX considerations in the tech-spec (simpler)
995
- - Run separate UX Design workflow (complex UI)
996
-
997
- ### Q: When do I create additional design documents?
998
-
999
- **A:** Create them during implementation as-needed for:
1000
-
1001
- - Very novel technical approaches
1002
- - Complex subsystems needing detailed design
1003
- - Integration specifications
1004
- - Performance optimization plans
1005
-
1006
- Don't create them all upfront - create just-before-needed.
1007
-
1008
- ### Q: Can I change levels mid-project?
1009
-
1010
- **A:** Yes! If you started at Level 1 but realize it's Level 2, you can run `create-prd` to add proper planning docs. The system is flexible.
565
+ - Methodology-based distinction (not story counts)
566
+ - Story counts as guidance, not definitions
567
+ - Clear track purposes:
568
+ - Quick Flow = Implementation-focused
569
+ - BMad Method = Product + system design
570
+ - Enterprise = Extended with security/ops
571
+ - Mutually exclusive paths chosen upfront
572
+ - Educational decision-making
1011
573
 
1012
574
  ---
1013
575
 
1014
- ## Summary
1015
-
1016
- The Scale Adaptive System ensures:
1017
-
1018
- ✅ **Level 0-1:** Fast, lean, tech-spec only → Quick Spec Flow
1019
- ✅ **Level 2:** Structured, PRD-driven, optional architecture, epic-tech-specs during implementation
1020
- ✅ **Level 3-4:** Comprehensive, PRD + Architecture required, epic-tech-specs per epic, gate checks
576
+ ## Migration from Old System
1021
577
 
1022
- **Key Principles:**
578
+ If you have existing projects using the old level system:
1023
579
 
1024
- - Match planning depth to project complexity
1025
- - Tech-spec for Level 0-1, PRD + Architecture for Level 2-4
1026
- - Epic-tech-specs supplement Level 2-4 during implementation
1027
- - Document-project FIRST for all brownfield projects
1028
- - Create detailed docs just-before-needed, not all upfront
580
+ - **Level 0-1** Quick Flow
581
+ - **Level 2-3** BMad Method
582
+ - **Level 4** Enterprise Method
1029
583
 
1030
- **Result:** Right amount of ceremony for every project, maximum efficiency at every scale.
584
+ Run `workflow-init` on existing projects to migrate to new tracking system. It detects existing planning artifacts and creates appropriate workflow tracking.
1031
585
 
1032
586
  ---
1033
587
 
1034
- ## Learn More
588
+ ## Related Documentation
1035
589
 
1036
- - **Quick Spec Flow (Level 0-1):** [quick-spec-flow.md](./quick-spec-flow.md)
1037
- - **Full BMM Workflows (Level 2-4):** [../workflows/README.md](../workflows/README.md)
1038
- - **Document-Project Workflow:** Ask SM agent to run document-project
1039
- - **Run workflow-init:** Load PM agent and ask to run workflow-init
1040
- - **Path Configuration:** `../workflows/workflow-status/paths/`
1041
- - **Level Definitions:** `../workflows/workflow-status/project-levels.yaml`
590
+ - **[Quick Start Guide](./quick-start.md)** - Get started with BMM
591
+ - **[Quick Spec Flow](./quick-spec-flow.md)** - Details on Quick Flow track
592
+ - **[Brownfield Guide](./brownfield-guide.md)** - Existing codebase workflows
593
+ - **[Glossary](./glossary.md)** - Complete terminology
594
+ - **[FAQ](./faq.md)** - Common questions
595
+ - **[Workflows Guide](../workflows/README.md)** - Complete workflow reference
1042
596
 
1043
597
  ---
1044
598
 
1045
- _Scale Adaptive System - Because one size doesn't fit all._
599
+ _Scale Adaptive System - Right planning depth for every project._