bmad-method 6.0.0-alpha.4 → 6.0.0-alpha.6

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 (225) hide show
  1. package/.claude/agents/bmad-analysis/api-documenter.md +102 -0
  2. package/.claude/agents/bmad-analysis/codebase-analyzer.md +82 -0
  3. package/.claude/agents/bmad-analysis/data-analyst.md +101 -0
  4. package/.claude/agents/bmad-analysis/pattern-detector.md +84 -0
  5. package/.claude/agents/bmad-planning/dependency-mapper.md +83 -0
  6. package/.claude/agents/bmad-planning/epic-optimizer.md +81 -0
  7. package/.claude/agents/bmad-planning/requirements-analyst.md +61 -0
  8. package/.claude/agents/bmad-planning/technical-decisions-curator.md +168 -0
  9. package/.claude/agents/bmad-planning/trend-spotter.md +115 -0
  10. package/.claude/agents/bmad-planning/user-journey-mapper.md +123 -0
  11. package/.claude/agents/bmad-planning/user-researcher.md +72 -0
  12. package/.claude/agents/bmad-research/market-researcher.md +51 -0
  13. package/.claude/agents/bmad-research/tech-debt-auditor.md +106 -0
  14. package/.claude/agents/bmad-review/document-reviewer.md +102 -0
  15. package/.claude/agents/bmad-review/technical-evaluator.md +68 -0
  16. package/.claude/agents/bmad-review/test-coverage-analyzer.md +108 -0
  17. package/.claude/commands/bmad/bmm/agents/architect.md +0 -1
  18. package/.claude/commands/bmad/bmm/agents/sm.md +1 -1
  19. package/.claude/commands/bmad/bmm/agents/{paige.md → tech-writer.md} +3 -3
  20. package/.claude/commands/bmad/bmm/workflows/README.md +3 -3
  21. package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +15 -0
  22. package/.claude/commands/bmad/bmm/workflows/prd.md +1 -1
  23. package/.claude/commands/bmad/bmm/workflows/tech-spec.md +3 -3
  24. package/.claude/settings.local.json +3 -8
  25. package/CHANGELOG.md +305 -0
  26. package/CONTRIBUTING.md +1 -13
  27. package/README.md +88 -39
  28. package/bmad/_cfg/agent-manifest.csv +1 -6
  29. package/bmad/_cfg/files-manifest.csv +40 -114
  30. package/bmad/_cfg/ides/claude-code.yaml +4 -3
  31. package/bmad/_cfg/manifest.yaml +3 -4
  32. package/bmad/_cfg/task-manifest.csv +0 -1
  33. package/bmad/_cfg/workflow-manifest.csv +3 -7
  34. package/bmad/bmb/config.yaml +2 -2
  35. package/bmad/bmb/workflows/audit-workflow/instructions.md +1 -1
  36. package/bmad/bmm/README.md +79 -120
  37. package/bmad/bmm/agents/architect.md +0 -1
  38. package/bmad/bmm/agents/sm.md +1 -1
  39. package/bmad/bmm/agents/{paige.md → tech-writer.md} +3 -3
  40. package/bmad/bmm/config.yaml +4 -3
  41. package/bmad/bmm/tasks/daily-standup.xml +1 -1
  42. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
  43. package/bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
  44. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
  45. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
  46. package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
  47. package/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
  48. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +1 -1
  49. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
  50. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
  51. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
  52. package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
  53. package/bmad/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
  54. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
  55. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
  56. package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
  57. package/bmad/bmm/workflows/techdoc/documentation-standards.md +26 -2
  58. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +2 -2
  59. package/bmad/bmm/workflows/workflow-status/init/instructions.md +623 -242
  60. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
  61. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
  62. package/bmad/bmm/workflows/workflow-status/paths/{brownfield-level-3.yaml → method-brownfield.yaml} +33 -31
  63. package/{src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
  64. package/bmad/bmm/workflows/workflow-status/paths/{brownfield-level-1.yaml → quick-flow-brownfield.yaml} +18 -18
  65. package/bmad/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  66. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
  67. package/bmad/core/config.yaml +2 -2
  68. package/bmad/core/tasks/workflow.xml +1 -11
  69. package/package.json +1 -1
  70. package/src/core/tasks/workflow.xml +1 -11
  71. package/src/modules/bmb/workflows/audit-workflow/instructions.md +1 -1
  72. package/src/modules/bmm/README.md +1 -1
  73. package/src/modules/bmm/_module-installer/install-config.yaml +5 -0
  74. package/src/modules/bmm/agents/architect.agent.yaml +0 -4
  75. package/src/modules/bmm/agents/game-dev.agent.yaml +8 -12
  76. package/src/modules/bmm/agents/sm.agent.yaml +1 -1
  77. package/src/modules/bmm/agents/{paige.agent.yaml → tech-writer.agent.yaml} +4 -4
  78. package/src/modules/bmm/docs/README.md +19 -18
  79. package/src/modules/bmm/docs/agents-guide.md +47 -99
  80. package/src/modules/bmm/docs/brownfield-guide.md +216 -96
  81. package/src/modules/bmm/docs/enterprise-agentic-development.md +380 -740
  82. package/src/modules/bmm/docs/faq.md +16 -16
  83. package/src/modules/bmm/docs/glossary.md +44 -50
  84. package/src/modules/bmm/docs/party-mode.md +110 -1122
  85. package/src/modules/bmm/docs/quick-spec-flow.md +36 -36
  86. package/src/modules/bmm/docs/quick-start.md +34 -34
  87. package/src/modules/bmm/docs/scale-adaptive-system.md +304 -454
  88. package/{bmad/bmm/testarch/README.md → src/modules/bmm/docs/test-architecture.md} +56 -38
  89. package/src/modules/bmm/docs/troubleshooting.md +7 -7
  90. package/src/modules/bmm/docs/workflows-analysis.md +64 -28
  91. package/src/modules/bmm/docs/workflows-implementation.md +196 -1671
  92. package/src/modules/bmm/docs/workflows-planning.md +74 -35
  93. package/src/modules/bmm/docs/workflows-solutioning.md +47 -17
  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 +25 -2
  111. package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md +2 -2
  112. package/src/modules/bmm/workflows/workflow-status/init/instructions.md +623 -242
  113. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
  114. package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
  115. package/src/modules/bmm/workflows/workflow-status/paths/{brownfield-level-3.yaml → method-brownfield.yaml} +33 -31
  116. package/{bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
  117. package/src/modules/bmm/workflows/workflow-status/paths/{brownfield-level-1.yaml → quick-flow-brownfield.yaml} +18 -18
  118. package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
  119. package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
  120. package/tools/cli/installers/lib/core/config-collector.js +39 -11
  121. package/tools/cli/installers/lib/core/ide-config-manager.js +3 -1
  122. package/tools/cli/installers/lib/core/installer.js +20 -9
  123. package/tools/cli/installers/lib/core/manifest-generator.js +3 -1
  124. package/tools/cli/installers/lib/core/manifest.js +6 -2
  125. package/tools/cli/installers/lib/modules/manager.js +6 -0
  126. package/tools/cli/lib/config.js +3 -1
  127. package/tools/cli/lib/ui.js +5 -5
  128. package/tools/cli/lib/yaml-format.js +2 -1
  129. package/tools/schema/agent.js +2 -0
  130. package/.claude/commands/bmad/bmm/workflows/tech-spec-sm.md +0 -15
  131. package/bmad/_cfg/agents/cis-brainstorming-coach.customize.yaml +0 -42
  132. package/bmad/_cfg/agents/cis-creative-problem-solver.customize.yaml +0 -42
  133. package/bmad/_cfg/agents/cis-design-thinking-coach.customize.yaml +0 -42
  134. package/bmad/_cfg/agents/cis-innovation-strategist.customize.yaml +0 -42
  135. package/bmad/_cfg/agents/cis-storyteller.customize.yaml +0 -42
  136. package/bmad/bmb/agents/bmad-builder.md.bak +0 -70
  137. package/bmad/bmb/workflows/audit-workflow/workflow.yaml.bak +0 -23
  138. package/bmad/bmb/workflows/create-module/workflow.yaml.bak +0 -42
  139. package/bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml.bak +0 -39
  140. package/bmad/bmb/workflows/create-workflow/workflow.yaml.bak +0 -40
  141. package/bmad/bmb/workflows/edit-agent/workflow.yaml.bak +0 -33
  142. package/bmad/bmb/workflows/edit-module/workflow.yaml.bak +0 -34
  143. package/bmad/bmb/workflows/edit-workflow/workflow.yaml.bak +0 -27
  144. package/bmad/bmb/workflows/module-brief/workflow.yaml.bak +0 -29
  145. package/bmad/bmb/workflows/redoc/workflow.yaml.bak +0 -32
  146. package/bmad/bmm/docs/brownfield-guide.md +0 -1260
  147. package/bmad/bmm/docs/quick-spec-flow.md +0 -645
  148. package/bmad/bmm/docs/quick-start.md +0 -341
  149. package/bmad/bmm/docs/scale-adaptive-system.md +0 -1045
  150. package/bmad/bmm/tasks/retrospective.xml +0 -104
  151. package/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -113
  152. package/bmad/bmm/workflows/1-analysis/product-brief/README.md +0 -180
  153. package/bmad/bmm/workflows/1-analysis/research/README.md +0 -454
  154. package/bmad/bmm/workflows/2-plan-workflows/README.md +0 -258
  155. package/bmad/bmm/workflows/3-solutioning/README.md +0 -1
  156. package/bmad/bmm/workflows/3-solutioning/architecture/README.md +0 -318
  157. package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
  158. package/bmad/bmm/workflows/4-implementation/README.md +0 -221
  159. package/bmad/bmm/workflows/4-implementation/code-review/README.md +0 -69
  160. package/bmad/bmm/workflows/4-implementation/correct-course/README.md +0 -73
  161. package/bmad/bmm/workflows/4-implementation/create-story/README.md +0 -146
  162. package/bmad/bmm/workflows/4-implementation/dev-story/README.md +0 -206
  163. package/bmad/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
  164. package/bmad/bmm/workflows/4-implementation/retrospective/README.md +0 -77
  165. package/bmad/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
  166. package/bmad/bmm/workflows/4-implementation/story-context/README.md +0 -234
  167. package/bmad/bmm/workflows/README.md +0 -256
  168. package/bmad/bmm/workflows/document-project/README.md +0 -444
  169. package/bmad/bmm/workflows/document-project/templates/README.md +0 -38
  170. package/bmad/bmm/workflows/testarch/README.md +0 -26
  171. package/bmad/bmm/workflows/testarch/atdd/README.md +0 -672
  172. package/bmad/bmm/workflows/testarch/automate/README.md +0 -869
  173. package/bmad/bmm/workflows/testarch/ci/README.md +0 -493
  174. package/bmad/bmm/workflows/testarch/framework/README.md +0 -340
  175. package/bmad/bmm/workflows/testarch/nfr-assess/README.md +0 -469
  176. package/bmad/bmm/workflows/testarch/test-design/README.md +0 -493
  177. package/bmad/bmm/workflows/testarch/test-review/README.md +0 -775
  178. package/bmad/bmm/workflows/testarch/trace/README.md +0 -802
  179. package/bmad/bmm/workflows/workflow-status/README.md +0 -260
  180. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  181. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  182. package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  183. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  184. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  185. package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  186. package/bmad/cis/README.md +0 -153
  187. package/bmad/cis/agents/README.md +0 -104
  188. package/bmad/cis/agents/brainstorming-coach.md +0 -62
  189. package/bmad/cis/agents/creative-problem-solver.md +0 -62
  190. package/bmad/cis/agents/design-thinking-coach.md +0 -62
  191. package/bmad/cis/agents/innovation-strategist.md +0 -62
  192. package/bmad/cis/agents/storyteller.md +0 -59
  193. package/bmad/cis/config.yaml +0 -10
  194. package/bmad/cis/teams/creative-squad.yaml +0 -6
  195. package/bmad/cis/workflows/README.md +0 -139
  196. package/bmad/cis/workflows/design-thinking/README.md +0 -56
  197. package/bmad/cis/workflows/design-thinking/design-methods.csv +0 -31
  198. package/bmad/cis/workflows/design-thinking/instructions.md +0 -200
  199. package/bmad/cis/workflows/design-thinking/template.md +0 -111
  200. package/bmad/cis/workflows/design-thinking/workflow.yaml +0 -32
  201. package/bmad/cis/workflows/innovation-strategy/README.md +0 -56
  202. package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +0 -31
  203. package/bmad/cis/workflows/innovation-strategy/instructions.md +0 -274
  204. package/bmad/cis/workflows/innovation-strategy/template.md +0 -189
  205. package/bmad/cis/workflows/innovation-strategy/workflow.yaml +0 -32
  206. package/bmad/cis/workflows/problem-solving/README.md +0 -56
  207. package/bmad/cis/workflows/problem-solving/instructions.md +0 -250
  208. package/bmad/cis/workflows/problem-solving/solving-methods.csv +0 -31
  209. package/bmad/cis/workflows/problem-solving/template.md +0 -165
  210. package/bmad/cis/workflows/problem-solving/workflow.yaml +0 -32
  211. package/bmad/cis/workflows/storytelling/README.md +0 -58
  212. package/bmad/cis/workflows/storytelling/instructions.md +0 -291
  213. package/bmad/cis/workflows/storytelling/story-types.csv +0 -26
  214. package/bmad/cis/workflows/storytelling/template.md +0 -113
  215. package/bmad/cis/workflows/storytelling/workflow.yaml +0 -32
  216. package/bmad/core/agents/bmad-master.md.bak +0 -69
  217. package/src/modules/bmm/docs/brownfield-guide.md.backup +0 -1324
  218. package/src/modules/bmm/docs/workflows-testing.md +0 -1572
  219. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
  220. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
  221. package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
  222. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
  223. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
  224. package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
  225. /package/bmad/_cfg/agents/{bmm-paige.customize.yaml → bmm-tech-writer.customize.yaml} +0 -0
@@ -1,1045 +0,0 @@
1
- # BMad Method Scale Adaptive System
2
-
3
- **Automatically adapts workflows to project complexity - from bug fixes to enterprise systems**
4
-
5
- ---
6
-
7
- ## Overview
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.
10
-
11
- ### The Problem It Solves
12
-
13
- Traditional methodologies apply the same process to every project:
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
18
-
19
- ### The Solution
20
-
21
- BMad Method **adapts workflows to match project scale**:
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
26
-
27
- **Result:** Right amount of planning for every project - no more, no less.
28
-
29
- ---
30
-
31
- ## Key Terminology
32
-
33
- ### Analysis Phase
34
-
35
- **What it is:** Discovery and research phase that informs planning decisions.
36
-
37
- **Activities:**
38
-
39
- - **Brainstorming:** Ideation and creative exploration
40
- - **Research:** Market analysis, technical investigation, user research
41
- - **Product Brief:** High-level vision and requirements capture
42
-
43
- **When used:**
44
-
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)
48
-
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:**
66
-
67
- - **Level 0:** Single story technical plan
68
- - **Level 1:** Feature technical plan with epic
69
- - **Level 2-4:** Not used (PRD + Architecture instead)
70
-
71
- **Replacement at Level 2+:** Tech-spec is **replaced by PRD + Architecture** for proper product and system planning.
72
-
73
- ---
74
-
75
- ### Epic-Tech-Spec (Epic Technical Specification)
76
-
77
- **What it is:** Detailed technical planning document created **during implementation** for each epic in Level 2-4 projects.
78
-
79
- **Difference from Tech-Spec:**
80
-
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
83
-
84
- **Contents:**
85
-
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
91
-
92
- **When used:**
93
-
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
101
-
102
- ---
103
-
104
- ### Architecture Document
105
-
106
- **What it is:** System-wide design document that defines structure, components, and interactions.
107
-
108
- **Scale-Adaptive:**
109
-
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
114
-
115
- **Contents:**
116
-
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
124
-
125
- **Note:** Architecture document takes the place of tech-spec for system-level planning in Level 2-4 projects.
126
-
127
- ---
128
-
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)**
143
-
144
- **Why it matters:**
145
-
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
150
-
151
- **When to run:**
152
-
153
- - Before workflow-init for brownfield projects
154
- - When joining an existing codebase
155
- - After major refactors (to update docs)
156
-
157
- ---
158
-
159
- ## The Five Levels
160
-
161
- ### Level 0: Single Atomic Change
162
-
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:**
174
-
175
- ```
176
- (Brownfield: document-project first)
177
-
178
- Analysis (optional) → Tech-Spec → Implement
179
- ```
180
-
181
- **Keywords:** fix, bug, typo, small change, quick update, patch
182
-
183
- ---
184
-
185
- ### Level 1: Small Feature
186
-
187
- **Examples:** OAuth login, search feature, user profile page
188
-
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) |
197
-
198
- **Workflow:**
199
-
200
- ```
201
- (Brownfield: document-project first)
202
-
203
- Analysis (optional) → Tech-Spec + Epic → (Optional UX Design) → Implement
204
- ```
205
-
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.
207
-
208
- **Keywords:** simple, basic, small feature, add, minor
209
-
210
- ---
211
-
212
- ### Level 2: Medium Project
213
-
214
- **Examples:** Admin dashboard, customer portal, reporting system
215
-
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) |
225
-
226
- **Workflow:**
227
-
228
- ```
229
- (Brownfield: document-project first)
230
-
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)
236
- ```
237
-
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.
241
-
242
- **Retrospectives:** After completing each epic (when there are multiple), run retrospective to capture learnings before starting the next epic.
243
-
244
- **Keywords:** dashboard, several features, admin panel, medium
245
-
246
- ---
247
-
248
- ### Level 3: Complex System
249
-
250
- **Examples:** E-commerce platform, SaaS product, multi-module system
251
-
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) |
262
-
263
- **Workflow:**
264
-
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
- ```
274
-
275
- **Gate Check:** Validates PRD + UX + Architecture cohesion before starting implementation. Prevents costly rework.
276
-
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.
278
-
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.
280
-
281
- **Keywords:** platform, integration, complex, system, architecture
282
-
283
- ---
284
-
285
- ### Level 4: Enterprise Scale
286
-
287
- **Examples:** Multi-product suite, enterprise ecosystem, platform with multiple apps
288
-
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) |
299
-
300
- **Workflow:**
301
-
302
- ```
303
- (Brownfield: document-project first)
304
-
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
312
- ```
313
-
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
322
-
323
- **Additional Design Documents:** For enterprise complexity, you may need supplementary technical documents:
324
-
325
- - Detailed subsystem designs
326
- - Integration specifications
327
- - Performance optimization plans
328
- - Security implementation guides
329
-
330
- These are created **during implementation** as needed, not all upfront.
331
-
332
- **Keywords:** enterprise, multi-tenant, multiple products, ecosystem, scale
333
-
334
- ---
335
-
336
- ## Workflow Comparison
337
-
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 |
345
-
346
- ---
347
-
348
- ## Documentation Progression
349
-
350
- ### Level 0-1: Tech-Spec as Primary Doc
351
-
352
- **Why tech-spec for Level 0-1?**
353
-
354
- - Changes are focused and atomic
355
- - Context is specific to implementation
356
- - Speed is priority
357
- - Full product planning is overkill
358
-
359
- **Tech-spec contents:**
360
-
361
- - Technical approach
362
- - File-level changes
363
- - Implementation guide
364
- - Testing strategy
365
- - **Includes UX considerations** if user-facing
366
-
367
- **Created:** Upfront, serves as complete planning doc
368
-
369
- ---
370
-
371
- ### Level 2: PRD + Optional Architecture
372
-
373
- **Why PRD instead of tech-spec?**
374
-
375
- - Multiple features need coordination
376
- - Product vision and requirements matter
377
- - Stakeholder alignment needed
378
- - Feature interdependencies exist
379
-
380
- **PRD contents:**
381
-
382
- - Product vision and goals
383
- - Feature requirements
384
- - Epics and story breakdown
385
- - Success criteria
386
- - User experience considerations
387
-
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
400
-
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
428
- - 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?**
553
-
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
558
-
559
- ---
560
-
561
- ## Level 2 Architecture vs Tech-Spec
562
-
563
- ### The Question
564
-
565
- "What takes the place of architecture with Level 2 since there is no tech-spec?"
566
-
567
- ### The Answer
568
-
569
- Level 2 uses **Architecture document (optional)** instead of tech-spec for system-level planning.
570
-
571
- **Comparison:**
572
-
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) |
580
-
581
- **Level 2 Documentation Options:**
582
-
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)
603
-
604
- ---
605
-
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
633
-
634
- **Output feeds into:**
635
-
636
- - Next epic-tech-spec
637
- - Architecture refinements
638
- - Team process improvements
639
-
640
- ---
641
-
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**
673
-
674
- Asks about expected scope:
675
-
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 |
683
-
684
- #### 3. **Complexity Indicators**
685
-
686
- - Multiple teams involved?
687
- - External integrations?
688
- - Compliance requirements?
689
- - Multi-tenant needs?
690
- - Existing system modifications? (triggers brownfield)
691
-
692
- ### Manual Override
693
-
694
- You can always override the detected level if workflow-init gets it wrong. The system is a guide, not a constraint.
695
-
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:**
710
-
711
- - Starter template recommendations
712
- - Modern best practices via WebSearch
713
- - Convention establishment
714
-
715
- **Workflow:**
716
-
717
- ```
718
- workflow-init → Level detection → Greenfield path
719
- ```
720
-
721
- ### Brownfield (Existing Project)
722
-
723
- - Adding to existing code
724
- - Working with established patterns
725
- - Integration with current systems
726
- - Stack already chosen
727
-
728
- **Special Features:**
729
-
730
- - Auto-detects existing conventions
731
- - Analyzes current patterns
732
- - Confirms before deviating
733
- - Respects established standards
734
-
735
- **Workflow:**
736
-
737
- ```
738
- document-project (FIRST!) → workflow-init → Level detection → Brownfield path
739
- ```
740
-
741
- **Critical difference:** Brownfield requires document-project BEFORE any other workflow.
742
-
743
- ---
744
-
745
- ## Common Scenarios
746
-
747
- ### Scenario 1: Bug Fix (Level 0)
748
-
749
- **Input:** "Fix email validation bug in login form"
750
-
751
- **Detection:**
752
-
753
- - Keywords: "fix", "bug"
754
- - Estimated stories: 1
755
-
756
- **Result:** Level 0 → Greenfield-level-0.yaml
757
-
758
- **Workflow:**
759
-
760
- 1. (Optional) Brief analysis
761
- 2. Tech-spec with single story
762
- 3. Implement immediately
763
-
764
- ---
765
-
766
- ### Scenario 2: Small Feature (Level 1)
767
-
768
- **Input:** "Add OAuth social login (Google, GitHub, Facebook)"
769
-
770
- **Detection:**
771
-
772
- - Keywords: "add", "feature"
773
- - Estimated stories: 2-3
774
-
775
- **Result:** Level 1 → Greenfield-level-1.yaml
776
-
777
- **Workflow:**
778
-
779
- 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
783
-
784
- ---
785
-
786
- ### Scenario 3: Customer Portal (Level 2)
787
-
788
- **Input:** "Build customer portal with dashboard, tickets, billing"
789
-
790
- **Detection:**
791
-
792
- - Keywords: "portal", "dashboard"
793
- - Estimated stories: 10-12
794
-
795
- **Result:** Level 2 → Greenfield-level-2.yaml
796
-
797
- **Workflow:**
798
-
799
- 1. Product Brief (recommended)
800
- 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
806
-
807
- ---
808
-
809
- ### Scenario 4: E-commerce Platform (Level 3)
810
-
811
- **Input:** "Build full e-commerce platform with products, cart, checkout, admin, analytics"
812
-
813
- **Detection:**
814
-
815
- - Keywords: "platform", "full"
816
- - Estimated stories: 30-35
817
-
818
- **Result:** Level 3 → Greenfield-level-3.yaml
819
-
820
- **Workflow:**
821
-
822
- 1. Research + Product Brief
823
- 2. Comprehensive PRD
824
- 3. UX Design (recommended)
825
- 4. System Architecture (required)
826
- 5. Gate check
827
- 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
-
832
- ---
833
-
834
- ### Scenario 5: Adding Feature to Existing App (Brownfield)
835
-
836
- **Input:** "Add search functionality to existing product catalog"
837
-
838
- **Detection:**
839
-
840
- - Keywords: "add", "existing"
841
- - Estimated stories: 3-4
842
- - Field type: Brownfield
843
-
844
- **Result:** Level 1 → Brownfield-level-1.yaml
845
-
846
- **Critical First Step:**
847
-
848
- 1. **Run document-project** to analyze existing codebase
849
-
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
855
-
856
- BMad Method stores workflow paths in YAML configuration files:
857
-
858
- ### Path File Structure
859
-
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
- ```
875
-
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
- ```
906
-
907
- ### Phase Structure
908
-
909
- Each level defines **4 phases**:
910
-
911
- 1. **Analysis Phase**
912
- - Brainstorming
913
- - Research
914
- - Product Brief
915
- - Complexity: Increases with level
916
-
917
- 2. **Planning Phase**
918
- - Level 0-1: Tech-spec
919
- - Level 2-4: PRD + (optional/required) Architecture
920
-
921
- 3. **Solutioning Phase**
922
- - Level 0-2: Skipped or optional architecture
923
- - Level 3-4: Required architecture + gate checks
924
-
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)
930
-
931
- ---
932
-
933
- ## Best Practices
934
-
935
- ### 1. **Document-Project First for Brownfield**
936
-
937
- Always run document-project before starting any brownfield workflow. This is critical for context.
938
-
939
- ### 2. **Trust the Detection**
940
-
941
- If workflow-init suggests Level 2, there's probably complexity you haven't considered. Review before overriding.
942
-
943
- ### 3. **Start Small, Upgrade Later**
944
-
945
- Uncertain between Level 1 and 2? Start with Level 1. You can always run PRD creation later if needed.
946
-
947
- ### 4. **Don't Skip Gate Checks**
948
-
949
- For Level 3-4, gate checks prevent costly mistakes. Invest the time upfront.
950
-
951
- ### 5. **Create Epic-Tech-Specs Just-Before-Implementation**
952
-
953
- For Level 2-4, create epic-tech-spec right before implementing each epic. Don't create all upfront.
954
-
955
- ### 6. **Run Retrospectives Between Epics**
956
-
957
- Capture learnings after each epic. Feed insights into next epic-tech-spec.
958
-
959
- ### 7. **Optional UX for Level 1**
960
-
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.
966
-
967
- ---
968
-
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+?
979
-
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.
981
-
982
- ### Q: Do I always need Architecture at Level 2?
983
-
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.
985
-
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.
1011
-
1012
- ---
1013
-
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
1021
-
1022
- **Key Principles:**
1023
-
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
1029
-
1030
- **Result:** Right amount of ceremony for every project, maximum efficiency at every scale.
1031
-
1032
- ---
1033
-
1034
- ## Learn More
1035
-
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`
1042
-
1043
- ---
1044
-
1045
- _Scale Adaptive System - Because one size doesn't fit all._