|
| 1 | +# BMAD Help Reference |
| 2 | + |
| 3 | +Welcome to the **BMad Method** help system. Below is a comprehensive reference of all available workflows, commands, and agents organized by module and phase. |
| 4 | + |
| 5 | +> 💡 **Agent Switching**: Most workflows require specific agents. Use `*agent <agent-name>` to switch context before running workflows. |
| 6 | +
|
| 7 | +--- |
| 8 | + |
| 9 | +## 🎭 Agent Overview |
| 10 | + |
| 11 | +| Agent | Role | Primary Workflows | |
| 12 | +|-------|------|-------------------| |
| 13 | +| **architect** | Design & Planning | PRD, Architecture, UX, Epics/Stories | |
| 14 | +| **scrum-master** | Sprint Management | Sprint Planning, Status, Create Story | |
| 15 | +| **dev** | Implementation | Dev Story, Code Review, QA | |
| 16 | +| **tech-writer** | Documentation | Write/Validate Docs, Explain Concepts | |
| 17 | +| **default** | General Tasks | Research, Quick Dev/Spec, Diagrams | |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## 🏗️ BMB (Build Module Builder) |
| 22 | +**Module for creating and managing BMAD components** |
| 23 | + |
| 24 | +🎭 **Agent**: `default` (most workflows) |
| 25 | + |
| 26 | +### Anytime Workflows |
| 27 | +- **Create Agent** (`CA` | `bmad_bmb_agent`) - Create new BMAD agents with best practices |
| 28 | +- **Edit Agent** (`EA` | `bmad_bmb_agent`) - Edit existing BMAD agents while maintaining compliance |
| 29 | +- **Validate Agent** (`VA` | `bmad_bmb_agent`) - Validate existing BMAD agents and offer improvements |
| 30 | +- **Create Module Brief** (`PB` | `bmad_bmb_module`) - Create product brief for BMAD module development |
| 31 | +- **Create Module** (`CM` | `bmad_bmb_module`) - Create complete BMAD module with agents, workflows, and infrastructure |
| 32 | +- **Edit Module** (`EM` | `bmad_bmb_module`) - Edit existing BMAD modules while maintaining coherence |
| 33 | +- **Validate Module** (`VM` | `bmad_bmb_module`) - Run compliance check on BMAD modules |
| 34 | +- **Create Workflow** (`CW` | `bmad_bmb_workflow`) - Create new BMAD workflow with proper structure |
| 35 | +- **Edit Workflow** (`EW` | `bmad_bmb_workflow`) - Edit existing BMAD workflows while maintaining integrity |
| 36 | +- **Validate Workflow** (`VW` | `bmad_bmb_workflow`) - Run validation check on BMAD workflows |
| 37 | +- **Max Parallel Validate** (`MV` | `bmad_bmb_workflow`) - Run validation checks in MAX-PARALLEL mode |
| 38 | +- **Rework Workflow** (`RW` | `bmad_bmb_workflow`) - Rework a Workflow to V6 compliant version |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +## 💼 BMM (BMAD Method Manager) |
| 43 | +**Full-featured software development lifecycle management** |
| 44 | + |
| 45 | +### Phase 1: Analysis |
| 46 | +🎭 **Agent**: `default` or `architect` |
| 47 | + |
| 48 | +- **Brainstorm Project** (`BP` | `bmad-brainstorming`) - Expert guided facilitation through brainstorming techniques |
| 49 | +- **Market Research** (`MR` | `bmad-bmm-research`) - Market analysis, competitive landscape, customer needs and trends |
| 50 | +- **Domain Research** (`DR` | `bmad-bmm-research`) - Industry domain deep dive, subject matter expertise and terminology |
| 51 | +- **Technical Research** (`TR` | `bmad-bmm-research`) - Technical feasibility, architecture options and implementation approaches |
| 52 | +- **Create Brief** (`CB` | `bmad-bmm-create-brief`) 🎭 `architect` - Guided experience to nail down your product idea |
| 53 | +- **Validate Brief** (`VB` | `bmad-bmm-validate-brief`) 🎭 `architect` - Validates product brief completeness |
| 54 | + |
| 55 | +### Phase 2: Planning |
| 56 | +🎭 **Agent**: `architect` (required for all Phase 2) |
| 57 | + |
| 58 | +- **Create PRD** (`CP` | `bmad-bmm-create-prd`) ⚡**REQUIRED** 🎭 `architect` - Expert led facilitation to produce Product Requirements Document |
| 59 | +- **Validate PRD** (`VP` | `bmad-bmm-validate-prd`) 🎭 `architect` - Validate PRD is comprehensive, lean, well organized and cohesive |
| 60 | +- **Create UX** (`CU` | `bmad-bmm-create-ux-design`) 🎭 `architect` - Guidance through realizing the plan for your UX |
| 61 | +- **Validate UX** (`VU` | `bmad-bmm-create-ux-design`) 🎭 `architect` - Validates UX design deliverables |
| 62 | + |
| 63 | +### Phase 3: Solutioning |
| 64 | +🎭 **Agent**: `architect` (required for all Phase 3) |
| 65 | + |
| 66 | +- **Create Architecture** (`CA` | `bmad-bmm-create-architecture`) ⚡**REQUIRED** 🎭 `architect` - Guided workflow to document technical decisions |
| 67 | +- **Validate Architecture** (`VA` | `bmad-bmm-create-architecture`) 🎭 `architect` - Validates architecture completeness |
| 68 | +- **Create Epics and Stories** (`CE` | `bmad-bmm-create-epics-and-stories`) ⚡**REQUIRED** 🎭 `architect` - Create the Epics and Stories listing |
| 69 | +- **Validate Epics and Stories** (`VE` | `bmad-bmm-create-epics-and-stories`) 🎭 `architect` - Validates epics and stories completeness |
| 70 | +- **Check Implementation Readiness** (`IR` | `bmad-bmm-check-implementation-readiness`) ⚡**REQUIRED** 🎭 `architect` - Ensure PRD, UX, Architecture and Epics/Stories are aligned |
| 71 | + |
| 72 | +### Phase 4: Implementation |
| 73 | +🎭 **Agent**: Switch between `scrum-master` and `dev` |
| 74 | + |
| 75 | +- **Sprint Planning** (`SP` | `bmad-bmm-sprint-planning`) ⚡**REQUIRED** 🎭 `scrum-master` - Generate sprint plan for development tasks (kicks off implementation) |
| 76 | +- **Sprint Status** (`SS` | `bmad-bmm-sprint-status`) 🎭 `scrum-master` - Summarize sprint status and route to next workflow |
| 77 | +- **Create Story** (`CS` | `bmad-bmm-create-story`) ⚡**REQUIRED** 🎭 `scrum-master` - Story cycle start: Prepare first found story that is next |
| 78 | +- **Validate Story** (`VS` | `bmad-bmm-create-story`) 🎭 `scrum-master` - Validates story readiness before development work begins |
| 79 | +- **Dev Story** (`DS` | `bmad-bmm-dev-story`) ⚡**REQUIRED** 🎭 `dev` - Story cycle: Execute story implementation tasks and tests |
| 80 | +- **QA Automation Test** (`QA` | `bmad-bmm-qa-automate`) 🎭 `dev` - Generate automated API and E2E tests |
| 81 | +- **Code Review** (`CR` | `bmad-bmm-code-review`) 🎭 `dev` (recommend fresh session) - Story cycle: Review implementation quality |
| 82 | +- **Retrospective** (`ER` | `bmad-bmm-retrospective`) 🎭 `scrum-master` - Optional at epic end: Review completed work and lessons learned |
| 83 | + |
| 84 | +### Anytime Workflows |
| 85 | +🎭 **Agent**: `default` (most), `tech-writer` (documentation), `dev` (quick dev) |
| 86 | + |
| 87 | +- **Document Project** (`DP` | `bmad-bmm-document-project`) 🎭 `default` - Analyze an existing project to produce useful documentation |
| 88 | +- **Generate Project Context** (`GPC` | `bmad-bmm-generate-project-context`) 🎭 `default` - Scan existing codebase to generate lean LLM-optimized project-context.md |
| 89 | +- **Quick Spec** (`QS` | `bmad-bmm-quick-spec`) 🎭 `dev` - Quick one-off tasks, small changes, simple apps without extensive planning |
| 90 | +- **Quick Dev** (`QD` | `bmad-bmm-quick-dev`) 🎭 `dev` - Quick one-off tasks, small changes, simple apps, utilities without extensive planning |
| 91 | +- **Correct Course** (`CC` | `bmad-bmm-correct-course`) 🎭 `scrum-master` - Navigate significant changes |
| 92 | +- **Create Dataflow** (`CDF` | `bmad-bmm-create-excalidraw-dataflow`) 🎭 `default` - Create data flow diagrams (DFD) in Excalidraw format |
| 93 | +- **Create Diagram** (`CED` | `bmad-bmm-create-excalidraw-diagram`) 🎭 `default` - Create system architecture diagrams, ERDs, UML diagrams |
| 94 | +- **Create Flowchart** (`CFC` | `bmad-bmm-create-excalidraw-flowchart`) 🎭 `default` - Create flowchart visualization in Excalidraw format |
| 95 | +- **Create Wireframe** (`CEW` | `bmad-bmm-create-excalidraw-wireframe`) 🎭 `default` - Create website or app wireframes in Excalidraw format |
| 96 | +- **Write Document** (`WD` | `bmad-bmm-write-document`) 🎭 `tech-writer` - Create technical documentation following best practices |
| 97 | +- **Update Standards** (`US` | `bmad-bmm-update-standards`) 🎭 `tech-writer` - Update agent memory documentation-standards.md |
| 98 | +- **Mermaid Generate** (`MG` | `bmad-bmm-mermaid-generate`) 🎭 `default` - Create a Mermaid diagram based on user description |
| 99 | +- **Validate Document** (`VD` | `bmad-bmm-validate-document`) 🎭 `tech-writer` - Review document against documentation standards |
| 100 | +- **Explain Concept** (`EC` | `bmad-bmm-explain-concept`) 🎭 `tech-writer` - Create clear technical explanations with examples and diagrams |
| 101 | + |
| 102 | +--- |
| 103 | + |
| 104 | +## 🎨 CIS (Creative Innovation Strategy) |
| 105 | +**Innovation, problem-solving and design thinking** |
| 106 | + |
| 107 | +🎭 **Agent**: `default` (all CIS workflows) |
| 108 | + |
| 109 | +- **Innovation Strategy** (`IS` | `bmad-cis-innovation-strategy`) - Identify disruption opportunities and architect business model innovation |
| 110 | +- **Problem Solving** (`PS` | `bmad-cis-problem-solving`) - Apply systematic problem-solving methodologies |
| 111 | +- **Design Thinking** (`DT` | `bmad-cis-design-thinking`) - Guide human-centered design processes using empathy-driven methodologies |
| 112 | +- **Brainstorming** (`BS` | `bmad-cis-brainstorming`) - Facilitate brainstorming sessions using one or more techniques |
| 113 | +- **Storytelling** (`ST` | `bmad-cis-storytelling`) - Craft compelling narratives using proven story frameworks |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +## 🧪 TEA (Test Excellence Architect) |
| 118 | +**Testing and quality assurance** |
| 119 | + |
| 120 | +🎭 **Agent**: `dev` (all TEA workflows) |
| 121 | + |
| 122 | +### Phase 0: Learning |
| 123 | +- **Teach Me Testing** (`TMT` | `bmad_tea_teach-me-testing`) 🎭 `dev` - Teach testing fundamentals through 7 sessions (TEA Academy) |
| 124 | + |
| 125 | +### Phase 3: Solutioning |
| 126 | +- **Test Framework** (`TF` | `bmad_tea_framework`) 🎭 `dev` - Initialize production-ready test framework |
| 127 | +- **CI Setup** (`CI` | `bmad_tea_ci`) 🎭 `dev` - Configure CI/CD quality pipeline |
| 128 | +- **Test Design** (`TD` | `bmad_tea_test-design`) 🎭 `dev` - Risk-based test planning |
| 129 | + |
| 130 | +### Phase 4: Implementation |
| 131 | +- **ATDD** (`AT` | `bmad_tea_atdd`) 🎭 `dev` - Generate failing tests (TDD red phase) |
| 132 | +- **Test Automation** (`TA` | `bmad_tea_automate`) 🎭 `dev` - Expand test coverage |
| 133 | +- **Test Review** (`RV` | `bmad_tea_test-review`) 🎭 `dev` - Quality audit (0-100 scoring) |
| 134 | +- **NFR Assessment** (`NR` | `bmad_tea_nfr-assess`) 🎭 `dev` - Non-functional requirements |
| 135 | +- **Traceability** (`TR` | `bmad_tea_trace`) 🎭 `dev` - Coverage traceability and gate |
| 136 | + |
| 137 | +--- |
| 138 | + |
| 139 | +## 🔧 CORE (Core Utilities) |
| 140 | +**Universal utilities and tasks** |
| 141 | + |
| 142 | +🎭 **Agent**: `default` (all CORE workflows) |
| 143 | + |
| 144 | +- **Brainstorming** (`BSP` | `bmad-brainstorming`) - Generate diverse ideas through interactive techniques |
| 145 | +- **Party Mode** (`PM` | `bmad-party-mode`) - Orchestrate multi-agent discussions |
| 146 | +- **bmad-help** (`BH` | `bmad-help`) - Get unstuck by showing what workflow steps come next |
| 147 | +- **Index Docs** (`ID` | `bmad-index-docs`) - Create lightweight index for quick LLM scanning |
| 148 | +- **Shard Document** (`SD` | `bmad-shard-doc`) - Split large documents into smaller files by sections |
| 149 | +- **Editorial Review - Prose** (`EP` | `bmad-editorial-review-prose`) - Review prose for clarity, tone, and communication issues |
| 150 | +- **Editorial Review - Structure** (`ES` | `bmad-editorial-review-structure`) - Propose cuts, reorganization, and simplification |
| 151 | +- **Adversarial Review (General)** (`AR` | `bmad-review-adversarial-general`) - Review content critically to find issues and weaknesses |
| 152 | + |
| 153 | +--- |
| 154 | + |
| 155 | +## 💡 Usage Tips |
| 156 | + |
| 157 | +1. **Start with BMM Phase 1-2** for new projects (Analysis → Planning) |
| 158 | +2. **Use Quick Dev/Quick Spec** for brownfield projects or simple additions |
| 159 | +3. **Follow the numbered sequence** within each phase for best results |
| 160 | +4. **Required workflows** (⚡) are critical checkpoints in the BMM flow |
| 161 | +5. **Switch agents** (🎭) before running workflows - use `*agent <agent-name>` |
| 162 | + |
| 163 | +### Agent Switching Examples: |
| 164 | +``` |
| 165 | +*agent architect # Switch to architect for planning/design |
| 166 | +*agent scrum-master # Switch to scrum-master for sprint management |
| 167 | +*agent dev # Switch to dev for implementation |
| 168 | +*agent tech-writer # Switch to tech-writer for documentation |
| 169 | +*agent default # Switch back to default mode |
| 170 | +``` |
| 171 | + |
| 172 | +To invoke any workflow, use: `*[CODE]` or `*[COMMAND]` |
| 173 | +Example: `*CP` or `*bmad-bmm-create-prd` |
| 174 | + |
| 175 | +### Typical Workflow Progression: |
| 176 | +1. **Planning** → `*agent architect` → `*CP` (Create PRD) → `*CA` (Create Architecture) → `*CE` (Create Epics) |
| 177 | +2. **Sprint Start** → `*agent scrum-master` → `*SP` (Sprint Planning) → `*CS` (Create Story) |
| 178 | +3. **Development** → `*agent dev` → `*DS` (Dev Story) → `*CR` (Code Review) |
| 179 | +4. **Next Story** → `*agent scrum-master` → `*SS` (Sprint Status) → `*CS` (Create next Story) |
0 commit comments