8.6 KiB
8.6 KiB
BMAD Method — Project Instructions
Project Configuration
- Project: grateful-journal
- User: Jeet
- Communication Language: English
- Document Output Language: English
- User Skill Level: intermediate
- Output Folder: {project-root}/_bmad-output
- Planning Artifacts: {project-root}/_bmad-output/planning-artifacts
- Implementation Artifacts: {project-root}/_bmad-output/implementation-artifacts
- Project Knowledge: {project-root}/docs
BMAD Runtime Structure
- Agent definitions:
_bmad/bmm/agents/(BMM module) and_bmad/core/agents/(core) - Workflow definitions:
_bmad/bmm/workflows/(organized by phase) - Core tasks:
_bmad/core/tasks/(help, editorial review, indexing, sharding, adversarial review) - Core workflows:
_bmad/core/workflows/(brainstorming, party-mode, advanced-elicitation) - Workflow engine:
_bmad/core/tasks/workflow.xml(executes YAML-based workflows) - Module configuration:
_bmad/bmm/config.yaml - Core configuration:
_bmad/core/config.yaml - Agent manifest:
_bmad/_config/agent-manifest.csv - Workflow manifest:
_bmad/_config/workflow-manifest.csv - Help manifest:
_bmad/_config/bmad-help.csv - Agent memory:
_bmad/_memory/
Key Conventions
- Always load
_bmad/bmm/config.yamlbefore any agent activation or workflow execution - Store all config fields as session variables:
{user_name},{communication_language},{output_folder},{planning_artifacts},{implementation_artifacts},{project_knowledge} - MD-based workflows execute directly — load and follow the
.mdfile - YAML-based workflows require the workflow engine — load
workflow.xmlfirst, then pass the.yamlconfig - Follow step-based workflow execution: load steps JIT, never multiple at once
- Save outputs after EACH step when using the workflow engine
- The
{project-root}variable resolves to the workspace root at runtime
Available Agents
| Agent | Persona | Title | Capabilities |
|---|---|---|---|
| bmad-master | BMad Master | BMad Master Executor, Knowledge Custodian, and Workflow Orchestrator | runtime resource management, workflow orchestration, task execution, knowledge custodian |
| analyst | Mary | Business Analyst | market research, competitive analysis, requirements elicitation, domain expertise |
| architect | Winston | Architect | distributed systems, cloud infrastructure, API design, scalable patterns |
| dev | Amelia | Developer Agent | story execution, test-driven development, code implementation |
| pm | John | Product Manager | PRD creation, requirements discovery, stakeholder alignment, user interviews |
| qa | Quinn | QA Engineer | test automation, API testing, E2E testing, coverage analysis |
| quick-flow-solo-dev | Barry | Quick Flow Solo Dev | rapid spec creation, lean implementation, minimum ceremony |
| sm | Bob | Scrum Master | sprint planning, story preparation, agile ceremonies, backlog management |
| tech-writer | Paige | Technical Writer | documentation, Mermaid diagrams, standards compliance, concept explanation |
| ux-designer | Sally | UX Designer | user research, interaction design, UI patterns, experience strategy |
Slash Commands
When the user's message starts with a /bmad- command (with or without additional text), execute it by following the steps below. Always load _bmad/bmm/config.yaml first and store config as session variables, then load and follow the referenced file exactly.
Workflow Commands
| Command | Action |
|---|---|
/bmad-help |
Load and follow _bmad/core/tasks/help.md |
/bmad-brainstorming |
Load and follow _bmad/core/workflows/brainstorming/workflow.md |
/bmad-party-mode |
Load and follow _bmad/core/workflows/party-mode/workflow.md |
/bmad-bmm-create-product-brief |
Load and follow _bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md |
/bmad-bmm-market-research |
Load and follow _bmad/bmm/workflows/1-analysis/research/workflow-market-research.md |
/bmad-bmm-domain-research |
Load and follow _bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md |
/bmad-bmm-technical-research |
Load and follow _bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md |
/bmad-bmm-create-prd |
Load and follow _bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md |
/bmad-bmm-edit-prd |
Load and follow _bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md |
/bmad-bmm-validate-prd |
Load and follow _bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md |
/bmad-bmm-create-ux-design |
Load and follow _bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md |
/bmad-bmm-create-architecture |
Load and follow _bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md |
/bmad-bmm-create-epics-and-stories |
Load and follow _bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md |
/bmad-bmm-check-implementation-readiness |
Load and follow _bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md |
/bmad-bmm-sprint-planning |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml |
/bmad-bmm-sprint-status |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml |
/bmad-bmm-create-story |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/create-story/workflow.yaml |
/bmad-bmm-dev-story |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml |
/bmad-bmm-code-review |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/code-review/workflow.yaml |
/bmad-bmm-retrospective |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml |
/bmad-bmm-correct-course |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml |
/bmad-bmm-qa-automate |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/qa/automate/workflow.yaml |
/bmad-bmm-quick-spec |
Load and follow _bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md |
/bmad-bmm-quick-dev |
Load and follow _bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md |
/bmad-bmm-document-project |
Load _bmad/core/tasks/workflow.xml (engine), then execute _bmad/bmm/workflows/document-project/workflow.yaml |
/bmad-bmm-generate-project-context |
Load and follow _bmad/bmm/workflows/generate-project-context/workflow.md |
/bmad-index-docs |
Load and execute _bmad/core/tasks/index-docs.xml |
/bmad-shard-doc |
Load and execute _bmad/core/tasks/shard-doc.xml |
/bmad-editorial-review-prose |
Load and execute _bmad/core/tasks/editorial-review-prose.xml |
/bmad-editorial-review-structure |
Load and execute _bmad/core/tasks/editorial-review-structure.xml |
/bmad-review-adversarial-general |
Load and execute _bmad/core/tasks/review-adversarial-general.xml |
/bmad-bmm-write-document |
Load _bmad/bmm/agents/tech-writer/tech-writer.md, activate Paige persona, execute Write Document (WD) |
/bmad-bmm-update-standards |
Load _bmad/bmm/agents/tech-writer/tech-writer.md, activate Paige persona, execute Update Standards (US) |
/bmad-bmm-mermaid-generate |
Load _bmad/bmm/agents/tech-writer/tech-writer.md, activate Paige persona, execute Mermaid Generate (MG) |
/bmad-bmm-validate-document |
Load _bmad/bmm/agents/tech-writer/tech-writer.md, activate Paige persona, execute Validate Document (VD) |
/bmad-bmm-explain-concept |
Load _bmad/bmm/agents/tech-writer/tech-writer.md, activate Paige persona, execute Explain Concept (EC) |
Agent Activator Commands
| Command | Agent File |
|---|---|
/bmad-bmad-master |
_bmad/core/agents/bmad-master.md |
/bmad-analyst |
_bmad/bmm/agents/analyst.md |
/bmad-architect |
_bmad/bmm/agents/architect.md |
/bmad-dev |
_bmad/bmm/agents/dev.md |
/bmad-pm |
_bmad/bmm/agents/pm.md |
/bmad-qa |
_bmad/bmm/agents/qa.md |
/bmad-quick-flow-solo-dev |
_bmad/bmm/agents/quick-flow-solo-dev.md |
/bmad-sm |
_bmad/bmm/agents/sm.md |
/bmad-tech-writer |
_bmad/bmm/agents/tech-writer/tech-writer.md |
/bmad-ux-designer |
_bmad/bmm/agents/ux-designer.md |
For agent commands: load the agent file, follow ALL activation instructions, display the welcome/greeting, present the numbered menu, and wait for user input.