BMAD-METHOD/src/bmm/module-help.csv

11 KiB

1modulephasenamecodesequenceworkflow-filecommandrequiredagentoptionsdescriptionoutput-locationoutputs
2bmmanytimeDocument ProjectDP_bmad/bmm/workflows/document-project/workflow.yamlbmad-bmm-document-projectfalseanalystCreate ModeAnalyze an existing project to produce useful documentationproject-knowledge*
3bmmanytimeGenerate Project ContextGPC_bmad/bmm/workflows/generate-project-context/workflow.mdbmad-bmm-generate-project-contextfalseanalystCreate ModeScan existing codebase to generate a lean LLM-optimized project-context.md containing critical implementation rules patterns and conventions for AI agents. Essential for brownfield projects and quick-flow.output_folderproject context
4bmmanytimeQuick SpecQS_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.mdbmad-bmm-quick-specfalsequick-flow-solo-devCreate ModeDo not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps brownfield additions to well established patterns utilities without extensive planningplanning_artifactstech spec
5bmmanytimeQuick DevQD_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.mdbmad-bmm-quick-devfalsequick-flow-solo-devCreate ModeQuick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan
6bmmanytimeCorrect CourseCC_bmad/bmm/workflows/4-implementation/correct-course/workflow.yamlbmad-bmm-correct-coursefalsesmCreate ModeAnytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and storiesplanning_artifactschange proposal
7bmmanytimeCreate DataflowCDF_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yamlbmad-bmm-create-excalidraw-dataflowfalseux-designerCreate ModeCreate data flow diagrams (DFD) in Excalidraw format - can be called standalone or during any workflow to add visual documentationplanning_artifactsdataflow diagram
8bmmanytimeCreate DiagramCED_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yamlbmad-bmm-create-excalidraw-diagramfalseux-designerCreate ModeCreate system architecture diagrams ERDs UML diagrams or general technical diagrams in Excalidraw format - use anytime or call from architecture workflow to add visual documentationplanning_artifactsdiagram
9bmmanytimeCreate FlowchartCFC_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yamlbmad-bmm-create-excalidraw-flowchartfalseux-designerCreate ModeCreate a flowchart visualization in Excalidraw format for processes pipelines or logic flows - use anytime or during architecture to add process documentationplanning_artifactsflowchart
10bmmanytimeCreate WireframeCEW_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yamlbmad-bmm-create-excalidraw-wireframefalseux-designerCreate ModeCreate website or app wireframes in Excalidraw format - use anytime standalone or call from UX workflow to add UI mockupsplanning_artifactswireframe
11bmmanytimeWrite DocumentWD_bmad/bmm/agents/tech-writer/tech-writer.agent.yamlbmad-bmm-write-documentfalsetech-writerDescribe in detail what you want, and the agent will follow the documentation best practices defined in agent memory. Multi-turn conversation with subprocess for research/review.project-knowledgedocument
12bmmanytimeUpdate StandardsUS_bmad/bmm/agents/tech-writer/tech-writer.agent.yamlbmad-bmm-update-standardsfalsetech-writerUpdate agent memory documentation-standards.md with your specific preferences if you discover missing document conventions._bmad/_memory/tech-writer-sidecarstandards
13bmmanytimeMermaid GenerateMG_bmad/bmm/agents/tech-writer/tech-writer.agent.yamlbmad-bmm-mermaid-generatefalsetech-writerCreate a Mermaid diagram based on user description. Will suggest diagram types if not specified.planning_artifactsmermaid diagram
14bmmanytimeValidate DocumentVD_bmad/bmm/agents/tech-writer/tech-writer.agent.yamlbmad-bmm-validate-documentfalsetech-writerReview the specified document against documentation standards and best practices. Returns specific actionable improvement suggestions organized by priority.planning_artifactsvalidation report
15bmmanytimeExplain ConceptEC_bmad/bmm/agents/tech-writer/tech-writer.agent.yamlbmad-bmm-explain-conceptfalsetech-writerCreate clear technical explanations with examples and diagrams for complex concepts. Breaks down into digestible sections using task-oriented approach.project_knowledgeexplanation
16bmm1-analysisBrainstorm ProjectBP10_bmad/core/workflows/brainstorming/workflow.mdbmad-brainstormingfalseanalystdata=_bmad/bmm/data/project-context-template.mdExpert Guided Facilitation through a single or multiple techniquesplanning_artifactsbrainstorming session
17bmm1-analysisMarket ResearchMR20_bmad/bmm/workflows/1-analysis/research/workflow.mdbmad-bmm-researchfalseanalystCreate Mode research_type=marketMarket analysis competitive landscape customer needs and trendsplanning_artifacts|project-knowledgeresearch documents
18bmm1-analysisDomain ResearchDR21_bmad/bmm/workflows/1-analysis/research/workflow.mdbmad-bmm-researchfalseanalystCreate Mode research_type=domainIndustry domain deep dive subject matter expertise and terminologyplanning_artifacts|project_knowledgeresearch documents
19bmm1-analysisTechnical ResearchTR22_bmad/bmm/workflows/1-analysis/research/workflow.mdbmad-bmm-researchfalseanalystCreate Mode research_type=technicalTechnical feasibility architecture options and implementation approachesplanning_artifacts|project_knowledgeresearch documents
20bmm1-analysisCreate BriefCB30_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.mdbmad-bmm-create-brieffalseanalystCreate ModeA guided experience to nail down your product ideaplanning_artifactsproduct brief
21bmm1-analysisValidate BriefVB40_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.mdbmad-bmm-validate-brieffalseanalystValidate ModeValidates product brief completenessplanning_artifactsbrief validation report
22bmm2-planningCreate PRDCP10_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.mdbmad-bmm-create-prdtruepmCreate ModeExpert led facilitation to produce your Product Requirements Documentplanning_artifactsprd
23bmm2-planningValidate PRDVP20_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow.mdbmad-bmm-validate-prdfalsepmValidate ModeValidate PRD is comprehensive lean well organized and cohesiveplanning_artifactsprd validation report
24bmm2-planningCreate UXCU30_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.mdbmad-bmm-create-ux-designfalseux-designerCreate ModeGuidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed projectplanning_artifactsux design
25bmm2-planningValidate UXVU40_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.mdbmad-bmm-create-ux-designfalseux-designerValidate ModeValidates UX design deliverablesplanning_artifactsux validation report
26bmm3-solutioningCreate ArchitectureCA10_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.mdbmad-bmm-create-architecturetruearchitectCreate ModeGuided Workflow to document technical decisionsplanning_artifactsarchitecture
27bmm3-solutioningValidate ArchitectureVA20_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.mdbmad-bmm-create-architecturefalsearchitectValidate ModeValidates architecture completenessplanning_artifactsarchitecture validation report
28bmm3-solutioningCreate Epics and StoriesCE30_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.mdbmad-bmm-create-epics-and-storiestruepmCreate ModeCreate the Epics and Stories Listingplanning_artifactsepics and stories
29bmm3-solutioningValidate Epics and StoriesVE40_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.mdbmad-bmm-create-epics-and-storiesfalsepmValidate ModeValidates epics and stories completenessplanning_artifactsepics validation report
30bmm3-solutioningCheck Implementation ReadinessIR70_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.mdbmad-bmm-check-implementation-readinesstruearchitectValidate ModeEnsure PRD UX Architecture and Epics Stories are alignedplanning_artifactsreadiness report
31bmm4-implementationSprint PlanningSP10_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yamlbmad-bmm-sprint-planningtruesmCreate ModeGenerate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.implementation_artifactssprint status
32bmm4-implementationSprint StatusSS20_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yamlbmad-bmm-sprint-statusfalsesmCreate ModeAnytime: Summarize sprint status and route to next workflow
33bmm4-implementationValidate StoryVS35_bmad/bmm/workflows/4-implementation/create-story/workflow.yamlbmad-bmm-create-storyfalsesmValidate ModeValidates story readiness and completeness before development work beginsimplementation_artifactsstory validation report
34bmm4-implementationCreate StoryCS30_bmad/bmm/workflows/4-implementation/create-story/workflow.yamlbmad-bmm-create-storytruesmCreate ModeStory cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ERimplementation_artifactsstory
35bmm4-implementationDev StoryDS40_bmad/bmm/workflows/4-implementation/dev-story/workflow.yamlbmad-bmm-dev-storytruedevCreate ModeStory cycle: Execute story implementation tasks and tests then CR then back to DS if fixes needed
36bmm4-implementationCode ReviewCR50_bmad/bmm/workflows/4-implementation/code-review/workflow.yamlbmad-bmm-code-reviewfalsedevCreate ModeStory cycle: If issues back to DS if approved then next CS or ER if epic complete
37bmm4-implementationQA Automation TestQA45_bmad/bmm/workflows/qa/automate/workflow.yamlbmad-bmm-qa-automatefalsequinnCreate ModeGenerate automated API and E2E tests for implemented code using the project's existing test framework (detects existing well known in use test frameworks). Use after implementation to add test coverage. NOT for code review or story validation - use CR for that.implementation_artifactstest suite
38bmm4-implementationRetrospectiveER60_bmad/bmm/workflows/4-implementation/retrospective/workflow.yamlbmad-bmm-retrospectivefalsesmCreate ModeOptional at epic end: Review completed work lessons learned and next epic or if major issues consider CCimplementation_artifactsretrospective