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.
- package/.claude/agents/bmad-analysis/api-documenter.md +102 -0
- package/.claude/agents/bmad-analysis/codebase-analyzer.md +82 -0
- package/.claude/agents/bmad-analysis/data-analyst.md +101 -0
- package/.claude/agents/bmad-analysis/pattern-detector.md +84 -0
- package/.claude/agents/bmad-planning/dependency-mapper.md +83 -0
- package/.claude/agents/bmad-planning/epic-optimizer.md +81 -0
- package/.claude/agents/bmad-planning/requirements-analyst.md +61 -0
- package/.claude/agents/bmad-planning/technical-decisions-curator.md +168 -0
- package/.claude/agents/bmad-planning/trend-spotter.md +115 -0
- package/.claude/agents/bmad-planning/user-journey-mapper.md +123 -0
- package/.claude/agents/bmad-planning/user-researcher.md +72 -0
- package/.claude/agents/bmad-research/market-researcher.md +51 -0
- package/.claude/agents/bmad-research/tech-debt-auditor.md +106 -0
- package/.claude/agents/bmad-review/document-reviewer.md +102 -0
- package/.claude/agents/bmad-review/technical-evaluator.md +68 -0
- package/.claude/agents/bmad-review/test-coverage-analyzer.md +108 -0
- package/.claude/commands/bmad/bmm/agents/architect.md +0 -1
- package/.claude/commands/bmad/bmm/agents/sm.md +1 -1
- package/.claude/commands/bmad/bmm/agents/{paige.md → tech-writer.md} +3 -3
- package/.claude/commands/bmad/bmm/workflows/README.md +3 -3
- package/.claude/commands/bmad/bmm/workflows/epic-tech-context.md +15 -0
- package/.claude/commands/bmad/bmm/workflows/prd.md +1 -1
- package/.claude/commands/bmad/bmm/workflows/tech-spec.md +3 -3
- package/.claude/settings.local.json +3 -8
- package/CHANGELOG.md +305 -0
- package/CONTRIBUTING.md +1 -13
- package/README.md +88 -39
- package/bmad/_cfg/agent-manifest.csv +1 -6
- package/bmad/_cfg/files-manifest.csv +40 -114
- package/bmad/_cfg/ides/claude-code.yaml +4 -3
- package/bmad/_cfg/manifest.yaml +3 -4
- package/bmad/_cfg/task-manifest.csv +0 -1
- package/bmad/_cfg/workflow-manifest.csv +3 -7
- package/bmad/bmb/config.yaml +2 -2
- package/bmad/bmb/workflows/audit-workflow/instructions.md +1 -1
- package/bmad/bmm/README.md +79 -120
- package/bmad/bmm/agents/architect.md +0 -1
- package/bmad/bmm/agents/sm.md +1 -1
- package/bmad/bmm/agents/{paige.md → tech-writer.md} +3 -3
- package/bmad/bmm/config.yaml +4 -3
- package/bmad/bmm/tasks/daily-standup.xml +1 -1
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
- package/bmad/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
- package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
- package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
- package/bmad/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
- package/bmad/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
- package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.yaml +1 -1
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
- package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
- package/bmad/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
- package/bmad/bmm/workflows/techdoc/documentation-standards.md +26 -2
- package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +2 -2
- package/bmad/bmm/workflows/workflow-status/init/instructions.md +623 -242
- package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
- package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
- package/bmad/bmm/workflows/workflow-status/paths/{brownfield-level-3.yaml → method-brownfield.yaml} +33 -31
- package/{src/modules/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
- package/bmad/bmm/workflows/workflow-status/paths/{brownfield-level-1.yaml → quick-flow-brownfield.yaml} +18 -18
- package/bmad/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
- package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
- package/bmad/core/config.yaml +2 -2
- package/bmad/core/tasks/workflow.xml +1 -11
- package/package.json +1 -1
- package/src/core/tasks/workflow.xml +1 -11
- package/src/modules/bmb/workflows/audit-workflow/instructions.md +1 -1
- package/src/modules/bmm/README.md +1 -1
- package/src/modules/bmm/_module-installer/install-config.yaml +5 -0
- package/src/modules/bmm/agents/architect.agent.yaml +0 -4
- package/src/modules/bmm/agents/game-dev.agent.yaml +8 -12
- package/src/modules/bmm/agents/sm.agent.yaml +1 -1
- package/src/modules/bmm/agents/{paige.agent.yaml → tech-writer.agent.yaml} +4 -4
- package/src/modules/bmm/docs/README.md +19 -18
- package/src/modules/bmm/docs/agents-guide.md +47 -99
- package/src/modules/bmm/docs/brownfield-guide.md +216 -96
- package/src/modules/bmm/docs/enterprise-agentic-development.md +380 -740
- package/src/modules/bmm/docs/faq.md +16 -16
- package/src/modules/bmm/docs/glossary.md +44 -50
- package/src/modules/bmm/docs/party-mode.md +110 -1122
- package/src/modules/bmm/docs/quick-spec-flow.md +36 -36
- package/src/modules/bmm/docs/quick-start.md +34 -34
- package/src/modules/bmm/docs/scale-adaptive-system.md +304 -454
- package/{bmad/bmm/testarch/README.md → src/modules/bmm/docs/test-architecture.md} +56 -38
- package/src/modules/bmm/docs/troubleshooting.md +7 -7
- package/src/modules/bmm/docs/workflows-analysis.md +64 -28
- package/src/modules/bmm/docs/workflows-implementation.md +196 -1671
- package/src/modules/bmm/docs/workflows-planning.md +74 -35
- package/src/modules/bmm/docs/workflows-solutioning.md +47 -17
- package/src/modules/bmm/tasks/daily-standup.xml +1 -1
- package/src/modules/bmm/workflows/2-plan-workflows/create-ux-design/instructions.md +1 -19
- package/src/modules/bmm/workflows/2-plan-workflows/prd/checklist.md +10 -9
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/epics-template.md +23 -34
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/instructions.md +105 -331
- package/src/modules/bmm/workflows/2-plan-workflows/prd/create-epics-and-stories/workflow.yaml +23 -11
- package/src/modules/bmm/workflows/2-plan-workflows/prd/instructions.md +23 -38
- package/src/modules/bmm/workflows/2-plan-workflows/prd/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/epics-template.md +38 -16
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/instructions.md +1 -19
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md +35 -32
- package/src/modules/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml +2 -2
- package/src/modules/bmm/workflows/3-solutioning/architecture/instructions.md +7 -18
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/instructions.md +1 -18
- package/src/modules/bmm/workflows/3-solutioning/solutioning-gate-check/workflow.yaml +6 -6
- package/src/modules/bmm/workflows/4-implementation/epic-tech-context/workflow.yaml +1 -1
- package/src/modules/bmm/workflows/techdoc/documentation-standards.md +25 -2
- package/src/modules/bmm/workflows/testarch/atdd/atdd-checklist-template.md +2 -2
- package/src/modules/bmm/workflows/workflow-status/init/instructions.md +623 -242
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +120 -0
- package/src/modules/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +108 -0
- package/src/modules/bmm/workflows/workflow-status/paths/{brownfield-level-3.yaml → method-brownfield.yaml} +33 -31
- package/{bmad/bmm/workflows/workflow-status/paths/greenfield-level-2.yaml → src/modules/bmm/workflows/workflow-status/paths/method-greenfield.yaml} +31 -21
- package/src/modules/bmm/workflows/workflow-status/paths/{brownfield-level-1.yaml → quick-flow-brownfield.yaml} +18 -18
- package/src/modules/bmm/workflows/workflow-status/paths/{greenfield-level-1.yaml → quick-flow-greenfield.yaml} +16 -18
- package/src/modules/bmm/workflows/workflow-status/workflow-status-template.yaml +4 -4
- package/tools/cli/installers/lib/core/config-collector.js +39 -11
- package/tools/cli/installers/lib/core/ide-config-manager.js +3 -1
- package/tools/cli/installers/lib/core/installer.js +20 -9
- package/tools/cli/installers/lib/core/manifest-generator.js +3 -1
- package/tools/cli/installers/lib/core/manifest.js +6 -2
- package/tools/cli/installers/lib/modules/manager.js +6 -0
- package/tools/cli/lib/config.js +3 -1
- package/tools/cli/lib/ui.js +5 -5
- package/tools/cli/lib/yaml-format.js +2 -1
- package/tools/schema/agent.js +2 -0
- package/.claude/commands/bmad/bmm/workflows/tech-spec-sm.md +0 -15
- package/bmad/_cfg/agents/cis-brainstorming-coach.customize.yaml +0 -42
- package/bmad/_cfg/agents/cis-creative-problem-solver.customize.yaml +0 -42
- package/bmad/_cfg/agents/cis-design-thinking-coach.customize.yaml +0 -42
- package/bmad/_cfg/agents/cis-innovation-strategist.customize.yaml +0 -42
- package/bmad/_cfg/agents/cis-storyteller.customize.yaml +0 -42
- package/bmad/bmb/agents/bmad-builder.md.bak +0 -70
- package/bmad/bmb/workflows/audit-workflow/workflow.yaml.bak +0 -23
- package/bmad/bmb/workflows/create-module/workflow.yaml.bak +0 -42
- package/bmad/bmb/workflows/create-workflow/workflow-template/workflow.yaml.bak +0 -39
- package/bmad/bmb/workflows/create-workflow/workflow.yaml.bak +0 -40
- package/bmad/bmb/workflows/edit-agent/workflow.yaml.bak +0 -33
- package/bmad/bmb/workflows/edit-module/workflow.yaml.bak +0 -34
- package/bmad/bmb/workflows/edit-workflow/workflow.yaml.bak +0 -27
- package/bmad/bmb/workflows/module-brief/workflow.yaml.bak +0 -29
- package/bmad/bmb/workflows/redoc/workflow.yaml.bak +0 -32
- package/bmad/bmm/docs/brownfield-guide.md +0 -1260
- package/bmad/bmm/docs/quick-spec-flow.md +0 -645
- package/bmad/bmm/docs/quick-start.md +0 -341
- package/bmad/bmm/docs/scale-adaptive-system.md +0 -1045
- package/bmad/bmm/tasks/retrospective.xml +0 -104
- package/bmad/bmm/workflows/1-analysis/brainstorm-project/README.md +0 -113
- package/bmad/bmm/workflows/1-analysis/product-brief/README.md +0 -180
- package/bmad/bmm/workflows/1-analysis/research/README.md +0 -454
- package/bmad/bmm/workflows/2-plan-workflows/README.md +0 -258
- package/bmad/bmm/workflows/3-solutioning/README.md +0 -1
- package/bmad/bmm/workflows/3-solutioning/architecture/README.md +0 -318
- package/bmad/bmm/workflows/3-solutioning/solutioning-gate-check/README.md +0 -177
- package/bmad/bmm/workflows/4-implementation/README.md +0 -221
- package/bmad/bmm/workflows/4-implementation/code-review/README.md +0 -69
- package/bmad/bmm/workflows/4-implementation/correct-course/README.md +0 -73
- package/bmad/bmm/workflows/4-implementation/create-story/README.md +0 -146
- package/bmad/bmm/workflows/4-implementation/dev-story/README.md +0 -206
- package/bmad/bmm/workflows/4-implementation/epic-tech-context/README.md +0 -195
- package/bmad/bmm/workflows/4-implementation/retrospective/README.md +0 -77
- package/bmad/bmm/workflows/4-implementation/sprint-planning/README.md +0 -156
- package/bmad/bmm/workflows/4-implementation/story-context/README.md +0 -234
- package/bmad/bmm/workflows/README.md +0 -256
- package/bmad/bmm/workflows/document-project/README.md +0 -444
- package/bmad/bmm/workflows/document-project/templates/README.md +0 -38
- package/bmad/bmm/workflows/testarch/README.md +0 -26
- package/bmad/bmm/workflows/testarch/atdd/README.md +0 -672
- package/bmad/bmm/workflows/testarch/automate/README.md +0 -869
- package/bmad/bmm/workflows/testarch/ci/README.md +0 -493
- package/bmad/bmm/workflows/testarch/framework/README.md +0 -340
- package/bmad/bmm/workflows/testarch/nfr-assess/README.md +0 -469
- package/bmad/bmm/workflows/testarch/test-design/README.md +0 -493
- package/bmad/bmm/workflows/testarch/test-review/README.md +0 -775
- package/bmad/bmm/workflows/testarch/trace/README.md +0 -802
- package/bmad/bmm/workflows/workflow-status/README.md +0 -260
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
- package/bmad/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
- package/bmad/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
- package/bmad/cis/README.md +0 -153
- package/bmad/cis/agents/README.md +0 -104
- package/bmad/cis/agents/brainstorming-coach.md +0 -62
- package/bmad/cis/agents/creative-problem-solver.md +0 -62
- package/bmad/cis/agents/design-thinking-coach.md +0 -62
- package/bmad/cis/agents/innovation-strategist.md +0 -62
- package/bmad/cis/agents/storyteller.md +0 -59
- package/bmad/cis/config.yaml +0 -10
- package/bmad/cis/teams/creative-squad.yaml +0 -6
- package/bmad/cis/workflows/README.md +0 -139
- package/bmad/cis/workflows/design-thinking/README.md +0 -56
- package/bmad/cis/workflows/design-thinking/design-methods.csv +0 -31
- package/bmad/cis/workflows/design-thinking/instructions.md +0 -200
- package/bmad/cis/workflows/design-thinking/template.md +0 -111
- package/bmad/cis/workflows/design-thinking/workflow.yaml +0 -32
- package/bmad/cis/workflows/innovation-strategy/README.md +0 -56
- package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +0 -31
- package/bmad/cis/workflows/innovation-strategy/instructions.md +0 -274
- package/bmad/cis/workflows/innovation-strategy/template.md +0 -189
- package/bmad/cis/workflows/innovation-strategy/workflow.yaml +0 -32
- package/bmad/cis/workflows/problem-solving/README.md +0 -56
- package/bmad/cis/workflows/problem-solving/instructions.md +0 -250
- package/bmad/cis/workflows/problem-solving/solving-methods.csv +0 -31
- package/bmad/cis/workflows/problem-solving/template.md +0 -165
- package/bmad/cis/workflows/problem-solving/workflow.yaml +0 -32
- package/bmad/cis/workflows/storytelling/README.md +0 -58
- package/bmad/cis/workflows/storytelling/instructions.md +0 -291
- package/bmad/cis/workflows/storytelling/story-types.csv +0 -26
- package/bmad/cis/workflows/storytelling/template.md +0 -113
- package/bmad/cis/workflows/storytelling/workflow.yaml +0 -32
- package/bmad/core/agents/bmad-master.md.bak +0 -69
- package/src/modules/bmm/docs/brownfield-guide.md.backup +0 -1324
- package/src/modules/bmm/docs/workflows-testing.md +0 -1572
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-0.yaml +0 -54
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-2.yaml +0 -76
- package/src/modules/bmm/workflows/workflow-status/paths/brownfield-level-4.yaml +0 -88
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-0.yaml +0 -45
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-3.yaml +0 -73
- package/src/modules/bmm/workflows/workflow-status/paths/greenfield-level-4.yaml +0 -75
- /package/bmad/_cfg/agents/{bmm-paige.customize.yaml → bmm-tech-writer.customize.yaml} +0 -0
|
@@ -8,11 +8,11 @@ Quick answers to common questions about the BMad Method Module.
|
|
|
8
8
|
|
|
9
9
|
- [Getting Started](#getting-started)
|
|
10
10
|
- [Choosing the Right Level](#choosing-the-right-level)
|
|
11
|
-
- [Workflows
|
|
11
|
+
- [Workflows and Phases](#workflows-and-phases)
|
|
12
12
|
- [Planning Documents](#planning-documents)
|
|
13
13
|
- [Implementation](#implementation)
|
|
14
14
|
- [Brownfield Development](#brownfield-development)
|
|
15
|
-
- [Tools
|
|
15
|
+
- [Tools and Technical](#tools-and-technical)
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
@@ -26,7 +26,7 @@ Quick answers to common questions about the BMad Method Module.
|
|
|
26
26
|
- Creates the tracking status file
|
|
27
27
|
- Routes you to the correct starting workflow
|
|
28
28
|
|
|
29
|
-
For experienced users: use the [Quick Reference](./quick-start.md#quick-reference-agent
|
|
29
|
+
For experienced users: use the [Quick Reference](./quick-start.md#quick-reference-agent-document-mapping) to go directly to the right agent/workflow.
|
|
30
30
|
|
|
31
31
|
### Q: Why do I need fresh chats for each workflow?
|
|
32
32
|
|
|
@@ -90,7 +90,7 @@ When in doubt, start smaller. You can always run create-prd later if needed.
|
|
|
90
90
|
|
|
91
91
|
### Q: Do I always need architecture for Level 2?
|
|
92
92
|
|
|
93
|
-
**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD + epic-tech-
|
|
93
|
+
**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD + epic-tech-context created during implementation.
|
|
94
94
|
|
|
95
95
|
### Q: What's the difference between Level 1 and Level 2?
|
|
96
96
|
|
|
@@ -108,7 +108,7 @@ The overlap (5-10 stories) is intentional. Choose based on:
|
|
|
108
108
|
|
|
109
109
|
---
|
|
110
110
|
|
|
111
|
-
## Workflows
|
|
111
|
+
## Workflows and Phases
|
|
112
112
|
|
|
113
113
|
### Q: What's the difference between workflow-status and workflow-init?
|
|
114
114
|
|
|
@@ -162,14 +162,14 @@ If status file exists, use workflow-status. If not, use workflow-init.
|
|
|
162
162
|
|
|
163
163
|
## Planning Documents
|
|
164
164
|
|
|
165
|
-
### Q: What's the difference between tech-spec and epic-tech-
|
|
165
|
+
### Q: What's the difference between tech-spec and epic-tech-context?
|
|
166
166
|
|
|
167
167
|
**A:**
|
|
168
168
|
|
|
169
169
|
- **Tech-spec (Level 0-1):** Created upfront in Planning Phase, serves as primary/only planning document, a combination of enough technical and planning information to drive a single or multiple files
|
|
170
|
-
- **Epic-tech-
|
|
170
|
+
- **Epic-tech-context (Level 2-4):** Created during Implementation Phase per epic, supplements PRD + Architecture
|
|
171
171
|
|
|
172
|
-
Think of it as: tech-spec is for small projects (replaces PRD and architecture), epic-tech-
|
|
172
|
+
Think of it as: tech-spec is for small projects (replaces PRD and architecture), epic-tech-context is for large projects (supplements PRD).
|
|
173
173
|
|
|
174
174
|
### Q: Why no tech-spec at Level 2+?
|
|
175
175
|
|
|
@@ -177,13 +177,13 @@ Think of it as: tech-spec is for small projects (replaces PRD and architecture),
|
|
|
177
177
|
|
|
178
178
|
- PRD (product vision, requirements, epics)
|
|
179
179
|
- Architecture (system design)
|
|
180
|
-
- Epic-tech-
|
|
180
|
+
- Epic-tech-context (detailed implementation per epic, created just-in-time)
|
|
181
181
|
|
|
182
|
-
### Q: When do I create epic-tech-
|
|
182
|
+
### Q: When do I create epic-tech-context?
|
|
183
183
|
|
|
184
|
-
**A:** In Phase 4, right before implementing each epic. Don't create all epic-tech-
|
|
184
|
+
**A:** In Phase 4, right before implementing each epic. Don't create all epic-tech-context upfront - that's over-planning. Create them just-in-time using the epic-tech-context workflow as you're about to start working on that epic.
|
|
185
185
|
|
|
186
|
-
**Why just-in-time?** You'll learn from earlier epics, and those learnings improve later epic-tech-
|
|
186
|
+
**Why just-in-time?** You'll learn from earlier epics, and those learnings improve later epic-tech-context.
|
|
187
187
|
|
|
188
188
|
### Q: Do I need a PRD for a bug fix?
|
|
189
189
|
|
|
@@ -270,7 +270,7 @@ The story-done workflow is faster and ensures proper status file updates.
|
|
|
270
270
|
- What went well
|
|
271
271
|
- What could improve
|
|
272
272
|
- Technical insights
|
|
273
|
-
- Input for next epic-tech-
|
|
273
|
+
- Input for next epic-tech-context
|
|
274
274
|
|
|
275
275
|
Don't wait until project end - run after each epic for continuous improvement.
|
|
276
276
|
|
|
@@ -339,7 +339,7 @@ BMM respects your choice - it won't force modernization, but it will offer it.
|
|
|
339
339
|
|
|
340
340
|
---
|
|
341
341
|
|
|
342
|
-
## Tools
|
|
342
|
+
## Tools and Technical
|
|
343
343
|
|
|
344
344
|
### Q: Why are my Mermaid diagrams not rendering?
|
|
345
345
|
|
|
@@ -399,7 +399,7 @@ Use them together for best results.
|
|
|
399
399
|
|
|
400
400
|
**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality.
|
|
401
401
|
|
|
402
|
-
See [IDE Setup Guides](
|
|
402
|
+
See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for configuration specifics.
|
|
403
403
|
|
|
404
404
|
### Q: Can I customize agents?
|
|
405
405
|
|
|
@@ -520,7 +520,7 @@ Trust your expertise - BMM supports your decisions.
|
|
|
520
520
|
|
|
521
521
|
**How it works:**
|
|
522
522
|
|
|
523
|
-
1.
|
|
523
|
+
1. Run `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent)
|
|
524
524
|
2. Introduce your topic
|
|
525
525
|
3. BMad Master selects 2-3 most relevant agents per message
|
|
526
526
|
4. Agents cross-talk, debate, and build on each other's ideas
|
|
@@ -7,11 +7,11 @@ Comprehensive terminology reference for the BMad Method Module.
|
|
|
7
7
|
## Navigation
|
|
8
8
|
|
|
9
9
|
- [Core Concepts](#core-concepts)
|
|
10
|
-
- [Scale
|
|
10
|
+
- [Scale and Complexity](#scale-and-complexity)
|
|
11
11
|
- [Planning Documents](#planning-documents)
|
|
12
|
-
- [Workflow
|
|
13
|
-
- [Agents
|
|
14
|
-
- [Status
|
|
12
|
+
- [Workflow and Phases](#workflow-and-phases)
|
|
13
|
+
- [Agents and Roles](#agents-and-roles)
|
|
14
|
+
- [Status and Tracking](#status-and-tracking)
|
|
15
15
|
- [Project Types](#project-types)
|
|
16
16
|
- [Implementation Terms](#implementation-terms)
|
|
17
17
|
|
|
@@ -29,7 +29,7 @@ The complete methodology for AI-assisted software development, encompassing plan
|
|
|
29
29
|
|
|
30
30
|
### Scale-Adaptive System
|
|
31
31
|
|
|
32
|
-
BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project
|
|
32
|
+
BMad Method's intelligent workflow orchestration that automatically adjusts planning depth, documentation requirements, and implementation processes based on project needs through three distinct planning tracks (Quick Flow, BMad Method, Enterprise Method).
|
|
33
33
|
|
|
34
34
|
### Agent
|
|
35
35
|
|
|
@@ -41,31 +41,25 @@ A multi-step guided process that orchestrates AI agent activities to produce spe
|
|
|
41
41
|
|
|
42
42
|
---
|
|
43
43
|
|
|
44
|
-
## Scale
|
|
44
|
+
## Scale and Complexity
|
|
45
45
|
|
|
46
|
-
###
|
|
46
|
+
### Quick Flow Track
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
Fast implementation track using tech-spec planning only. Best for bug fixes, small features, and changes with clear scope. Typical range: 1-15 stories. No architecture phase needed. Examples: bug fixes, OAuth login, search features.
|
|
49
49
|
|
|
50
|
-
###
|
|
50
|
+
### BMad Method Track
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features requiring system design. Typical range: 10-50+ stories. Examples: admin dashboards, e-commerce platforms, SaaS products.
|
|
53
53
|
|
|
54
|
-
###
|
|
54
|
+
### Enterprise Method Track
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
Extended enterprise planning track adding Security Architecture, DevOps Strategy, and Test Strategy to BMad Method. Best for enterprise requirements, compliance needs, and multi-tenant systems. Typical range: 30+ stories. Examples: multi-tenant platforms, compliance-driven systems, mission-critical applications.
|
|
57
57
|
|
|
58
|
-
###
|
|
58
|
+
### Planning Track
|
|
59
59
|
|
|
60
|
-
|
|
60
|
+
The methodology path (Quick Flow, BMad Method, or Enterprise Method) chosen for a project based on planning needs, complexity, and requirements rather than story count alone.
|
|
61
61
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
Projects with 40+ stories across products. Examples: multi-tenant systems, product ecosystems, platform expansions. Requires full methodology with strategic planning.
|
|
65
|
-
|
|
66
|
-
### Complexity Level
|
|
67
|
-
|
|
68
|
-
The scale rating (0-4) assigned to a project based on story count, integration requirements, team size, and architectural complexity.
|
|
62
|
+
**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math.
|
|
69
63
|
|
|
70
64
|
---
|
|
71
65
|
|
|
@@ -73,23 +67,23 @@ The scale rating (0-4) assigned to a project based on story count, integration r
|
|
|
73
67
|
|
|
74
68
|
### Tech-Spec (Technical Specification)
|
|
75
69
|
|
|
76
|
-
**
|
|
70
|
+
**Quick Flow track only.** Comprehensive technical plan created upfront that serves as the primary planning document for small changes or features. Contains problem statement, solution approach, file-level changes, stack detection (brownfield), testing strategy, and developer resources.
|
|
77
71
|
|
|
78
|
-
### Epic-Tech-
|
|
72
|
+
### Epic-Tech-Context (Epic Technical Context)
|
|
79
73
|
|
|
80
|
-
**
|
|
74
|
+
**BMad Method/Enterprise tracks only.** Detailed technical planning document created during implementation (just-in-time) for each epic. Supplements PRD + Architecture with epic-specific implementation details, code-level design decisions, and integration points.
|
|
81
75
|
|
|
82
|
-
**Key Difference:** Tech-spec (
|
|
76
|
+
**Key Difference:** Tech-spec (Quick Flow) is created upfront and is the only planning doc. Epic-tech-context (BMad Method/Enterprise) is created per epic during implementation and supplements PRD + Architecture.
|
|
83
77
|
|
|
84
78
|
### PRD (Product Requirements Document)
|
|
85
79
|
|
|
86
|
-
**
|
|
80
|
+
**BMad Method/Enterprise tracks.** Product-level planning document containing vision, goals, feature requirements, epic breakdown, success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning.
|
|
87
81
|
|
|
88
82
|
### Architecture Document
|
|
89
83
|
|
|
90
|
-
**
|
|
84
|
+
**BMad Method/Enterprise tracks.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment.
|
|
91
85
|
|
|
92
|
-
**Scale-Adaptive:** Architecture complexity scales with
|
|
86
|
+
**Scale-Adaptive:** Architecture complexity scales with track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies.
|
|
93
87
|
|
|
94
88
|
### Epics
|
|
95
89
|
|
|
@@ -105,7 +99,7 @@ Game development equivalent of PRD, created by Game Designer agent for game proj
|
|
|
105
99
|
|
|
106
100
|
---
|
|
107
101
|
|
|
108
|
-
## Workflow
|
|
102
|
+
## Workflow and Phases
|
|
109
103
|
|
|
110
104
|
### Phase 0: Documentation (Prerequisite)
|
|
111
105
|
|
|
@@ -113,15 +107,15 @@ Game development equivalent of PRD, created by Game Designer agent for game proj
|
|
|
113
107
|
|
|
114
108
|
### Phase 1: Analysis (Optional)
|
|
115
109
|
|
|
116
|
-
Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for
|
|
110
|
+
Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method.
|
|
117
111
|
|
|
118
112
|
### Phase 2: Planning (Required)
|
|
119
113
|
|
|
120
|
-
**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (
|
|
114
|
+
**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track.
|
|
121
115
|
|
|
122
|
-
### Phase 3: Solutioning (
|
|
116
|
+
### Phase 3: Solutioning (Track-Dependent)
|
|
123
117
|
|
|
124
|
-
Architecture design phase.
|
|
118
|
+
Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks.
|
|
125
119
|
|
|
126
120
|
### Phase 4: Implementation (Required)
|
|
127
121
|
|
|
@@ -129,11 +123,11 @@ Sprint-based development through story-by-story iteration. Uses sprint-planning,
|
|
|
129
123
|
|
|
130
124
|
### Quick Spec Flow
|
|
131
125
|
|
|
132
|
-
Fast-track workflow system for
|
|
126
|
+
Fast-track workflow system for Quick Flow track projects that goes straight from idea to tech-spec to implementation, bypassing heavy planning. Designed for bug fixes, small features, and rapid prototyping.
|
|
133
127
|
|
|
134
128
|
### Just-In-Time Design
|
|
135
129
|
|
|
136
|
-
Pattern where epic-tech-
|
|
130
|
+
Pattern where epic-tech-context is created during implementation (Phase 4) right before working on each epic, rather than all upfront. Enables learning and adaptation.
|
|
137
131
|
|
|
138
132
|
### Context Injection
|
|
139
133
|
|
|
@@ -141,7 +135,7 @@ Dynamic technical guidance generated for each story via epic-tech-context and st
|
|
|
141
135
|
|
|
142
136
|
---
|
|
143
137
|
|
|
144
|
-
## Agents
|
|
138
|
+
## Agents and Roles
|
|
145
139
|
|
|
146
140
|
### PM (Product Manager)
|
|
147
141
|
|
|
@@ -153,11 +147,11 @@ Agent that initializes workflows, conducts research, creates product briefs, and
|
|
|
153
147
|
|
|
154
148
|
### Architect
|
|
155
149
|
|
|
156
|
-
Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3.
|
|
150
|
+
Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning.
|
|
157
151
|
|
|
158
152
|
### SM (Scrum Master)
|
|
159
153
|
|
|
160
|
-
Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4.
|
|
154
|
+
Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4 implementation.
|
|
161
155
|
|
|
162
156
|
### DEV (Developer)
|
|
163
157
|
|
|
@@ -167,9 +161,9 @@ Agent that implements stories, writes code, runs tests, and performs code review
|
|
|
167
161
|
|
|
168
162
|
Agent responsible for test strategy, quality gates, NFR assessment, and comprehensive quality assurance. Integrates throughout all phases.
|
|
169
163
|
|
|
170
|
-
###
|
|
164
|
+
### Technical Writer
|
|
171
165
|
|
|
172
|
-
Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing.
|
|
166
|
+
Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing. The agent's internal name is "paige" but is presented as "Technical Writer" to users.
|
|
173
167
|
|
|
174
168
|
### UX Designer
|
|
175
169
|
|
|
@@ -189,11 +183,11 @@ Multi-agent collaboration feature where all installed agents (19+ from BMM, CIS,
|
|
|
189
183
|
|
|
190
184
|
---
|
|
191
185
|
|
|
192
|
-
## Status
|
|
186
|
+
## Status and Tracking
|
|
193
187
|
|
|
194
|
-
### bmm-workflow-status.
|
|
188
|
+
### bmm-workflow-status.yaml
|
|
195
189
|
|
|
196
|
-
**Phases
|
|
190
|
+
**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically.
|
|
197
191
|
|
|
198
192
|
### sprint-status.yaml
|
|
199
193
|
|
|
@@ -269,7 +263,7 @@ Workflow that initializes Phase 4 implementation by creating sprint-status.yaml,
|
|
|
269
263
|
|
|
270
264
|
### Gate Check
|
|
271
265
|
|
|
272
|
-
Validation workflow (solutioning-gate-check) run before Phase 4 to ensure PRD, architecture, and UX documents are cohesive with no gaps or contradictions. Required for
|
|
266
|
+
Validation workflow (solutioning-gate-check) run before Phase 4 to ensure PRD, architecture, and UX documents are cohesive with no gaps or contradictions. Required for BMad Method and Enterprise Method tracks.
|
|
273
267
|
|
|
274
268
|
### DoD (Definition of Done)
|
|
275
269
|
|
|
@@ -289,11 +283,11 @@ Universal entry point workflow that checks for existing status file, displays cu
|
|
|
289
283
|
|
|
290
284
|
### Workflow Init
|
|
291
285
|
|
|
292
|
-
Initialization workflow that creates bmm-workflow-status.
|
|
286
|
+
Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path.
|
|
293
287
|
|
|
294
|
-
###
|
|
288
|
+
### Track Selection
|
|
295
289
|
|
|
296
|
-
Automatic analysis by workflow-init that uses keyword analysis,
|
|
290
|
+
Automatic analysis by workflow-init that uses keyword analysis, complexity indicators, and project requirements to suggest appropriate track (Quick Flow, BMad Method, or Enterprise Method). User can override suggested track.
|
|
297
291
|
|
|
298
292
|
### Correct Course
|
|
299
293
|
|
|
@@ -305,7 +299,7 @@ Plan for handling changes to existing data, schemas, APIs, or patterns during br
|
|
|
305
299
|
|
|
306
300
|
### Feature Flags
|
|
307
301
|
|
|
308
|
-
Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for
|
|
302
|
+
Implementation technique for brownfield projects that allows gradual rollout of new functionality, easy rollback, and A/B testing. Recommended for BMad Method and Enterprise brownfield changes.
|
|
309
303
|
|
|
310
304
|
### Integration Points
|
|
311
305
|
|
|
@@ -320,8 +314,8 @@ Quick Spec Flow feature that automatically detects existing code style, naming c
|
|
|
320
314
|
## Related Documentation
|
|
321
315
|
|
|
322
316
|
- [Quick Start Guide](./quick-start.md) - Learn BMM basics
|
|
323
|
-
- [Scale Adaptive System](./scale-adaptive-system.md) - Deep dive on
|
|
317
|
+
- [Scale Adaptive System](./scale-adaptive-system.md) - Deep dive on tracks and complexity
|
|
324
318
|
- [Brownfield Guide](./brownfield-guide.md) - Working with existing codebases
|
|
325
|
-
- [Quick Spec Flow](./quick-spec-flow.md) - Fast-track for
|
|
319
|
+
- [Quick Spec Flow](./quick-spec-flow.md) - Fast-track for Quick Flow track
|
|
326
320
|
- [FAQ](./faq.md) - Common questions
|
|
327
321
|
- [Troubleshooting](./troubleshooting.md) - Problem resolution
|