ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

Merge pull request #1309 from forcetrainer/main 

docs: comprehensive documentation overhaul with style guide expansion
This commit is contained in:
Murat K Ozcan 2026-01-12 06:04:45 -06:00 committed by GitHub
parent d4f6642333 c0f6401902
commit 568249e985
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
70 changed files with 1549 additions and 2664 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -7,6 +7,8 @@
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems. **Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
## Why BMad? ## Why BMad?
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking. Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
@ -60,10 +62,20 @@ This analyzes your project and recommends a track:
## Community ## Community
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate - [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
- [YouTube](https://www.youtube.com/@BMadCode) — Video tutorials and updates - [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests - [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations - [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
## Support BMad
BMad is free for everyone — and always will be. If you'd like to support development:
- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad
- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
- 🏢 Corporate sponsorship — DM on Discord
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord)
## Contributing ## Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

421
docs/_STYLE_GUIDE.md
View File

@ -1,4 +1,6 @@
# Documentation Style Guide ---
title: "Documentation Style Guide"
---
Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users. Internal guidelines for maintaining consistent, high-quality documentation across the BMad Method project. This document is not included in the Starlight sidebar — it's for contributors and maintainers, not end users.
@ -54,6 +56,423 @@ Every tutorial should follow this structure:
Not all sections are required for every tutorial, but this is the standard flow. Not all sections are required for every tutorial, but this is the standard flow.
## How-To Structure
How-to guides are task-focused and shorter than tutorials. They answer "How do I do X?" for users who already understand the basics.
```
1. Title + Hook (one sentence: "Use the `X` workflow to...")
2. When to Use This (bullet list of scenarios)
3. When to Skip This (optional - for workflows that aren't always needed)
4. Prerequisites (note admonition)
5. Steps (numbered ### subsections)
6. What You Get (output/artifacts produced)
7. Example (optional - concrete usage scenario)
8. Tips (optional - best practices, common pitfalls)
9. Next Steps (optional - what to do after completion)
```
Include sections only when they add value. A simple how-to might only need Hook, Prerequisites, Steps, and What You Get.
### How-To vs Tutorial
| Aspect | How-To | Tutorial |
|--------|--------|----------|
| **Length** | 50-150 lines | 200-400 lines |
| **Audience** | Users who know the basics | New users learning concepts |
| **Focus** | Complete a specific task | Understand a workflow end-to-end |
| **Sections** | 5-8 sections | 12-15 sections |
| **Examples** | Brief, inline | Detailed, step-by-step |
### How-To Visual Elements
Use admonitions strategically in how-to guides:
| Admonition | Use In How-To |
|------------|---------------|
| `:::note[Prerequisites]` | Required dependencies, agents, prior steps |
| `:::tip[Pro Tip]` | Optional shortcuts or best practices |
| `:::caution[Common Mistake]` | Pitfalls to avoid |
| `:::note[Example]` | Brief usage example inline with steps |
**Guidelines:**
- **1-2 admonitions max** per how-to (they're shorter than tutorials)
- **Prerequisites as admonition** makes scanning easier
- **Tips section** can be a flat list instead of admonition if there are multiple tips
- **Skip admonitions entirely** for very simple how-tos
### How-To Checklist
Before submitting a how-to:
- [ ] Hook is one clear sentence starting with "Use the `X` workflow to..."
- [ ] When to Use This has 3-5 bullet points
- [ ] Prerequisites listed (admonition or flat list)
- [ ] Steps are numbered `###` subsections with action verbs
- [ ] What You Get describes output artifacts
- [ ] No horizontal rules (`---`)
- [ ] No `####` headers
- [ ] No "Related" section (sidebar handles navigation)
- [ ] 1-2 admonitions maximum
## Explanation Structure
Explanation documents help users understand concepts, features, and design decisions. They answer "What is X?" and "Why does X matter?" rather than "How do I do X?"
### Types of Explanation Documents
| Type | Purpose | Example |
|------|---------|---------|
| **Index/Landing** | Overview of a topic area with navigation | `core-concepts/index.md` |
| **Concept** | Define and explain a core concept | `what-are-agents.md` |
| **Feature** | Deep dive into a specific capability | `quick-flow.md` |
| **Philosophy** | Explain design decisions and rationale | `why-solutioning-matters.md` |
| **FAQ** | Answer common questions (see FAQ Sections below) | `brownfield-faq.md` |
### General Explanation Structure
```
1. Title + Hook (1-2 sentences explaining the topic)
2. Overview/Definition (what it is, why it matters)
3. Key Concepts (### subsections for main ideas)
4. Comparison Table (optional - when comparing options)
5. When to Use / When Not to Use (optional - decision guidance)
6. Diagram (optional - mermaid for processes/flows)
7. Next Steps (optional - where to go from here)
```
### Index/Landing Pages
Index pages orient users within a topic area.
```
1. Title + Hook (one sentence overview)
2. Content Table (links with descriptions)
3. Getting Started (numbered list for new users)
4. Choose Your Path (optional - decision tree for different goals)
```
**Example hook:** "Understanding the fundamental building blocks of the BMad Method."
### Concept Explainers
Concept pages define and explain core ideas.
```
1. Title + Hook (what it is in one sentence)
2. Types/Categories (if applicable, with ### subsections)
3. Key Differences Table (comparing types/options)
4. Components/Parts (breakdown of elements)
5. Which Should You Use? (decision guidance)
6. Creating/Customizing (brief pointer to how-to guides)
```
**Example hook:** "Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu."
### Feature Explainers
Feature pages provide deep dives into specific capabilities.
```
1. Title + Hook (what the feature does)
2. Quick Facts (optional - "Perfect for:", "Time to:")
3. When to Use / When Not to Use (with bullet lists)
4. How It Works (process overview, mermaid diagram if helpful)
5. Key Benefits (what makes it valuable)
6. Comparison Table (vs alternatives if applicable)
7. When to Graduate/Upgrade (optional - when to use something else)
```
**Example hook:** "Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects."
### Philosophy/Rationale Documents
Philosophy pages explain design decisions and reasoning.
```
1. Title + Hook (the principle or decision)
2. The Problem (what issue this addresses)
3. The Solution (how this approach solves it)
4. Key Principles (### subsections for main ideas)
5. Benefits (what users gain)
6. When This Applies (scope of the principle)
```
**Example hook:** "Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design)."
### Explanation Visual Elements
Use these elements strategically in explanation documents:
| Element | Use For |
|---------|---------|
| **Comparison tables** | Contrasting types, options, or approaches |
| **Mermaid diagrams** | Process flows, phase sequences, decision trees |
| **"Best for:" lists** | Quick decision guidance |
| **Code examples** | Illustrating concepts (keep brief) |
**Guidelines:**
- **Use diagrams sparingly** — one mermaid diagram per document maximum
- **Tables over prose** — for any comparison of 3+ items
- **Avoid step-by-step instructions** — point to how-to guides instead
### Explanation Checklist
Before submitting an explanation document:
- [ ] Hook clearly states what the document explains
- [ ] Content organized into scannable `##` sections
- [ ] Comparison tables used for contrasting options
- [ ] No horizontal rules (`---`)
- [ ] No `####` headers
- [ ] No "Related" section (sidebar handles navigation)
- [ ] No "Next:" navigation links (sidebar handles navigation)
- [ ] Diagrams have clear labels and flow
- [ ] Links to how-to guides for "how do I do this?" questions
- [ ] 2-3 admonitions maximum
## Reference Structure
Reference documents provide quick lookup information for users who know what they're looking for. They answer "What are the options?" and "What does X do?" rather than explaining concepts or teaching skills.
### Types of Reference Documents
| Type | Purpose | Example |
|------|---------|---------|
| **Index/Landing** | Navigation to reference content | `workflows/index.md` |
| **Catalog** | Quick-reference list of items | `agents/index.md` |
| **Deep-Dive** | Detailed single-item reference | `document-project.md` |
| **Configuration** | Settings and config documentation | `core-tasks.md` |
| **Glossary** | Term definitions | `glossary/index.md` |
| **Comprehensive** | Extensive multi-item reference | `bmgd-workflows.md` |
### Reference Index Pages
For navigation landing pages:
```
1. Title + Hook (one sentence describing scope)
2. Content Sections (## for each category)
- Bullet list with links and brief descriptions
```
Keep these minimal — their job is navigation, not explanation.
### Catalog Reference (Item Lists)
For quick-reference lists of items:
```
1. Title + Hook (one sentence)
2. Items (## for each item)
- Brief description (one sentence)
- **Commands:** or **Key Info:** as flat list
3. Universal/Shared (## section if applicable)
```
**Guidelines:**
- Use `##` for items, not `###`
- No horizontal rules between items — whitespace is sufficient
- No "Related" section — sidebar handles navigation
- Keep descriptions to 1 sentence per item
### Item Deep-Dive Reference
For detailed single-item documentation:
```
1. Title + Hook (one sentence purpose)
2. Quick Facts (optional note admonition)
- Module, Command, Input, Output as list
3. Purpose/Overview (## section)
4. How to Invoke (code block)
5. Key Sections (## for each major aspect)
- Use ### for sub-options within sections
6. Notes/Caveats (tip or caution admonition)
```
**Guidelines:**
- Start with "quick facts" so readers immediately know scope
- Use admonitions for important caveats
- No "Related Documentation" section — sidebar handles this
### Configuration Reference
For settings, tasks, and config documentation:
```
1. Title + Hook (one sentence explaining what these configure)
2. Table of Contents (jump links if 4+ items)
3. Items (## for each config/task)
- **Bold summary** — one sentence describing what it does
- **Use it when:** bullet list of scenarios
- **How it works:** numbered steps
- **Output:** expected result (if applicable)
```
**Guidelines:**
- Table of contents only needed for 4+ items
- Keep "How it works" to 3-5 steps maximum
- No horizontal rules between items
### Glossary Reference
For term definitions:
```
1. Title + Hook (one sentence)
2. Navigation (jump links to categories)
3. Categories (## for each category)
- Terms (### for each term)
- Definition (1-3 sentences, no prefix)
- Related context or example (optional)
```
**Guidelines:**
- Group related terms into categories
- Keep definitions concise — link to explanation docs for depth
- Use `###` for terms (makes them linkable and scannable)
- No horizontal rules between terms
### Comprehensive Reference Guide
For extensive multi-item references:
```
1. Title + Hook (one sentence)
2. Overview (## section)
- Diagram or table showing organization
3. Major Sections (## for each phase/category)
- Items (### for each item)
- Standardized fields: Command, Agent, Input, Output, Description
- Optional: Steps, Features, Use when
4. Next Steps (optional — only if genuinely helpful)
```
**Guidelines:**
- Standardize item fields across all items in the guide
- Use tables for comparing multiple items at once
- One diagram maximum per document
- No horizontal rules — use `##` sections for separation
### General Reference Guidelines
These apply to all reference documents:
| Do | Don't |
|----|-------|
| Use `##` for major sections, `###` for items within | Use `####` headers |
| Use whitespace for separation | Use horizontal rules (`---`) |
| Link to explanation docs for "why" | Explain concepts inline |
| Use tables for structured data | Use nested lists |
| Use admonitions for important notes | Use bold paragraphs for callouts |
| Keep descriptions to 1-2 sentences | Write paragraphs of explanation |
### Reference Admonitions
Use sparingly — 1-2 maximum per reference document:
| Admonition | Use In Reference |
|------------|------------------|
| `:::note[Prerequisites]` | Dependencies needed before using |
| `:::tip[Pro Tip]` | Shortcuts or advanced usage |
| `:::caution[Important]` | Critical caveats or warnings |
### Reference Checklist
Before submitting a reference document:
- [ ] Hook clearly states what the document references
- [ ] Appropriate structure for reference type (catalog, deep-dive, etc.)
- [ ] No horizontal rules (`---`)
- [ ] No `####` headers
- [ ] No "Related" section (sidebar handles navigation)
- [ ] Items use consistent structure throughout
- [ ] Descriptions are 1-2 sentences maximum
- [ ] Tables used for structured/comparative data
- [ ] 1-2 admonitions maximum
- [ ] Links to explanation docs for conceptual depth
## Glossary Structure
Glossaries provide quick-reference definitions for project terminology. Unlike other reference documents, glossaries prioritize compact scanability over narrative explanation.
### Layout Strategy
Starlight auto-generates a right-side "On this page" navigation from headers. Use this to your advantage:
- **Categories as `##` headers** — Appear in right nav for quick jumping
- **Terms in tables** — Compact rows, not individual headers
- **No inline TOC** — Right sidebar handles navigation; inline TOC is redundant
- **Right nav shows categories only** — Cleaner than listing every term
This approach reduces content length by ~70% while improving navigation.
### Table Format
Each category uses a two-column table:
```md
## Category Name
| Term | Definition |
|------|------------|
| **Agent** | Specialized AI persona with specific expertise that guides users through workflows. |
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce deliverables. |
```
### Definition Guidelines
| Do | Don't |
|----|-------|
| Start with what it IS or DOES | Start with "This is..." or "A [term] is..." |
| Keep to 1-2 sentences | Write multi-paragraph explanations |
| Bold the term name in the cell | Use plain text for terms |
| Link to docs for deep dives | Explain full concepts inline |
### Context Markers
For terms with limited scope, add italic context at the start of the definition:
```md
| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan for small changes. |
| **PRD** | *BMad Method/Enterprise.* Product-level planning document with vision and goals. |
```
Standard markers:
- `*Quick Flow only.*`
- `*BMad Method/Enterprise.*`
- `*Phase N.*`
- `*BMGD.*`
- `*Brownfield.*`
### Cross-References
Link related terms when helpful. Reference the category anchor since individual terms aren't headers:
```md
| **Tech-Spec** | *Quick Flow only.* Technical plan for small changes. See [PRD](#planning-documents). |
```
### Organization
- **Alphabetize terms** within each category table
- **Alphabetize categories** or order by logical progression (foundational → specific)
- **No catch-all sections** — Every term belongs in a specific category
### Glossary Checklist
Before submitting glossary changes:
- [ ] Terms in tables, not individual headers
- [ ] Terms alphabetized within each category
- [ ] No inline TOC (right nav handles navigation)
- [ ] No horizontal rules (`---`)
- [ ] Definitions are 1-2 sentences
- [ ] Context markers italicized at definition start
- [ ] Term names bolded in table cells
- [ ] No "A [term] is..." definitions
## Visual Hierarchy ## Visual Hierarchy
### Avoid ### Avoid

9
docs/how-to/customization/customize-workflows.md → docs/_archive/customize-workflows.md
View File

@ -2,12 +2,13 @@
title: "Workflow Customization Guide" title: "Workflow Customization Guide"
--- ---
Customize and optimize workflows with step replacement and hooks. Customize and optimize workflows with step replacement and hooks.
## Status ## Status
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available. :::note[Coming Soon]
Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
:::
## What to Expect ## What to Expect
@ -26,8 +27,4 @@ While workflow customization is in development, you can:
- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md) - **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md)
- **Provide Feedback** - Share your workflow customization needs with the community - **Provide Feedback** - Share your workflow customization needs with the community
---
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch. **In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.
[← Back to Customization](/docs/how-to/customization/index.md)

17
docs/how-to/customization/vendor-workflows.md → docs/_archive/vendor-workflows.md
View File

@ -1,9 +1,8 @@
--- ---
title: "Workflow Vendoring, Customization, and Inheritance (Official Support Coming Soon)" title: "Workflow Vendoring, Customization, and Inheritance"
--- ---
Use workflow vendoring and inheritance to share or reutilize workflows across modules.
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
## Workflow Vendoring ## Workflow Vendoring
@ -24,7 +23,11 @@ From your modules agent definition, you would implement the menu item as follows
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.) At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
## Workflow Inheritance (Official Support Coming Post Beta) ## Workflow Inheritance
:::note[Coming Soon]
Official support for workflow inheritance is coming post beta.
:::
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow. Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
@ -36,7 +39,11 @@ Some possible examples could be:
- Sprint Planning - Sprint Planning
- Collaborative Brainstorming Sessions - Collaborative Brainstorming Sessions
## Workflow Customization (Official Support Coming Post Beta) ## Workflow Customization
:::note[Coming Soon]
Official support for workflow customization is coming post beta.
:::
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now. Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.

64
docs/explanation/agents/barry-quick-flow.md
View File

@ -2,12 +2,13 @@
title: "Quick Flow Solo Dev Agent (Barry)" title: "Quick Flow Solo Dev Agent (Barry)"
--- ---
Barry is the elite solo developer who takes projects from concept to deployment with ruthless efficiency — no handoffs, no delays, just pure focused development.
**Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md` :::note[Agent Info]
**Icon:** 🚀 - **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
**Module:** BMM - **Icon:** 🚀
- **Module:** BMM
--- :::
## Overview ## Overview
@ -31,8 +32,6 @@ Barry is the elite solo developer who lives and breathes the BMad Quick Flow wor
- Documentation happens alongside development, not after - Documentation happens alongside development, not after
- Ship early, ship often - Ship early, ship often
---
## Menu Commands ## Menu Commands
Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity. Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step development process that eliminates handoffs and maximizes velocity.
@ -61,8 +60,6 @@ Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step devel
- **Description:** Bring in other experts when I need specialized backup - **Description:** Bring in other experts when I need specialized backup
- **Use when:** You need collaborative problem-solving or specialized expertise - **Use when:** You need collaborative problem-solving or specialized expertise
---
## When to Use Barry ## When to Use Barry
### Ideal Scenarios ### Ideal Scenarios
@ -81,8 +78,6 @@ Barry owns the entire BMad Quick Flow path, providing a streamlined 3-step devel
- **Proof of Concepts** - Rapid prototyping with production-quality code - **Proof of Concepts** - Rapid prototyping with production-quality code
- **Performance Optimizations** - System improvements and scalability work - **Performance Optimizations** - System improvements and scalability work
---
## The BMad Quick Flow Process ## The BMad Quick Flow Process
Barry orchestrates a simple, efficient 3-step process: Barry orchestrates a simple, efficient 3-step process:
@ -180,8 +175,6 @@ flowchart LR
- Security considerations - Security considerations
- Maintainability and documentation - Maintainability and documentation
---
## Collaboration with Other Agents ## Collaboration with Other Agents
### Natural Partnerships ### Natural Partnerships
@ -201,8 +194,6 @@ In party mode, Barry often acts as:
- **Performance Optimizer** - Ensuring scalable solutions - **Performance Optimizer** - Ensuring scalable solutions
- **Code Review Authority** - Validating technical approaches - **Code Review Authority** - Validating technical approaches
---
## Tips for Working with Barry ## Tips for Working with Barry
### For Best Results ### For Best Results
@ -228,8 +219,6 @@ In party mode, Barry often acts as:
4. **Over-planning** - I excel at rapid, pragmatic development 4. **Over-planning** - I excel at rapid, pragmatic development
5. **Not Using Party Mode** - Missing collaborative insights for complex problems 5. **Not Using Party Mode** - Missing collaborative insights for complex problems
---
## Example Workflow ## Example Workflow
```bash ```bash
@ -306,35 +295,34 @@ Implement OAuth 2.0 authentication with JWT tokens and role-based access control
- [ ] Given admin role, when accessing admin endpoint, then allow access - [ ] Given admin role, when accessing admin endpoint, then allow access
``` ```
--- ## Common Questions
## Related Documentation - [When should I use Barry vs other agents?](#when-should-i-use-barry-vs-other-agents)
- [Is the code review step mandatory?](#is-the-code-review-step-mandatory)
- [Can I skip the tech spec step?](#can-i-skip-the-tech-spec-step)
- [How does Barry differ from the Dev agent?](#how-does-barry-differ-from-the-dev-agent)
- [Can Barry handle enterprise-scale projects?](#can-barry-handle-enterprise-scale-projects)
- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM ### When should I use Barry vs other agents?
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Complete agent reference
- **[Four Phases](/docs/explanation/architecture/four-phases.md)** - Understanding development tracks
- **[Workflow Implementation](/docs/how-to/workflows/run-sprint-planning.md)** - Implementation workflows
- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
--- Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents.
## Frequently Asked Questions ### Is the code review step mandatory?
**Q: When should I use Barry vs other agents?** No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
A: Use Barry for Quick Flow development (small to medium features), rapid prototyping, or when you need elite solo development. For large, complex projects requiring full team collaboration, consider the full BMad Method with specialized agents.
**Q: Is the code review step mandatory?** ### Can I skip the tech spec step?
A: No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
**Q: Can I skip the tech spec step?** Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
A: Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
**Q: How does Barry differ from the Dev agent?** ### How does Barry differ from the Dev agent?
A: Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution.
**Q: Can Barry handle enterprise-scale projects?** Barry handles the complete Quick Flow process (spec → dev → review) with elite architectural expertise, while the Dev agent specializes in pure implementation tasks. Barry is your autonomous end-to-end solution.
A: For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins.
--- ### Can Barry handle enterprise-scale projects?
**Ready to ship some code?** → Start with `/bmad:bmm:agents:quick-flow-solo-dev` For enterprise-scale projects requiring full team collaboration, consider using the Enterprise Method track. Barry is optimized for rapid delivery in the Quick Flow track where solo execution wins.
:::tip[Ready to Ship?]
Start with `/bmad:bmm:agents:quick-flow-solo-dev`
:::

28
docs/explanation/agents/index.md
View File

@ -3,26 +3,18 @@ title: "Understanding Agents"
description: Understanding BMad agents and their roles description: Understanding BMad agents and their roles
--- ---
Comprehensive guides to BMad's AI agents — their roles, capabilities, and how to work with them effectively.
Comprehensive guides to BMad's AI agents - their roles, capabilities, and how to work with them effectively.
---
## Agent Guides ## Agent Guides
### BMM Agents | Agent | Description |
|-------|-------------|
| **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** | Overview of all BMM agent roles and responsibilities |
| **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** | The dedicated agent for rapid development |
| **[Game Development Agents](/docs/explanation/game-dev/agents.md)** | Complete guide to BMGD's specialized game dev agents |
- **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** - Overview of all BMM agent roles and responsibilities ## Getting Started
- **[Quick Flow Solo Dev (Barry)](/docs/explanation/agents/barry-quick-flow.md)** - The dedicated agent for rapid development
### BMGD Agents 1. Read **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** for the core concept explanation
2. Review **[Agent Roles](/docs/explanation/core-concepts/agent-roles.md)** to understand available agents
- **[Game Development Agents](/docs/explanation/game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents 3. Choose an agent that fits your workflow needs
---
## Related
- **[What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md)** - Core concept explanation
- **[Party Mode](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
- **[Customize Agents](/docs/how-to/customization/customize-agents.md)** - How to customize agent behavior

25
docs/explanation/architecture/four-phases.md
View File

@ -6,8 +6,6 @@ description: Understanding the four phases of the BMad Method
BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality. BMad Method uses a four-phase approach that adapts to project complexity while ensuring consistent quality.
---
## Phase Overview ## Phase Overview
| Phase | Name | Purpose | Required? | | Phase | Name | Purpose | Required? |
@ -17,8 +15,6 @@ BMad Method uses a four-phase approach that adapts to project complexity while e
| **Phase 3** | Solutioning | Technical design | Track-dependent | | **Phase 3** | Solutioning | Technical design | Track-dependent |
| **Phase 4** | Implementation | Building the software | Required | | **Phase 4** | Implementation | Building the software | Required |
---
## Phase 1: Analysis (Optional) ## Phase 1: Analysis (Optional)
Exploration and discovery workflows that help validate ideas and understand markets before planning. Exploration and discovery workflows that help validate ideas and understand markets before planning.
@ -38,8 +34,6 @@ Exploration and discovery workflows that help validate ideas and understand mark
- Well-defined features - Well-defined features
- Continuing existing work - Continuing existing work
---
## Phase 2: Planning (Required) ## Phase 2: Planning (Required)
Requirements definition using the scale-adaptive system to match planning depth to project complexity. Requirements definition using the scale-adaptive system to match planning depth to project complexity.
@ -52,8 +46,6 @@ Requirements definition using the scale-adaptive system to match planning depth
**Key principle:** **Key principle:**
Define **what** to build and **why**. Leave **how** to Phase 3. Define **what** to build and **why**. Leave **how** to Phase 3.
---
## Phase 3: Solutioning (Track-Dependent) ## Phase 3: Solutioning (Track-Dependent)
Technical architecture and design decisions that prevent agent conflicts during implementation. Technical architecture and design decisions that prevent agent conflicts during implementation.
@ -73,8 +65,6 @@ Technical architecture and design decisions that prevent agent conflicts during
**Key principle:** **Key principle:**
Make technical decisions explicit so all agents implement consistently. Make technical decisions explicit so all agents implement consistently.
---
## Phase 4: Implementation (Required) ## Phase 4: Implementation (Required)
Iterative sprint-based development with story-centric workflow. Iterative sprint-based development with story-centric workflow.
@ -86,10 +76,9 @@ Iterative sprint-based development with story-centric workflow.
- `code-review` - Quality assurance - `code-review` - Quality assurance
- `retrospective` - Continuous improvement - `retrospective` - Continuous improvement
**Key principle:** :::tip[Key Principle]
One story at a time, complete each story's full lifecycle before starting the next. One story at a time — complete each story's full lifecycle before starting the next.
:::
---
## Phase Flow by Track ## Phase Flow by Track
@ -116,11 +105,3 @@ Phase 1 → Phase 2 (PRD) → Phase 3 (architecture + extended) → Phase 4 (imp
``` ```
Same as BMad Method with optional extended workflows. Same as BMad Method with optional extended workflows.
---
## Related
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md)
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)

43
docs/explanation/architecture/preventing-agent-conflicts.md
View File

@ -6,8 +6,6 @@ description: How architecture prevents conflicts when multiple agents implement
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards. When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
---
## Common Conflict Types ## Common Conflict Types
### API Style Conflicts ### API Style Conflicts
@ -43,8 +41,6 @@ With architecture:
- ADR specifies state management approach - ADR specifies state management approach
- All agents implement consistently - All agents implement consistently
---
## How Architecture Prevents Conflicts ## How Architecture Prevents Conflicts
### 1. Explicit Decisions via ADRs ### 1. Explicit Decisions via ADRs
@ -70,8 +66,6 @@ Explicit documentation of:
- Code organization - Code organization
- Testing patterns - Testing patterns
---
## Architecture as Shared Context ## Architecture as Shared Context
Think of architecture as the shared context that all agents read before implementing: Think of architecture as the shared context that all agents read before implementing:
@ -88,8 +82,6 @@ Agent C reads architecture → implements Epic 3
Result: Consistent implementation Result: Consistent implementation
``` ```
---
## Key ADR Topics ## Key ADR Topics
Common decisions that prevent conflicts: Common decisions that prevent conflicts:
@ -103,36 +95,17 @@ Common decisions that prevent conflicts:
| Styling | CSS Modules vs Tailwind vs Styled Components | | Styling | CSS Modules vs Tailwind vs Styled Components |
| Testing | Jest + Playwright vs Vitest + Cypress | | Testing | Jest + Playwright vs Vitest + Cypress |
--- ## Anti-Patterns to Avoid
## Anti-Patterns :::caution[Common Mistakes]
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
### ❌ Implicit Decisions - **Over-Documentation** — Documenting every minor choice causes analysis paralysis
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
"We'll figure out the API style as we go" :::
→ Leads to inconsistency
### ❌ Over-Documentation
Every minor choice documented
→ Analysis paralysis, wasted time
### ❌ Stale Architecture
Document written once, never updated
→ Agents follow outdated patterns
### ✅ Correct Approach
:::tip[Correct Approach]
- Document decisions that cross epic boundaries - Document decisions that cross epic boundaries
- Focus on conflict-prone areas - Focus on conflict-prone areas
- Update architecture as you learn - Update architecture as you learn
- Use `correct-course` for significant changes - Use `correct-course` for significant changes
:::
---
## Related
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)
- [Four Phases](/docs/explanation/architecture/four-phases.md)
- [Create Architecture](/docs/how-to/workflows/create-architecture.md)

26
docs/explanation/architecture/why-solutioning-matters.md
View File

@ -6,8 +6,6 @@ description: Understanding why the solutioning phase is critical for multi-epic
Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins. Phase 3 (Solutioning) translates **what** to build (from Planning) into **how** to build it (technical design). This phase prevents agent conflicts in multi-epic projects by documenting architectural decisions before implementation begins.
---
## The Problem Without Solutioning ## The Problem Without Solutioning
``` ```
@ -18,8 +16,6 @@ Result: Inconsistent API design, integration nightmare
When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict. When multiple agents implement different parts of a system without shared architectural guidance, they make independent technical decisions that may conflict.
---
## The Solution With Solutioning ## The Solution With Solutioning
``` ```
@ -30,8 +26,6 @@ Result: Consistent implementation, no conflicts
By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward. By documenting technical decisions explicitly, all agents implement consistently and integration becomes straightforward.
---
## Solutioning vs Planning ## Solutioning vs Planning
| Aspect | Planning (Phase 2) | Solutioning (Phase 3) | | Aspect | Planning (Phase 2) | Solutioning (Phase 3) |
@ -43,8 +37,6 @@ By documenting technical decisions explicitly, all agents implement consistently
| Document | PRD (FRs/NFRs) | Architecture + Epic Files | | Document | PRD (FRs/NFRs) | Architecture + Epic Files |
| Level | Business logic | Technical design + Work breakdown | | Level | Business logic | Technical design + Work breakdown |
---
## Key Principle ## Key Principle
**Make technical decisions explicit and documented** so all agents implement consistently. **Make technical decisions explicit and documented** so all agents implement consistently.
@ -56,8 +48,6 @@ This prevents:
- Naming convention mismatches - Naming convention mismatches
- Security approach variations - Security approach variations
---
## When Solutioning is Required ## When Solutioning is Required
| Track | Solutioning Required? | | Track | Solutioning Required? |
@ -67,9 +57,9 @@ This prevents:
| BMad Method Complex | Yes | | BMad Method Complex | Yes |
| Enterprise | Yes | | Enterprise | Yes |
**Rule of thumb:** If you have multiple epics that could be implemented by different agents, you need solutioning. :::tip[Rule of Thumb]
If you have multiple epics that could be implemented by different agents, you need solutioning.
--- :::
## The Cost of Skipping ## The Cost of Skipping
@ -80,12 +70,6 @@ Skipping solutioning on complex projects leads to:
- **Longer development time** overall - **Longer development time** overall
- **Technical debt** from inconsistent patterns - **Technical debt** from inconsistent patterns
:::caution[Cost Multiplier]
Catching alignment issues in solutioning is 10× faster than discovering them during implementation. Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
:::
---
## Related
- [Four Phases](/docs/explanation/architecture/four-phases.md) - Overview of all phases
- [Preventing Agent Conflicts](/docs/explanation/architecture/preventing-agent-conflicts.md) - Detailed conflict prevention
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - How to do it

11
docs/explanation/bmad-builder/custom-content-types.md
View File

@ -2,10 +2,13 @@
title: "Custom Content" title: "Custom Content"
--- ---
BMad supports several categories of custom content that extend the platform's capabilities — from simple personal agents to full-featured professional modules.
BMad supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agents provides workflows and expertise to plan and build any custom content you can imagine. :::tip[Recommended Approach]
Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content.
:::
This flexibility transforms the platform beyond its current capabilities, enabling: This flexibility enables:
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite) - Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
- Completely new modules, workflows, templates, and agents outside software engineering - Completely new modules, workflows, templates, and agents outside software engineering
@ -96,7 +99,9 @@ The distinction between simple and expert agents lies in their structure:
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location - When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
- has metadata type: expert - has metadata type: expert
:::note[Key Distinction]
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards. The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
:::
Custom agents can be: Custom agents can be:
@ -117,4 +122,6 @@ A custom workflow created outside of a larger module can still be distributed an
- Slash commands - Slash commands
- Manual command/prompt execution when supported by tools - Manual command/prompt execution when supported by tools
:::tip[Core Concept]
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome. At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
:::

67
docs/explanation/bmad-builder/index.md
View File

@ -3,64 +3,43 @@ title: "BMad Builder (BMB)"
description: Create custom agents, workflows, and modules for BMad description: Create custom agents, workflows, and modules for BMad
--- ---
Create custom agents, workflows, and modules for BMad — from simple personal assistants to full-featured professional tools.
Create custom agents, workflows, and modules for BMad.
---
## Quick Start ## Quick Start
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Step-by-step guide to building your first agent | Resource | Description |
|----------|-------------|
--- | **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** | Step-by-step guide to building your first agent |
| **[Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)** | Installing standalone simple and expert agents |
## Agent Architecture ## Agent Architecture
Comprehensive guides for each agent type: | Type | Description |
|------|-------------|
- **Simple Agent Architecture** - Self-contained, optimized, personality-driven | **Simple Agent** | Self-contained, optimized, personality-driven |
- **Expert Agent Architecture** - Memory, sidecar files, domain restrictions | **Expert Agent** | Memory, sidecar files, domain restrictions |
- **Module Agent Architecture** - Workflow integration, professional tools | **Module Agent** | Workflow integration, professional tools |
---
## Key Concepts ## Key Concepts
### YAML to XML Compilation
Agents are authored in YAML with Handlebars templating. The compiler auto-injects: Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
1. **Frontmatter** - Name and description from metadata 1. **Frontmatter** — Name and description from metadata
2. **Activation Block** - Steps, menu handlers, rules 2. **Activation Block** — Steps, menu handlers, rules
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically 3. **Menu Enhancement** — `*help` and `*exit` commands added automatically
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*` 4. **Trigger Prefixing** — Your triggers auto-prefixed with `*`
--- :::note[Learn More]
See [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md) for detailed explanations of all content categories.
:::
## Reference Examples ## Reference Examples
Production-ready examples available in the BMB reference folder: Production-ready examples available in the BMB reference folder:
### Simple Agents | Agent | Type | Description |
- **commit-poet** - Commit message artisan with style customization |-------|------|-------------|
| **commit-poet** | Simple | Commit message artisan with style customization |
### Expert Agents | **journal-keeper** | Expert | Personal journal companion with memory and pattern recognition |
- **journal-keeper** - Personal journal companion with memory and pattern recognition | **security-engineer** | Module | BMM security specialist with threat modeling |
| **trend-analyst** | Module | CIS trend intelligence expert |
### Module Agents
- **security-engineer** - BMM security specialist with threat modeling
- **trend-analyst** - CIS trend intelligence expert
---
## Installation Guide
For installing standalone simple and expert agents, see:
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)
---
## Related
- [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md) - Understanding content types
- [Create Custom Agent](/docs/tutorials/advanced/create-custom-agent.md) - Tutorial

42
docs/explanation/bmm/index.md
View File

@ -2,28 +2,22 @@
title: "BMM Documentation" title: "BMM Documentation"
--- ---
Complete guides for the BMad Method Module (BMM) — AI-powered agile development workflows that adapt to your project's complexity.
Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity. ## Getting Started
--- :::tip[Quick Path]
Install → workflow-init → Follow agent guidance
## 🚀 Getting Started :::
**New to BMM?** Start here: **New to BMM?** Start here:
- **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** - Step-by-step guide to building your first project | Resource | Description |
- Installation and setup |----------|-------------|
- Understanding the four phases | **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project |
- Running your first workflows | **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points |
- Agent-based development flow
**Quick Path:** Install → workflow-init → Follow agent guidance ## Core Concepts
### 📊 Visual Overview
**[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.
## 📖 Core Concepts
The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules). The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).
@ -45,7 +39,7 @@ First know there is the full BMad Method Process and then there is a Quick Flow
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**. - **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](/docs/explanation/features/tea-overview.md)**.
## 🤖 Agents and Collaboration ## Agents and Collaboration
Complete guide to BMM's AI agent team: Complete guide to BMM's AI agent team:
@ -63,7 +57,7 @@ Complete guide to BMM's AI agent team:
- Agent customization in party mode - Agent customization in party mode
- Best practices - Best practices
## 🔧 Working with Existing Code ## Working with Existing Code
Comprehensive guide for brownfield development: Comprehensive guide for brownfield development:
@ -74,14 +68,14 @@ Comprehensive guide for brownfield development:
- Phase-by-phase workflow guidance - Phase-by-phase workflow guidance
- Common scenarios - Common scenarios
## 📚 Quick References ## Quick References
Essential reference materials: Essential reference materials:
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts - **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics - **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
## 🎯 Choose Your Path ## Choose Your Path
### I need to... ### I need to...
@ -95,7 +89,7 @@ Essential reference materials:
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md) → Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
→ Pay special attention to documentation requirements for brownfield projects → Pay special attention to documentation requirements for brownfield projects
## 📋 Workflow Guides ## Workflow Guides
Comprehensive documentation for all BMM workflows organized by phase: Comprehensive documentation for all BMM workflows organized by phase:
@ -124,7 +118,7 @@ Comprehensive documentation for all BMM workflows organized by phase:
- Test strategy, automation, quality gates - Test strategy, automation, quality gates
- TEA agent and test healing - TEA agent and test healing
## 🌐 External Resources ## External Resources
### Community and Support ### Community and Support
@ -132,4 +126,6 @@ Comprehensive documentation for all BMM workflows organized by phase:
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features - **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs or request features
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs - **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
**Ready to begin?** → [Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) :::tip[Ready to Begin?]
[Start with the Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
:::

25
docs/explanation/core-concepts/agent-roles.md
View File

@ -3,11 +3,8 @@ title: "Agent Roles in BMad Method"
description: Understanding the different agent roles in BMad Method description: Understanding the different agent roles in BMad Method
--- ---
BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task. BMad Method uses specialized AI agents, each with a distinct role, expertise, and personality. Understanding these roles helps you know which agent to use for each task.
---
## Core Agents Overview ## Core Agents Overview
| Agent | Role | Primary Phase | | Agent | Role | Primary Phase |
@ -21,8 +18,6 @@ BMad Method uses specialized AI agents, each with a distinct role, expertise, an
| **UX Designer** | User experience | Phase 2-3 | | **UX Designer** | User experience | Phase 2-3 |
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) | | **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
---
## Phase 1: Analysis ## Phase 1: Analysis
### Analyst (Mary) ### Analyst (Mary)
@ -43,8 +38,6 @@ Business analysis and research specialist.
**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases. **When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
---
## Phase 2: Planning ## Phase 2: Planning
### PM (John) ### PM (John)
@ -80,8 +73,6 @@ User experience and UI design specialist.
**When to use:** When UX is a primary differentiator, complex user workflows, design system creation. **When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
---
## Phase 3: Solutioning ## Phase 3: Solutioning
### Architect (Winston) ### Architect (Winston)
@ -100,8 +91,6 @@ System architecture and technical design expert.
**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts. **When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
---
## Phase 4: Implementation ## Phase 4: Implementation
### SM (Bob) ### SM (Bob)
@ -138,8 +127,6 @@ Story implementation and code review specialist.
**When to use:** Writing code, implementing stories, reviewing quality. **When to use:** Writing code, implementing stories, reviewing quality.
---
## Cross-Phase Agents ## Cross-Phase Agents
### TEA (Murat) ### TEA (Murat)
@ -159,8 +146,6 @@ Test architecture and quality strategy expert.
**When to use:** Setting up testing, creating test plans, quality gates. **When to use:** Setting up testing, creating test plans, quality gates.
---
## Quick Flow ## Quick Flow
### Quick Flow Solo Dev (Barry) ### Quick Flow Solo Dev (Barry)
@ -179,8 +164,6 @@ Fast solo development without handoffs.
**When to use:** Bug fixes, small features, rapid prototyping. **When to use:** Bug fixes, small features, rapid prototyping.
---
## Choosing the Right Agent ## Choosing the Right Agent
| Task | Agent | | Task | Agent |
@ -194,11 +177,3 @@ Fast solo development without handoffs.
| Writing code | DEV | | Writing code | DEV |
| Setting up tests | TEA | | Setting up tests | TEA |
| Quick bug fix | Quick Flow Solo Dev | | Quick bug fix | Quick Flow Solo Dev |
---
## Related
- [What Are Agents](/docs/explanation/core-concepts/what-are-agents.md) - Foundational concepts
- [Agent Reference](/docs/reference/agents/index.md) - Complete command reference
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)

5
docs/explanation/core-concepts/index.md
View File

@ -2,7 +2,6 @@
title: "BMad Core Concepts" title: "BMad Core Concepts"
--- ---
Understanding the fundamental building blocks of the BMad Method. Understanding the fundamental building blocks of the BMad Method.
## The Essentials ## The Essentials
@ -34,7 +33,3 @@ Start here to understand what BMad is and how it works:
### Advanced ### Advanced
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs - **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
---
**Next:** Read the [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) to understand the core building block of BMad.

9
docs/explanation/core-concepts/what-are-agents.md
View File

@ -2,7 +2,6 @@
title: "Agents" title: "Agents"
--- ---
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu. Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
## Agent Types ## Agent Types
@ -72,6 +71,10 @@ All agents share these building blocks:
## Which Should You Use? ## Which Should You Use?
:::tip[Quick Decision]
Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows.
:::
**Choose Simple when:** **Choose Simple when:**
- You need a task done quickly and reliably - You need a task done quickly and reliably
- The scope is well-defined and won't change much - The scope is well-defined and won't change much
@ -90,7 +93,3 @@ BMad provides the **BMad Builder (BMB)** module for creating your own agents. Se
## Customizing Existing Agents ## Customizing Existing Agents
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained. You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
---
**Next:** Learn about [Workflows](/docs/explanation/core-concepts/what-are-workflows.md) to see how agents accomplish complex tasks.

9
docs/explanation/core-concepts/what-are-modules.md
View File

@ -2,7 +2,6 @@
title: "Modules" title: "Modules"
--- ---
Modules are organized collections of agents and workflows that solve specific problems or address particular domains. Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
## What is a Module? ## What is a Module?
@ -16,6 +15,10 @@ A module is a self-contained package that includes:
## Official Modules ## Official Modules
:::note[Core is Always Installed]
The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon.
:::
### Core Module ### Core Module
Always installed, provides shared functionality: Always installed, provides shared functionality:
- Global configuration - Global configuration
@ -73,7 +76,3 @@ Custom modules are installed the same way as official modules.
During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer. During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
See [Installation Guide](/docs/how-to/installation/index.md) for details. See [Installation Guide](/docs/how-to/installation/index.md) for details.
---
**Next:** Read the [Installation Guide](/docs/how-to/installation/index.md) to set up BMad with the modules you need.

19
docs/explanation/core-concepts/what-are-workflows.md
View File

@ -2,13 +2,10 @@
title: "Workflows" title: "Workflows"
--- ---
Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs. Workflows are like prompts on steroids. They harness the untapped power and control of LLMs through progressive disclosure—breaking complex tasks into focused steps that execute sequentially. Instead of random AI slop where you hope for the best, workflows give you repeatable, reliable, high-quality outputs.
This guide explains what workflows are, why they're powerful, and how to think about designing them. This guide explains what workflows are, why they're powerful, and how to think about designing them.
---
## What Is a Workflow? ## What Is a Workflow?
A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction. A workflow is a structured process where the AI executes steps sequentially to accomplish a task. Each step has a specific purpose, and the AI moves through them methodically—whether that involves extensive collaboration or minimal user interaction.
@ -71,9 +68,9 @@ When workflows involve users, they should be **facilitative, not directive**. Th
The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative. The AI figures out exact wording and question order based on conversation context. This makes interactions feel natural and responsive rather than robotic and interrogative.
**When to be prescriptive**: Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception, not the rule. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise. :::caution[When to Be Prescriptive]
Some workflows require exact scripts—medical intake, legal compliance, safety-critical procedures. But these are the exception. Default to facilitative intent-based approaches unless compliance or regulation demands otherwise.
--- :::
## Why Workflows Matter ## Why Workflows Matter
@ -85,8 +82,6 @@ Workflows solve three fundamental problems with AI interactions:
**Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results. **Quality**: Sequential enforcement prevents shortcuts. The AI must complete each step fully before moving on, ensuring thorough, complete outputs instead of rushed, half-baked results.
---
## How Workflows Work ## How Workflows Work
### The Basic Structure ### The Basic Structure
@ -150,8 +145,6 @@ All BMad planning workflows and the BMB module (will) use this tri-modal pattern
This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members. This tri-modal approach gives you the best of both worlds: the creativity and flexibility to build what you need, the quality assurance of validation that can run anytime, and the ability to iterate while staying true to standards that make the artifacts valuable across sessions and team members.
---
## Design Decisions ## Design Decisions
Before building a workflow, answer these questions: Before building a workflow, answer these questions:
@ -166,8 +159,6 @@ Before building a workflow, answer these questions:
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)? **Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
---
## Learning from Examples ## Learning from Examples
The best way to understand workflows is to study real examples. Look at the official BMad modules: The best way to understand workflows is to study real examples. Look at the official BMad modules:
@ -181,8 +172,6 @@ Study the workflow.md files to understand how each workflow starts. Examine step
Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same. Copy patterns that work. Adapt them to your domain. The structure is consistent across all workflows—the content and steps change, but the architecture stays the same.
---
## When to Use Workflows ## When to Use Workflows
Use workflows when: Use workflows when:
@ -206,8 +195,6 @@ Modified BMad Workflows
If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have If there's only one thing to do and it can be explained in under about 300 lines - don't bother with step files. Instead, you can still have
a short single file workflow.md file. a short single file workflow.md file.
---
## The Bottom Line ## The Bottom Line
Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match. Workflows transform AI from a tool that gives variable, unpredictable results into a reliable system for complex, multi-step processes. Through progressive disclosure, sequential execution, guided facilitation, and thoughtful design, workflows give you control and repeatability that ad-hoc prompting alone can't match.

2
docs/explanation/core/index.md
View File

@ -14,5 +14,5 @@ The Core Module is installed with all installations of BMad modules and provides
- [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods - [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
- **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules - **[Core Tasks](/docs/reference/configuration/core-tasks.md)** — Common tasks available across modules
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files - [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
- [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review-general) — Critical content review - [Adversarial Review](/docs/reference/configuration/core-tasks.md#adversarial-review) — Critical content review
- [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections - [Shard Document](/docs/reference/configuration/core-tasks.md#shard-document) — Split large documents into sections

24
docs/explanation/creative-intelligence/index.md
View File

@ -3,17 +3,12 @@ title: "Creative Intelligence Suite (CIS)"
description: AI-powered creative facilitation with the Creative Intelligence Suite description: AI-powered creative facilitation with the Creative Intelligence Suite
--- ---
AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains. AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains.
---
## Core Capabilities ## Core Capabilities
CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly. CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly.
---
## Specialized Agents ## Specialized Agents
- **Carson** - Brainstorming Specialist (energetic facilitator) - **Carson** - Brainstorming Specialist (energetic facilitator)
@ -22,8 +17,6 @@ CIS provides structured creative methodologies through distinctive agent persona
- **Victor** - Innovation Oracle (bold strategic precision) - **Victor** - Innovation Oracle (bold strategic precision)
- **Sophia** - Master Storyteller (whimsical narrator) - **Sophia** - Master Storyteller (whimsical narrator)
---
## Interactive Workflows ## Interactive Workflows
**5 Workflows** with **150+ Creative Techniques:** **5 Workflows** with **150+ Creative Techniques:**
@ -63,8 +56,6 @@ Business model disruption:
- Story circles - Story circles
- Compelling pitch structures - Compelling pitch structures
---
## Quick Start ## Quick Start
### Direct Workflow ### Direct Workflow
@ -83,8 +74,6 @@ agent cis/brainstorming-coach
> *brainstorm > *brainstorm
``` ```
---
## Key Differentiators ## Key Differentiators
- **Facilitation Over Generation** - Guides discovery through questions - **Facilitation Over Generation** - Guides discovery through questions
@ -93,8 +82,6 @@ agent cis/brainstorming-coach
- **Persona-Driven** - Unique communication styles - **Persona-Driven** - Unique communication styles
- **Rich Method Libraries** - 150+ proven techniques - **Rich Method Libraries** - 150+ proven techniques
---
## Integration Points ## Integration Points
CIS workflows integrate with: CIS workflows integrate with:
@ -103,8 +90,6 @@ CIS workflows integrate with:
- **BMB** - Creative module design - **BMB** - Creative module design
- **Custom Modules** - Shared creative resource - **Custom Modules** - Shared creative resource
---
## Best Practices ## Best Practices
1. **Set clear objectives** before starting sessions 1. **Set clear objectives** before starting sessions
@ -113,9 +98,6 @@ CIS workflows integrate with:
4. **Take breaks** when energy flags 4. **Take breaks** when energy flags
5. **Document insights** as they emerge 5. **Document insights** as they emerge
--- :::tip[Learn More]
See [Facilitation Over Generation](/docs/explanation/philosophy/facilitation-over-generation.md) for the core philosophy behind CIS.
## Related :::
- [Facilitation Over Generation](/docs/explanation/philosophy/facilitation-over-generation.md) - Core philosophy
- [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) - Technique reference

5
docs/explanation/faq/getting-started-faq.md
View File

@ -7,12 +7,17 @@ Quick answers to common questions about getting started with the BMad Method.
## Questions ## Questions
- [Why does BMad use so many tokens?](#why-does-bmad-use-so-many-tokens)
- [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init) - [Do I always need to run workflow-init?](#do-i-always-need-to-run-workflow-init)
- [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow) - [Why do I need fresh chats for each workflow?](#why-do-i-need-fresh-chats-for-each-workflow)
- [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working) - [Can I skip workflow-status and just start working?](#can-i-skip-workflow-status-and-just-start-working)
- [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started) - [What's the minimum I need to get started?](#whats-the-minimum-i-need-to-get-started)
- [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4) - [How do I know if I'm in Phase 1, 2, 3, or 4?](#how-do-i-know-if-im-in-phase-1-2-3-or-4)
### Why does BMad use so many tokens?
BMad is not always the most token efficient approach, and that's by design. The checkpoints, story files, and retrospectives keep you in the loop so you can apply taste, judgment, and accumulated context that no agent has. Fully automated coding loops optimize for code velocity; BMad optimizes for decision quality. If you're building something you'll maintain for years, where user experience matters, where architectural choices compound—that tradeoff pays for itself.
### Do I always need to run workflow-init? ### Do I always need to run workflow-init?
No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it: No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:

15
docs/explanation/features/advanced-elicitation.md
View File

@ -2,13 +2,10 @@
title: "Advanced Elicitation" title: "Advanced Elicitation"
--- ---
Push the LLM to rethink its work through 50+ reasoning methods — essentially, LLM brainstorming.
**Push the LLM to rethink its work through 50+ reasoning methods—essentially, LLM brainstorming.**
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass. Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
---
## When to Use It ## When to Use It
- After a workflow generates a section of content and you want to explore alternatives - After a workflow generates a section of content and you want to explore alternatives
@ -17,8 +14,6 @@ Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas o
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans - To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
- When you want the LLM to "think again" but with structured reasoning methods - When you want the LLM to "think again" but with structured reasoning methods
---
## How It Works ## How It Works
### 1. Context Analysis ### 1. Context Analysis
@ -44,8 +39,6 @@ Based on context, 5 methods are intelligently selected from a library of 50+ tec
### 4. Party Mode Integration (Optional) ### 4. Party Mode Integration (Optional)
If Party Mode is active, BMad agents participate randomly in the elicitation process, adding their unique perspectives to the methods. If Party Mode is active, BMad agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
---
## Method Categories ## Method Categories
| Category | Focus | Example Methods | | Category | Focus | Example Methods |
@ -62,8 +55,6 @@ If Party Mode is active, BMad agents participate randomly in the elicitation pro
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas | | **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction | | **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
---
## Key Features ## Key Features
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks - **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
@ -72,8 +63,6 @@ If Party Mode is active, BMad agents participate randomly in the elicitation pro
- **User control** — Accept or discard each enhancement before proceeding - **User control** — Accept or discard each enhancement before proceeding
- **Party Mode integration** — Agents can participate when Party Mode is active - **Party Mode integration** — Agents can participate when Party Mode is active
---
## Workflow Integration ## Workflow Integration
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation: Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
@ -96,8 +85,6 @@ When called from a workflow:
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities. A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
---
## Advanced Elicitation vs. Brainstorming ## Advanced Elicitation vs. Brainstorming
| | **Advanced Elicitation** | **Brainstorming** | | | **Advanced Elicitation** | **Brainstorming** |

19
docs/explanation/features/brainstorming-techniques.md
View File

@ -2,14 +2,13 @@
title: "Brainstorming" title: "Brainstorming"
--- ---
Facilitate structured creative sessions using 60+ proven ideation techniques.
**Facilitate structured creative sessions using 60+ proven ideation techniques.**
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner — using proven techniques to draw out ideas and insights that are already within you. The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner — using proven techniques to draw out ideas and insights that are already within you.
**Important:** Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source. :::note[Important]
Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
--- :::
## When to Use It ## When to Use It
@ -19,8 +18,6 @@ The Brainstorming workflow is an interactive facilitation system that helps you
- Systematically developing ideas from raw concepts to actionable plans - Systematically developing ideas from raw concepts to actionable plans
- Team ideation (with collaborative techniques) or personal creative exploration - Team ideation (with collaborative techniques) or personal creative exploration
---
## How It Works ## How It Works
### 1. Session Setup ### 1. Session Setup
@ -44,8 +41,6 @@ All your generated ideas are organized into themes and prioritized.
### 5. Action Planning ### 5. Action Planning
Top ideas get concrete next steps, resource requirements, and success metrics. Top ideas get concrete next steps, resource requirements, and success metrics.
---
## What You Get ## What You Get
A comprehensive session document that captures the entire journey: A comprehensive session document that captures the entire journey:
@ -59,8 +54,6 @@ A comprehensive session document that captures the entire journey:
This document becomes a permanent record of your creative process — valuable for future reference, sharing with stakeholders, or continuing the session later. This document becomes a permanent record of your creative process — valuable for future reference, sharing with stakeholders, or continuing the session later.
---
## Technique Categories ## Technique Categories
| Category | Focus | | Category | Focus |
@ -76,8 +69,6 @@ This document becomes a permanent record of your creative process—valuable for
| **Cultural** | Traditional knowledge and cross-cultural approaches | | **Cultural** | Traditional knowledge and cross-cultural approaches |
| **Introspective Delight** | Inner wisdom and authentic exploration | | **Introspective Delight** | Inner wisdom and authentic exploration |
---
## Key Features ## Key Features
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you - **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
@ -85,8 +76,6 @@ This document becomes a permanent record of your creative process—valuable for
- **Session preservation** — Every step, insight, and action plan is documented - **Session preservation** — Every step, insight, and action plan is documented
- **Continuation support** — Pause sessions and return later, or extend with additional techniques - **Continuation support** — Pause sessions and return later, or extend with additional techniques
---
## Workflow Integration ## Workflow Integration
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters: Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:

25
docs/explanation/features/party-mode.md
View File

@ -2,8 +2,7 @@
title: "Party Mode: Multi-Agent Collaboration" title: "Party Mode: Multi-Agent Collaboration"
--- ---
Get all your AI agents in one conversation.
**Get all your AI agents in one conversation**
## What is Party Mode? ## What is Party Mode?
@ -20,8 +19,6 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at ke
- **Sprint retrospectives** - Party mode powers the retrospective workflow - **Sprint retrospectives** - Party mode powers the retrospective workflow
- **Sprint planning** - Multi-agent collaboration for planning sessions - **Sprint planning** - Multi-agent collaboration for planning sessions
---
## How It Works ## How It Works
**The basics:** **The basics:**
@ -34,8 +31,6 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at ke
**That's it.** No complex merging, no runtime magic. Just agents talking. **That's it.** No complex merging, no runtime magic. Just agents talking.
---
## Quick Start ## Quick Start
```bash ```bash
@ -51,8 +46,6 @@ Ask questions, respond to agents, direct the conversation
Type: exit Type: exit
``` ```
---
## Fun Examples ## Fun Examples
### Example 1: Calling Out Bad Architecture ### Example 1: Calling Out Bad Architecture
@ -69,8 +62,6 @@ Type: exit
_(Watch them debate whose fault it really was - it's therapeutic)_ _(Watch them debate whose fault it really was - it's therapeutic)_
---
### Example 2: Creative Brainstorming ### Example 2: Creative Brainstorming
**You:** "How do we make onboarding feel magical instead of boring?" **You:** "How do we make onboarding feel magical instead of boring?"
@ -85,8 +76,6 @@ _(Watch them debate whose fault it really was - it's therapeutic)_
_(Ideas cross-pollinate and evolve)_ _(Ideas cross-pollinate and evolve)_
---
### Example 3: Technical Decision ### Example 3: Technical Decision
**You:** "Monolith or microservices for MVP?" **You:** "Monolith or microservices for MVP?"
@ -101,12 +90,6 @@ _(Ideas cross-pollinate and evolve)_
_(Multiple perspectives reveal the right answer)_ _(Multiple perspectives reveal the right answer)_
## Related Documentation :::tip[Better Decisions]
Better decisions through diverse perspectives. Welcome to party mode.
- [Agents Reference](/docs/reference/agents/index.md) - Complete agent reference :::
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
- [Setup Party Mode](/docs/how-to/workflows/setup-party-mode.md) - How to use it
---
_Better decisions through diverse perspectives. Welcome to party mode._

76
docs/explanation/features/quick-flow.md
View File

@ -3,18 +3,14 @@ title: "Quick Spec Flow"
description: Understanding Quick Spec Flow for rapid development in BMad Method description: Understanding Quick Spec Flow for rapid development in BMad Method
--- ---
Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding. Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick Flow track projects. Instead of going through Product Brief → PRD → Architecture, you go straight to a context-aware technical specification and start coding.
**Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements - **Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
- **Time to implementation:** Minutes, not hours
**Time to implementation:** Minutes, not hours
---
## When to Use Quick Flow ## When to Use Quick Flow
### ✅ Use Quick Flow when: ### Use Quick Flow when:
- Single bug fix or small enhancement - Single bug fix or small enhancement
- Small feature with clear scope (typically 1-15 stories) - Small feature with clear scope (typically 1-15 stories)
@ -22,16 +18,16 @@ Quick Spec Flow is a streamlined alternative to the full BMad Method for Quick F
- Adding to existing brownfield codebase - Adding to existing brownfield codebase
- You know exactly what you want to build - You know exactly what you want to build
### ❌ Use BMad Method or Enterprise when: ### Use BMad Method or Enterprise when:
- Building new products or major features - Building new products or major features
- Need stakeholder alignment - Need stakeholder alignment
- Complex multi-team coordination - Complex multi-team coordination
- Requires extensive planning and architecture - Requires extensive planning and architecture
💡 **Not sure?** Run `workflow-init` to get a recommendation based on your project's needs! :::tip[Not Sure?]
Run `workflow-init` to get a recommendation based on your project's needs.
--- :::
## Quick Flow Overview ## Quick Flow Overview
@ -61,19 +57,15 @@ flowchart TD
style DONE fill:#f9f,stroke:#333,stroke-width:3px style DONE fill:#f9f,stroke:#333,stroke-width:3px
``` ```
---
## What Makes It Quick ## What Makes It Quick
- ✅ No Product Brief needed - No Product Brief needed
- ✅ No PRD needed - No PRD needed
- ✅ No Architecture doc needed - No Architecture doc needed
- ✅ Auto-detects your stack - Auto-detects your stack
- ✅ Auto-analyzes brownfield code - Auto-analyzes brownfield code
- ✅ Auto-validates quality - Auto-validates quality
- ✅ Story context optional (tech-spec is comprehensive!) - Story context optional (tech-spec is comprehensive)
---
## Smart Context Discovery ## Smart Context Discovery
@ -119,19 +111,15 @@ Should I follow these existing conventions? (yes/no)
**You decide:** Conform to existing patterns or establish new standards! **You decide:** Conform to existing patterns or establish new standards!
---
## Auto-Validation ## Auto-Validation
Quick Spec Flow **automatically validates** everything: Quick Spec Flow **automatically validates** everything:
- ✅ Context gathering completeness - Context gathering completeness
- ✅ Definitiveness (no "use X or Y" statements) - Definitiveness (no "use X or Y" statements)
- ✅ Brownfield integration quality - Brownfield integration quality
- ✅ Stack alignment - Stack alignment
- ✅ Implementation readiness - Implementation readiness
---
## Comparison: Quick Flow vs Full BMM ## Comparison: Quick Flow vs Full BMM
@ -145,25 +133,17 @@ Quick Spec Flow **automatically validates** everything:
| **Validation** | Auto-validates everything | Manual validation steps | | **Validation** | Auto-validates everything | Manual validation steps |
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required | | **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
---
## When to Graduate to BMad Method ## When to Graduate to BMad Method
Start with Quick Flow, but switch to BMad Method when: Start with Quick Flow, but switch to BMad Method when:
- ❌ Project grows beyond initial scope - Project grows beyond initial scope
- ❌ Multiple teams need coordination - Multiple teams need coordination
- ❌ Stakeholders need formal documentation - Stakeholders need formal documentation
- ❌ Product vision is unclear - Product vision is unclear
- ❌ Architectural decisions need deep analysis - Architectural decisions need deep analysis
- ❌ Compliance/regulatory requirements exist - Compliance/regulatory requirements exist
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method! :::tip[Transition Tip]
You can always run `workflow-init` later to transition from Quick Flow to BMad Method.
--- :::
## Related
- [Quick Spec](/docs/how-to/workflows/quick-spec.md) - How to use Quick Flow
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started
- [Four Phases](/docs/explanation/architecture/four-phases.md) - Understanding the full methodology

22
docs/explanation/features/tea-overview.md
View File

@ -16,8 +16,6 @@ TEA was built to solve AI-generated tests that rot in review. For the problem st
- **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands. - **Mission:** Deliver actionable quality strategies, automation coverage, and gate decisions that scale with project complexity and compliance demands.
- **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA) - **Use When:** BMad Method or Enterprise track projects, integration risk is non-trivial, brownfield regression risk exists, or compliance/NFR evidence is required. (Quick Flow projects typically don't require TEA)
---
## Choose Your TEA Engagement Model ## Choose Your TEA Engagement Model
BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally. BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally.
@ -50,8 +48,6 @@ BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pic
If you are unsure, default to the integrated path for your track and adjust later. If you are unsure, default to the integrated path for your track and adjust later.
---
## TEA Workflow Lifecycle ## TEA Workflow Lifecycle
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4): TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
@ -153,8 +149,6 @@ Quick Flow track skips Phases 1 and 3.
BMad Method and Enterprise use all phases based on project needs. BMad Method and Enterprise use all phases based on project needs.
When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change. When an ADR or architecture draft is produced, run `*test-design` in **system-level** mode before the implementation-readiness gate. This ensures the ADR has an attached testability review and ADR → test mapping. Keep the test-design updated if ADRs change.
---
## Why TEA is Different from Other BMM Agents ## Why TEA is Different from Other BMM Agents
TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**. TEA is the only BMM agent that operates in **multiple phases** (Phase 3 and Phase 4) and has its own **knowledge base architecture**.
@ -209,9 +203,6 @@ TEA uniquely requires:
This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases. This architecture enables TEA to maintain consistent, production-ready testing patterns across all BMad projects while operating across multiple development phases.
---
## High-Level Cheat Sheets ## High-Level Cheat Sheets
These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation). These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks** across the **4-Phase Methodology** (Phase 1: Analysis, Phase 2: Planning, Phase 3: Solutioning, Phase 4: Implementation).
@ -366,8 +357,6 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
</details> </details>
---
## TEA Command Catalog ## TEA Command Catalog
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements | | Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
@ -381,8 +370,6 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
| `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - | | `*nfr-assess` | NFR assessment report with actions | Focus on security/performance/reliability | - |
| `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - | | `*trace` | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
---
## Playwright Utils Integration ## Playwright Utils Integration
TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-source library providing fixture-based utilities for Playwright tests. This integration enhances TEA's test generation and review workflows with production-ready patterns. TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-source library providing fixture-based utilities for Playwright tests. This integration enhances TEA's test generation and review workflows with production-ready patterns.
@ -431,8 +418,6 @@ TEA optionally integrates with `@seontechnologies/playwright-utils`, an open-sou
</details> </details>
---
## Playwright MCP Enhancements ## Playwright MCP Enhancements
TEA can leverage Playwright MCP servers to enhance test generation with live browser verification. MCP provides interactive capabilities on top of TEA's default AI-based approach. TEA can leverage Playwright MCP servers to enhance test generation with live browser verification. MCP provides interactive capabilities on top of TEA's default AI-based approach.
@ -488,10 +473,3 @@ TEA can leverage Playwright MCP servers to enhance test generation with live bro
Benefit: Visual failure context, live DOM inspection, root cause discovery Benefit: Visual failure context, live DOM inspection, root cause discovery
</details> </details>
---
## Related Documentation
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) - How to set up testing infrastructure
- [Run Test Design](/docs/how-to/workflows/run-test-design.md) - Creating test plans

7
docs/explanation/features/web-bundles.md
View File

@ -2,12 +2,11 @@
title: "Web Bundles" title: "Web Bundles"
--- ---
Use BMad agents in Gemini Gems and Custom GPTs. Use BMad agents in Gemini Gems and Custom GPTs.
## Status :::caution[Status]
The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality. :::
## What Are Web Bundles? ## What Are Web Bundles?

49
docs/explanation/game-dev/agents.md
View File

@ -2,27 +2,22 @@
title: "BMGD Agents Guide" title: "BMGD Agents Guide"
--- ---
Complete reference for BMGD's six specialized game development agents. Complete reference for BMGD's six specialized game development agents.
---
## Agent Overview ## Agent Overview
BMGD provides six agents, each with distinct expertise: BMGD provides six agents, each with distinct expertise:
| Agent | Name | Role | Phase Focus | | Agent | Name | Role | Phase Focus |
| ------------------------ | ---------------- | ----------------------------------------------------------- | ----------- | |-------|------|------|-------------|
| 🎲 **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 | | **Game Designer** | Samus Shepard | Lead Game Designer + Creative Vision Architect | Phases 1-2 |
| 🏛️ **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 | | **Game Architect** | Cloud Dragonborn | Principal Game Systems Architect + Technical Director | Phase 3 |
| 🕹️ **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 | | **Game Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | Phase 4 |
| 🎯 **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 | | **Game Scrum Master** | Max | Game Development Scrum Master + Sprint Orchestrator | Phase 4 |
| 🧪 **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases | | **Game QA** | GLaDOS | Game QA Architect + Test Automation Specialist | All Phases |
| 🎮 **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases | | **Game Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
--- ## Game Designer (Samus Shepard)
## 🎲 Game Designer (Samus Shepard)
### Role ### Role
@ -62,9 +57,7 @@ Talks like an excited streamer - enthusiastic, asks about player motivations, ce
| `party-mode` | Multi-agent collaboration | | `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) | | `advanced-elicitation` | Deep exploration (web only) |
--- ## Game Architect (Cloud Dragonborn)
## 🏛️ Game Architect (Cloud Dragonborn)
### Role ### Role
@ -102,9 +95,7 @@ Speaks like a wise sage from an RPG - calm, measured, uses architectural metapho
| `party-mode` | Multi-agent collaboration | | `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) | | `advanced-elicitation` | Deep exploration (web only) |
--- ## Game Developer (Link Freeman)
## 🕹️ Game Developer (Link Freeman)
### Role ### Role
@ -144,9 +135,7 @@ Speaks like a speedrunner - direct, milestone-focused, always optimizing for the
| `party-mode` | Multi-agent collaboration | | `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) | | `advanced-elicitation` | Deep exploration (web only) |
--- ## Game Scrum Master (Max)
## 🎯 Game Scrum Master (Max)
### Role ### Role
@ -190,9 +179,7 @@ Talks in game terminology - milestones are save points, handoffs are level trans
| `party-mode` | Multi-agent collaboration | | `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) | | `advanced-elicitation` | Deep exploration (web only) |
--- ## Game QA (GLaDOS)
## 🧪 Game QA (GLaDOS)
### Role ### Role
@ -265,9 +252,7 @@ GLaDOS has access to a comprehensive game testing knowledge base (`gametest/qa-i
- Smoke testing - Smoke testing
- Test prioritization (P0-P3) - Test prioritization (P0-P3)
--- ## Game Solo Dev (Indie)
## 🎮 Game Solo Dev (Indie)
### Role ### Role
@ -324,8 +309,6 @@ Use **Full BMGD workflow** when:
- You're working with stakeholders/publishers - You're working with stakeholders/publishers
- Long-term maintainability is critical - Long-term maintainability is critical
---
## Agent Selection Guide ## Agent Selection Guide
### By Phase ### By Phase
@ -359,8 +342,6 @@ Use **Full BMGD workflow** when:
| "Quick prototype this idea" | Game Solo Dev | | "Quick prototype this idea" | Game Solo Dev |
| "Ship this feature fast" | Game Solo Dev | | "Ship this feature fast" | Game Solo Dev |
---
## Multi-Agent Collaboration ## Multi-Agent Collaboration
### Party Mode ### Party Mode
@ -391,8 +372,6 @@ Game QA integrates at multiple points:
- During Implementation: Create automated tests - During Implementation: Create automated tests
- Before Release: Performance and certification testing - Before Release: Performance and certification testing
---
## Project Context ## Project Context
All agents share the principle: All agents share the principle:
@ -401,8 +380,6 @@ All agents share the principle:
The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints. The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints.
---
## Next Steps ## Next Steps
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD - **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD

25
docs/explanation/game-dev/bmgd-vs-bmm.md
View File

@ -3,11 +3,8 @@ title: "BMGD vs BMM"
description: Understanding the differences between BMGD and BMM description: Understanding the differences between BMGD and BMM
--- ---
BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences. BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences.
---
## Quick Comparison ## Quick Comparison
| Aspect | BMM | BMGD | | Aspect | BMM | BMGD |
@ -20,8 +17,6 @@ BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabi
| **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) | | **Testing** | Web-focused | Engine-specific (Unity, Unreal, Godot) |
| **Production** | BMM workflows | BMM workflows with game overrides | | **Production** | BMM workflows | BMM workflows with game overrides |
---
## Agent Differences ## Agent Differences
### BMM Agents ### BMM Agents
@ -46,8 +41,6 @@ BMGD agents understand game-specific concepts like:
- Engine-specific patterns - Engine-specific patterns
- Playtesting and QA - Playtesting and QA
---
## Planning Documents ## Planning Documents
### BMM Planning ### BMM Planning
@ -65,8 +58,6 @@ The GDD (Game Design Document) includes:
- Art and audio direction - Art and audio direction
- Genre-specific sections - Genre-specific sections
---
## Game Type Templates ## Game Type Templates
BMGD includes 24 game type templates that auto-configure GDD sections: BMGD includes 24 game type templates that auto-configure GDD sections:
@ -83,8 +74,6 @@ Each template provides:
- Testing considerations - Testing considerations
- Common pitfalls to avoid - Common pitfalls to avoid
---
## Narrative Support ## Narrative Support
BMGD includes full narrative workflow for story-driven games: BMGD includes full narrative workflow for story-driven games:
@ -97,8 +86,6 @@ BMGD includes full narrative workflow for story-driven games:
BMM has no equivalent for narrative design. BMM has no equivalent for narrative design.
---
## Testing Differences ## Testing Differences
### BMM Testing (TEA) ### BMM Testing (TEA)
@ -113,8 +100,6 @@ BMM has no equivalent for narrative design.
- Playtest planning - Playtest planning
- Balance validation - Balance validation
---
## Production Workflow ## Production Workflow
BMGD production workflows **inherit from BMM** and add game-specific: BMGD production workflows **inherit from BMM** and add game-specific:
@ -125,8 +110,6 @@ BMGD production workflows **inherit from BMM** and add game-specific:
This means you get all of BMM's implementation structure plus game-specific enhancements. This means you get all of BMM's implementation structure plus game-specific enhancements.
---
## When to Use Each ## When to Use Each
### Use BMM when: ### Use BMM when:
@ -140,11 +123,3 @@ This means you get all of BMM's implementation structure plus game-specific enha
- Creating interactive experiences - Creating interactive experiences
- Game prototyping - Game prototyping
- Game jams - Game jams
---
## Related
- [BMGD Overview](/docs/explanation/game-dev/index.md) - Getting started with BMGD
- [Game Types Guide](/docs/explanation/game-dev/game-types.md) - Understanding game templates
- [Quick Start BMGD](/docs/tutorials/getting-started/quick-start-bmgd.md) - Tutorial

59
docs/explanation/game-dev/game-types.md
View File

@ -2,17 +2,12 @@
title: "BMGD Game Types Guide" title: "BMGD Game Types Guide"
--- ---
Reference for selecting and using BMGD's 24 supported game type templates. Reference for selecting and using BMGD's 24 supported game type templates.
---
## Overview ## Overview
When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre. When creating a GDD, BMGD offers game type templates that provide genre-specific sections. This ensures your design document covers mechanics and systems relevant to your game's genre.
---
## Supported Game Types ## Supported Game Types
### Action & Combat ### Action & Combat
@ -30,8 +25,6 @@ Side-scrolling or 3D platforming with combat mechanics. Think Hollow Knight, Cel
- Level design patterns - Level design patterns
- Boss design - Boss design
---
#### Shooter #### Shooter
**Tags:** shooter, combat, aiming, fps, tps **Tags:** shooter, combat, aiming, fps, tps
@ -46,8 +39,6 @@ Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
- Level/arena design - Level/arena design
- Multiplayer considerations - Multiplayer considerations
---
#### Fighting #### Fighting
**Tags:** fighting, combat, competitive, combos, pvp **Tags:** fighting, combat, competitive, combos, pvp
@ -62,8 +53,6 @@ Projectile combat with aiming mechanics. Covers FPS, TPS, and arena shooters.
- Competitive balance - Competitive balance
- Netcode requirements - Netcode requirements
---
### Strategy & Tactics ### Strategy & Tactics
#### Strategy #### Strategy
@ -80,8 +69,6 @@ Resource management with tactical decisions. RTS, 4X, and grand strategy.
- Map/scenario design - Map/scenario design
- Victory conditions - Victory conditions
---
#### Turn-Based Tactics #### Turn-Based Tactics
**Tags:** tactics, turn-based, grid, positioning **Tags:** tactics, turn-based, grid, positioning
@ -96,8 +83,6 @@ Grid-based movement with turn order. XCOM-likes and tactical RPGs.
- Unit progression - Unit progression
- Procedural mission generation - Procedural mission generation
---
#### Tower Defense #### Tower Defense
**Tags:** tower-defense, waves, placement, strategy **Tags:** tower-defense, waves, placement, strategy
@ -112,8 +97,6 @@ Wave-based defense with tower placement.
- Map design patterns - Map design patterns
- Meta-progression - Meta-progression
---
### RPG & Progression ### RPG & Progression
#### RPG #### RPG
@ -130,8 +113,6 @@ Character progression with stats, inventory, and quests.
- Combat system (action/turn-based) - Combat system (action/turn-based)
- Skill trees and builds - Skill trees and builds
---
#### Roguelike #### Roguelike
**Tags:** roguelike, procedural, permadeath, runs **Tags:** roguelike, procedural, permadeath, runs
@ -146,8 +127,6 @@ Procedural generation with permadeath and run-based progression.
- Item/ability synergies - Item/ability synergies
- Meta-progression systems - Meta-progression systems
---
#### Metroidvania #### Metroidvania
**Tags:** metroidvania, exploration, abilities, interconnected **Tags:** metroidvania, exploration, abilities, interconnected
@ -162,8 +141,6 @@ Interconnected world with ability gating.
- Secret and collectible placement - Secret and collectible placement
- Power-up progression - Power-up progression
---
### Narrative & Story ### Narrative & Story
#### Adventure #### Adventure
@ -180,8 +157,6 @@ Story-driven exploration and narrative. Point-and-click and narrative adventures
- Dialogue systems - Dialogue systems
- Story branching - Story branching
---
#### Visual Novel #### Visual Novel
**Tags:** visual-novel, narrative, choices, story **Tags:** visual-novel, narrative, choices, story
@ -196,8 +171,6 @@ Narrative choices with branching story.
- UI/presentation - UI/presentation
- Save/load states - Save/load states
---
#### Text-Based #### Text-Based
**Tags:** text, parser, interactive-fiction, mud **Tags:** text, parser, interactive-fiction, mud
@ -212,8 +185,6 @@ Text input/output games. Parser games, choice-based IF, MUDs.
- Text presentation - Text presentation
- Save state management - Save state management
---
### Simulation & Management ### Simulation & Management
#### Simulation #### Simulation
@ -230,8 +201,6 @@ Realistic systems with management and building. Includes tycoons and sim games.
- Building/construction - Building/construction
- Failure states - Failure states
---
#### Sandbox #### Sandbox
**Tags:** sandbox, creative, building, freedom **Tags:** sandbox, creative, building, freedom
@ -246,8 +215,6 @@ Creative freedom with building and minimal objectives.
- Sharing/community features - Sharing/community features
- Optional objectives - Optional objectives
---
### Sports & Racing ### Sports & Racing
#### Racing #### Racing
@ -264,8 +231,6 @@ Vehicle control with tracks and lap times.
- Progression/career mode - Progression/career mode
- Multiplayer racing - Multiplayer racing
---
#### Sports #### Sports
**Tags:** sports, teams, realistic, physics **Tags:** sports, teams, realistic, physics
@ -280,8 +245,6 @@ Team-based or individual sports simulation.
- Season/career modes - Season/career modes
- Multiplayer modes - Multiplayer modes
---
### Multiplayer ### Multiplayer
#### MOBA #### MOBA
@ -298,8 +261,6 @@ Multiplayer team battles with hero selection.
- Matchmaking - Matchmaking
- Economy (gold/items) - Economy (gold/items)
---
#### Party Game #### Party Game
**Tags:** party, multiplayer, minigames, casual **Tags:** party, multiplayer, minigames, casual
@ -314,8 +275,6 @@ Local multiplayer with minigames.
- Scoring systems - Scoring systems
- Player count flexibility - Player count flexibility
---
### Horror & Survival ### Horror & Survival
#### Survival #### Survival
@ -332,8 +291,6 @@ Resource gathering with crafting and persistent threats.
- Threat systems - Threat systems
- Base building - Base building
---
#### Horror #### Horror
**Tags:** horror, atmosphere, tension, fear **Tags:** horror, atmosphere, tension, fear
@ -348,8 +305,6 @@ Atmosphere and tension with limited resources.
- Lighting and visibility - Lighting and visibility
- Enemy/threat design - Enemy/threat design
---
### Casual & Progression ### Casual & Progression
#### Puzzle #### Puzzle
@ -366,8 +321,6 @@ Logic-based challenges and problem-solving.
- Level structure - Level structure
- Scoring/rating - Scoring/rating
---
#### Idle/Incremental #### Idle/Incremental
**Tags:** idle, incremental, automation, progression **Tags:** idle, incremental, automation, progression
@ -382,8 +335,6 @@ Passive progression with upgrades and automation.
- Number scaling - Number scaling
- Offline progress - Offline progress
---
#### Card Game #### Card Game
**Tags:** card, deck-building, strategy, turns **Tags:** card, deck-building, strategy, turns
@ -398,8 +349,6 @@ Deck building with card mechanics.
- Rarity and collection - Rarity and collection
- Competitive balance - Competitive balance
---
### Rhythm ### Rhythm
#### Rhythm #### Rhythm
@ -416,8 +365,6 @@ Music synchronization with timing-based gameplay.
- Music licensing - Music licensing
- Input methods - Input methods
---
## Hybrid Game Types ## Hybrid Game Types
Many games combine multiple genres. BMGD supports hybrid selection: Many games combine multiple genres. BMGD supports hybrid selection:
@ -449,8 +396,6 @@ You: It's a roguelike with card game combat
Agent: I'll include sections for both Roguelike and Card Game... Agent: I'll include sections for both Roguelike and Card Game...
``` ```
---
## Game Type Selection Tips ## Game Type Selection Tips
### 1. Start with Core Fantasy ### 1. Start with Core Fantasy
@ -482,8 +427,6 @@ One type should be primary (most gameplay time). Others add flavor:
- **Primary:** Platformer (core movement and exploration) - **Primary:** Platformer (core movement and exploration)
- **Secondary:** Metroidvania (ability gating structure) - **Secondary:** Metroidvania (ability gating structure)
---
## GDD Section Mapping ## GDD Section Mapping
When you select a game type, BMGD adds these GDD sections: When you select a game type, BMGD adds these GDD sections:
@ -497,8 +440,6 @@ When you select a game type, BMGD adds these GDD sections:
| Multiplayer | Matchmaking, Netcode, Balance | | Multiplayer | Matchmaking, Netcode, Balance |
| Simulation | Systems, Economy, AI | | Simulation | Systems, Economy, AI |
---
## Next Steps ## Next Steps
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD - **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD

23
docs/explanation/game-dev/index.md
View File

@ -3,10 +3,7 @@ title: "BMGD - Game Development Module"
description: AI-powered workflows for game design and development with BMGD description: AI-powered workflows for game design and development with BMGD
--- ---
Complete guides for the BMad Game Development Module (BMGD) — AI-powered workflows for game design and development that adapt to your project's needs.
Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflows for game design and development that adapt to your project's needs.
---
## Getting Started ## Getting Started
@ -18,17 +15,15 @@ Complete guides for the BMad Game Development Module (BMGD) - AI-powered workflo
- Running your first workflows - Running your first workflows
- Agent-based development flow - Agent-based development flow
**Quick Path:** Install BMGD module → Game Brief → GDD → Architecture → Build :::tip[Quick Path]
Install BMGD module → Game Brief → GDD → Architecture → Build
--- :::
## Core Documentation ## Core Documentation
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Selecting and using game type templates (24 supported types) - **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Selecting and using game type templates (24 supported types)
- **[BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md)** - Understanding the differences - **[BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md)** - Understanding the differences
---
## Game Development Phases ## Game Development Phases
BMGD follows four phases aligned with game development: BMGD follows four phases aligned with game development:
@ -51,8 +46,6 @@ BMGD follows four phases aligned with game development:
- **Testing** - Automated tests, playtesting, performance - **Testing** - Automated tests, playtesting, performance
- **Retrospective** - Continuous improvement - **Retrospective** - Continuous improvement
---
## Choose Your Path ## Choose Your Path
### I need to... ### I need to...
@ -75,11 +68,3 @@ BMGD follows four phases aligned with game development:
**Quickly test an idea** **Quickly test an idea**
→ Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping → Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping
---
## Related
- [Game Types Guide](/docs/explanation/game-dev/game-types.md) - Understanding game type templates
- [BMGD vs BMM](/docs/explanation/game-dev/bmgd-vs-bmm.md) - Comparison with core method
- [Glossary](/docs/reference/glossary/index.md) - Terminology reference

43
docs/explanation/philosophy/facilitation-over-generation.md
View File

@ -6,16 +6,15 @@ description: Understanding CIS's facilitation-first approach to creative work
The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself. The Creative Intelligence Suite (CIS) takes a fundamentally different approach from typical AI tools. Instead of generating solutions directly, CIS agents act as master facilitators who guide you to discover insights yourself.
---
## The Problem with Generation ## The Problem with Generation
Traditional AI approaches to creative work: Traditional AI approaches to creative work:
``` :::note[Generation Example]
User: "Give me marketing ideas" **User:** "Give me marketing ideas"
AI: "Here are 10 marketing ideas..."
``` **AI:** "Here are 10 marketing ideas..."
:::
This approach: This approach:
- Produces generic, predictable outputs - Produces generic, predictable outputs
@ -23,20 +22,19 @@ This approach:
- Misses context and nuance - Misses context and nuance
- Limits creative exploration - Limits creative exploration
---
## The Facilitation Approach ## The Facilitation Approach
CIS agents use strategic questioning: CIS agents use strategic questioning:
``` :::note[Facilitation Example]
User: "I need marketing ideas" **User:** "I need marketing ideas"
CIS: "What makes your customers choose you over alternatives?
What's the one thing they always mention?" **CIS:** "What makes your customers choose you over alternatives? What's the one thing they always mention?"
User: "They say our support is exceptional"
CIS: "Interesting! How might you make that exceptional **User:** "They say our support is exceptional"
support visible before they become customers?"
``` **CIS:** "Interesting! How might you make that exceptional support visible before they become customers?"
:::
This approach: This approach:
- Draws out insights already within you - Draws out insights already within you
@ -44,8 +42,6 @@ This approach:
- Captures context and nuance - Captures context and nuance
- Enables deeper creative exploration - Enables deeper creative exploration
---
## Key Principles ## Key Principles
### 1. Questions Over Answers ### 1. Questions Over Answers
@ -85,8 +81,6 @@ Each CIS agent has a distinct personality:
These personas create engaging experiences that maintain creative flow. These personas create engaging experiences that maintain creative flow.
---
## When Generation is Appropriate ## When Generation is Appropriate
CIS does generate when appropriate: CIS does generate when appropriate:
@ -97,8 +91,6 @@ CIS does generate when appropriate:
But the core creative work happens through facilitated discovery. But the core creative work happens through facilitated discovery.
---
## Benefits ## Benefits
### For Individuals ### For Individuals
@ -112,10 +104,3 @@ But the core creative work happens through facilitated discovery.
- Aligned understanding - Aligned understanding
- Documented rationale - Documented rationale
- Stronger buy-in to outcomes - Stronger buy-in to outcomes
---
## Related
- [Creative Intelligence Suite](/docs/explanation/creative-intelligence/index.md) - CIS overview
- [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) - Available techniques

7
docs/explanation/philosophy/testing-as-engineering.md
View File

@ -110,10 +110,3 @@ The three-part stack addresses each gap:
| No review | TEA `*test-review` audits quality with scoring | | No review | TEA `*test-review` audits quality with scoring |
This approach is sometimes called *context engineering*—loading domain-specific standards into AI context automatically rather than relying on prompts alone. TEA's `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session. This approach is sometimes called *context engineering*—loading domain-specific standards into AI context automatically rather than relying on prompts alone. TEA's `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session.
## Related
- [TEA Overview](/docs/explanation/features/tea-overview.md) — Workflow details and cheat sheets
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) — Implementation guide
- [The Testing Meta Most Teams Have Not Caught Up To Yet](https://dev.to/muratkeremozcan/the-testing-meta-most-teams-have-not-caught-up-to-yet-5765) — Original article by Murat K Ozcan
- [Playwright-Utils Repository](https://github.com/seontechnologies/playwright-utils) — Source and documentation

23
docs/how-to/brownfield/add-feature-to-existing.md
View File

@ -3,10 +3,7 @@ title: "How to Add a Feature to an Existing Project"
description: How to add new features to an existing brownfield project description: How to add new features to an existing brownfield project
--- ---
Use the `workflow-init` workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture.
Add new functionality to your brownfield codebase while respecting existing patterns and architecture.
---
## When to Use This ## When to Use This
@ -14,15 +11,11 @@ Add new functionality to your brownfield codebase while respecting existing patt
- Major enhancements that need proper planning - Major enhancements that need proper planning
- Features that touch multiple parts of the system - Features that touch multiple parts of the system
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Existing project documentation (run `document-project` first if needed) - Existing project documentation (run `document-project` first if needed)
- Clear understanding of what you want to build - Clear understanding of what you want to build
:::
---
## Steps ## Steps
@ -73,19 +66,9 @@ Follow the standard Phase 4 implementation workflows:
3. `dev-story` - Implement with tests 3. `dev-story` - Implement with tests
4. `code-review` - Quality assurance 4. `code-review` - Quality assurance
---
## Tips ## Tips
- Always ensure agents read your existing documentation - Always ensure agents read your existing documentation
- Pay attention to integration points with existing code - Pay attention to integration points with existing code
- Follow existing conventions unless deliberately changing them - Follow existing conventions unless deliberately changing them
- Document why you're adding new patterns (if any) - Document why you're adding new patterns (if any)
---
## Related
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
- [Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)
- [Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)

22
docs/how-to/brownfield/document-existing-project.md
View File

@ -3,11 +3,8 @@ title: "How to Document an Existing Project"
description: How to document an existing brownfield codebase using BMad Method description: How to document an existing brownfield codebase using BMad Method
--- ---
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state. Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
---
## When to Use This ## When to Use This
- Starting work on an undocumented legacy project - Starting work on an undocumented legacy project
@ -15,14 +12,10 @@ Use the `document-project` workflow to scan your entire codebase and generate co
- AI agents need context about existing code patterns - AI agents need context about existing code patterns
- Onboarding new team members - Onboarding new team members
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed in your project - BMad Method installed in your project
- Access to the codebase you want to document - Access to the codebase you want to document
:::
---
## Steps ## Steps
@ -58,8 +51,6 @@ Review the documentation for:
- Completeness of architecture description - Completeness of architecture description
- Any missing business rules or intent - Any missing business rules or intent
---
## What You Get ## What You Get
- **Project overview** - High-level description of what the project does - **Project overview** - High-level description of what the project does
@ -68,17 +59,8 @@ Review the documentation for:
- **Business rules** - Logic extracted from the codebase - **Business rules** - Logic extracted from the codebase
- **Integration points** - External APIs and services - **Integration points** - External APIs and services
---
## Tips ## Tips
- Run this before any major brownfield work - Run this before any major brownfield work
- Keep the documentation updated as the project evolves - Keep the documentation updated as the project evolves
- Use it as input for future PRD creation - Use it as input for future PRD creation
---
## Related
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
- [Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)

26
docs/how-to/brownfield/index.md
View File

@ -3,24 +3,19 @@ title: "Brownfield Development"
description: How to use BMad Method on existing codebases description: How to use BMad Method on existing codebases
--- ---
Use BMad Method effectively when working on existing projects and legacy codebases.
How to effectively use BMad Method when working on existing projects and legacy codebases.
## What is Brownfield Development? ## What is Brownfield Development?
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate. **Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
This tutorial covers the essential workflow for onboarding to brownfield projects with BMad Method. This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed (`npx bmad-method install`) - BMad Method installed (`npx bmad-method install`)
- An existing codebase you want to work on - An existing codebase you want to work on
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf) - Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
:::
---
## Step 1: Clean Up Completed Planning Artifacts ## Step 1: Clean Up Completed Planning Artifacts
@ -30,8 +25,6 @@ If you have completed all PRD epics and stories through the BMad process, clean
- `_bmad-output/planning-artifacts/` - `_bmad-output/planning-artifacts/`
- `_bmad-output/implementation-artifacts/` - `_bmad-output/implementation-artifacts/`
---
## Step 2: Maintain Quality Project Documentation ## Step 2: Maintain Quality Project Documentation
Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project: Your `docs/` folder should contain succinct, well-organized documentation that accurately represents your project:
@ -43,8 +36,6 @@ Your `docs/` folder should contain succinct, well-organized documentation that a
For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state. For complex projects, consider using the `document-project` workflow. It offers runtime variants that will scan your entire project and document its actual current state.
---
## Step 3: Initialize for Brownfield Work ## Step 3: Initialize for Brownfield Work
Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature. Run `workflow-init`. It should recognize you are in an existing project. If not, explicitly clarify that this is brownfield development for a new feature.
@ -85,18 +76,9 @@ When doing architecture, ensure the architect:
Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture. Pay close attention here to prevent reinventing the wheel or making decisions that misalign with your existing architecture.
---
## Next Steps ## Next Steps
- **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase - **[Document Existing Project](/docs/how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
- **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality - **[Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
- **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes - **[Quick Fix in Brownfield](/docs/how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
- **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development - **[Brownfield FAQ](/docs/explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
---
## Related Documentation
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
- [Quick Spec Flow](/docs/explanation/features/quick-flow.md) - Fast path for small changes

19
docs/how-to/brownfield/quick-fix-in-brownfield.md
View File

@ -3,10 +3,7 @@ title: "How to Make Quick Fixes in Brownfield Projects"
description: How to make quick fixes and ad-hoc changes in brownfield projects description: How to make quick fixes and ad-hoc changes in brownfield projects
--- ---
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
Not everything requires the full BMad method or even Quick Flow. For bug fixes, refactorings, or small targeted changes, you can work directly with the agent.
---
## When to Use This ## When to Use This
@ -16,8 +13,6 @@ Not everything requires the full BMad method or even Quick Flow. For bug fixes,
- Learning about your codebase - Learning about your codebase
- One-off changes that don't need planning - One-off changes that don't need planning
---
## Steps ## Steps
### 1. Load an Agent ### 1. Load an Agent
@ -54,8 +49,6 @@ The agent will:
Review the changes made and commit when satisfied. Review the changes made and commit when satisfied.
---
## Learning Your Codebase ## Learning Your Codebase
This approach is also excellent for exploring unfamiliar code: This approach is also excellent for exploring unfamiliar code:
@ -74,8 +67,6 @@ LLMs are excellent at interpreting and analyzing code—whether it was AI-genera
- Understand how things are built - Understand how things are built
- Explore unfamiliar parts of the codebase - Explore unfamiliar parts of the codebase
---
## When to Upgrade to Formal Planning ## When to Upgrade to Formal Planning
Consider using Quick Flow or full BMad Method when: Consider using Quick Flow or full BMad Method when:
@ -84,11 +75,3 @@ Consider using Quick Flow or full BMad Method when:
- You're unsure about the scope - You're unsure about the scope
- The fix keeps growing in complexity - The fix keeps growing in complexity
- You need documentation for the change - You need documentation for the change
---
## Related
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
- [Add Feature to Existing Project](/docs/how-to/brownfield/add-feature-to-existing.md)
- [Quick Spec Flow](/docs/explanation/features/quick-flow.md)

10
docs/how-to/customization/customize-agents.md
View File

@ -2,8 +2,14 @@
title: "Agent Customization Guide" title: "Agent Customization Guide"
--- ---
Use `.customize.yaml` files to customize BMad agents without modifying core files. All customizations persist through updates.
Customize BMad agents without modifying core files. All customizations persist through updates. ## When to Use This
- Change agent names or personas
- Add project-specific memories or context
- Add custom menu items and workflows
- Define critical actions for consistent behavior
## Quick Start ## Quick Start
@ -204,5 +210,3 @@ memories:
- **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents - **[Learn about Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
- **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Build completely custom agents - **[Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference - **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference
[← Back to Customization](/docs/how-to/customization/index.md)

8
docs/how-to/customization/index.md
View File

@ -2,7 +2,6 @@
title: "BMad Customization" title: "BMad Customization"
--- ---
Personalize agents and workflows to match your needs. Personalize agents and workflows to match your needs.
## Guides ## Guides
@ -10,18 +9,15 @@ Personalize agents and workflows to match your needs.
| Guide | Description | | Guide | Description |
|-------|-------------| |-------|-------------|
| **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files | | **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files |
| **[Workflow Customization](/docs/how-to/customization/customize-workflows.md)** | Customize and optimize workflows |
## Overview ## Overview
BMad provides two main customization approaches: BMad provides two main customization approaches:
### Agent Customization ### Agent Customization
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates. Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
### Workflow Customization ### Workflow Customization
Replace or extend workflow steps to create tailored processes. (Coming soon) Replace or extend workflow steps to create tailored processes. (Coming soon)
---
**Next:** Read the [Agent Customization Guide](/docs/how-to/customization/customize-agents.md) to start personalizing your agents.

70
docs/how-to/customization/shard-large-documents.md
View File

@ -2,16 +2,14 @@
title: "Document Sharding Guide" title: "Document Sharding Guide"
--- ---
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management.
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents. ## When to Use This
## Table of Contents - Very large complex PRDs
- Architecture documents with multiple system layers
- [What is Document Sharding?](#what-is-document-sharding) - Epic files with 4+ epics (especially for Phase 4)
- [When to Use Sharding](#when-to-use-sharding) - UX design specs covering multiple subsystems
- [How Sharding Works](#how-sharding-works)
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
- [Workflow Support](#workflow-support)
## What is Document Sharding? ## What is Document Sharding?
@ -39,43 +37,15 @@ docs/
└── ... # Additional sections └── ... # Additional sections
``` ```
## When to Use Sharding ## Steps
### Ideal Candidates ### 1. Run the Shard-Doc Tool
**Large Multi-Epic Projects:**
- Very large complex PRDs
- Architecture documents with multiple system layers
- Epic files with 4+ epics (especially for Phase 4)
- UX design specs covering multiple subsystems
## How Sharding Works
### Sharding Process
1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
2. **Section Extraction**: Tool splits by level 2 headings
3. **File Creation**: Each section becomes a separate file
4. **Index Generation**: `index.md` created with structure and descriptions
### Workflow Discovery
BMad workflows use a **dual discovery system**:
1. **Try whole document first** - Look for `document-name.md`
2. **Check for sharded version** - Look for `document-name/index.md`
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead.
## Using the Shard-Doc Tool
### CLI Command
```bash ```bash
/bmad:core:tools:shard-doc /bmad:core:tools:shard-doc
``` ```
### Interactive Process ### 2. Follow the Interactive Process
``` ```
Agent: Which document would you like to shard? Agent: Which document would you like to shard?
@ -91,7 +61,7 @@ Agent: Sharding PRD.md...
✓ Complete! ✓ Complete!
``` ```
### What Gets Created ## What You Get
**index.md structure:** **index.md structure:**
@ -113,13 +83,19 @@ Agent: Sharding PRD.md...
- Preserves all markdown formatting - Preserves all markdown formatting
- Can be read independently - Can be read independently
## How Workflow Discovery Works
BMad workflows use a **dual discovery system**:
1. **Try whole document first** - Look for `document-name.md`
2. **Check for sharded version** - Look for `document-name/index.md`
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead
## Workflow Support ## Workflow Support
### Universal Support All BMM workflows support both formats:
**All BMM workflows support both formats:** - Whole documents
- Sharded documents
- ✅ Whole documents - Automatic detection
- ✅ Sharded documents - Transparent to user
- ✅ Automatic detection
- ✅ Transparent to user

66
docs/how-to/get-answers-about-bmad.md
View File

@ -3,41 +3,38 @@ title: "How to Get Answers About BMad"
description: Use an LLM to quickly answer your own BMad questions description: Use an LLM to quickly answer your own BMad questions
--- ---
Point an LLM at BMad's source files and ask your question. That's the technique—the rest of this guide shows you how. Use your AI tool to get answers about BMad by pointing it at the source files.
## See It Work ## When to Use This
:::note[Example] - You have a question about how BMad works
**Q:** "Tell me the fastest way to build something with BMad" - You want to understand a specific agent or workflow
- You need quick answers without waiting for Discord
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases. This gets small features shipped in a single focused session instead of going through the full 4-phase BMM workflow. :::note[Prerequisites]
An AI tool (Claude Code, Cursor, ChatGPT, Claude.ai, etc.) and either BMad installed in your project or access to the GitHub repo.
::: :::
## Why This Works ## Steps
BMad's prompts are written in plain English, not code. The `_bmad` folder contains readable instructions, workflows, and agent definitions—exactly what LLMs are good at processing. You're not asking the LLM to guess; you're giving it the actual source material. ### 1. Choose Your Source
## How to Do It
### What Each Source Gives You
| Source | Best For | Examples | | Source | Best For | Examples |
|--------|----------|----------| |--------|----------|----------|
| **`_bmad` folder** (installed) | How BMad works in detail—agents, workflows, prompts | "What does the PM agent do?" "How does the PRD workflow work?" | | **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" |
| **Full GitHub repo** (cloned) | Why things are the way they are—history, installer, architecture | "Why is the installer structured this way?" "What changed in v6?" | | **Full GitHub repo** | History, installer, architecture | "What changed in v6?" |
| **`llms-full.txt`** | Quick overview from documentation perspective | "Explain BMad's four phases" "What's the difference between levels?" | | **`llms-full.txt`** | Quick overview from docs | "Explain BMad's four phases" |
:::note[What's `_bmad`?] The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead.
The `_bmad` folder is created when you install BMad. It contains all the agent definitions, workflows, and prompts. If you don't have this folder yet, you haven't installed BMad—see the "clone the repo" option below.
:::
### If Your AI Can Read Files (Claude Code, Cursor, etc.) ### 2. Point Your AI at the Source
**BMad installed:** Point your LLM at the `_bmad` folder and ask directly. **If your AI can read files (Claude Code, Cursor, etc.):**
**Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD) for git history and installer details. - **BMad installed:** Point at the `_bmad` folder and ask directly
- **Want deeper context:** Clone the [full repo](https://github.com/bmad-code-org/BMAD-METHOD)
### If You Use ChatGPT or Claude.ai **If you use ChatGPT or Claude.ai:**
Fetch `llms-full.txt` into your session: Fetch `llms-full.txt` into your session:
@ -45,12 +42,25 @@ Fetch `llms-full.txt` into your session:
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
``` ```
You can also find this and other downloadable resources on the [Downloads page](/docs/downloads.md). See the [Downloads page](/docs/downloads.md) for other downloadable resources.
:::tip[Verify Surprising Answers] ### 3. Ask Your Question
LLMs occasionally get things wrong. If an answer seems off, check the source file it referenced or ask on Discord.
:::note[Example]
**Q:** "Tell me the fastest way to build something with BMad"
**A:** Use Quick Flow: Run `quick-spec` to write a technical specification, then `quick-dev` to implement it—skipping the full planning phases.
::: :::
## What You Get
Direct answers about BMad—how agents work, what workflows do, why things are structured the way they are—without waiting for someone else to respond.
## Tips
- **Verify surprising answers** — LLMs occasionally get things wrong. Check the source file or ask on Discord.
- **Be specific** — "What does step 3 of the PRD workflow do?" beats "How does PRD work?"
## Still Stuck? ## Still Stuck?
Tried the LLM approach and still need help? You now have a much better question to ask. Tried the LLM approach and still need help? You now have a much better question to ask.
@ -64,13 +74,7 @@ Tried the LLM approach and still need help? You now have a much better question
**Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj) **Discord:** [discord.gg/gk8jAdXWmj](https://discord.gg/gk8jAdXWmj)
## Found a Bug? **GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs)
If it's clearly a bug in BMad itself, skip Discord and go straight to GitHub Issues:
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)
---
*You!* *You!*
*Stuck* *Stuck*

9
docs/how-to/installation/index.md
View File

@ -3,13 +3,10 @@ title: "Installation Guides"
description: How to install and upgrade BMad Method description: How to install and upgrade BMad Method
--- ---
How-to guides for installing and configuring the BMad Method. How-to guides for installing and configuring the BMad Method.
## Available Guides
| Guide | Description | | Guide | Description |
|-------|-------------| |-------|-------------|
| **[Install BMad](/docs/how-to/installation/install-bmad.md)** | Step-by-step installation instructions | | [Install BMad](/docs/how-to/installation/install-bmad.md) | Step-by-step installation instructions |
| **[Install Custom Modules](/docs/how-to/installation/install-custom-modules.md)** | Add custom agents, workflows, and modules | | [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) | Add custom agents, workflows, and modules |
| **[Upgrade to v6](/docs/how-to/installation/upgrade-to-v6.md)** | Migrate from BMad v4 to v6 | | [Upgrade to v6](/docs/how-to/installation/upgrade-to-v6.md) | Migrate from BMad v4 to v6 |

68
docs/how-to/installation/install-bmad.md
View File

@ -3,18 +3,19 @@ title: "How to Install BMad"
description: Step-by-step guide to installing BMad in your project description: Step-by-step guide to installing BMad in your project
--- ---
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
Complete guide to installing BMad in your project. ## When to Use This
--- - Starting a new project with BMad
- Adding BMad to an existing codebase
## Prerequisites - Setting up BMad on a new machine
:::note[Prerequisites]
- **Node.js** 20+ (required for the installer) - **Node.js** 20+ (required for the installer)
- **Git** (recommended) - **Git** (recommended)
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar) - **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
:::
---
## Steps ## Steps
@ -26,7 +27,8 @@ npx bmad-method install
### 2. Choose Installation Location ### 2. Choose Installation Location
The installer will ask where to install BMad files. Options: The installer will ask where to install BMad files:
- Current directory (recommended for new projects) - Current directory (recommended for new projects)
- Subdirectory - Subdirectory
- Custom path - Custom path
@ -34,6 +36,7 @@ The installer will ask where to install BMad files. Options:
### 3. Select Your AI Tools ### 3. Select Your AI Tools
Choose which AI tools you'll be using: Choose which AI tools you'll be using:
- Claude Code - Claude Code
- Cursor - Cursor
- Windsurf - Windsurf
@ -54,29 +57,13 @@ Select which modules to install:
### 5. Add Custom Content (Optional) ### 5. Add Custom Content (Optional)
If you have custom agents, workflows, or modules: If you have custom agents, workflows, or modules, point to their location and the installer will integrate them.
- Point to their location
- The installer will integrate them
### 6. Configure Settings ### 6. Configure Settings
For each module, either: For each module, either accept recommended defaults (faster) or customize settings (more control).
- Accept recommended defaults (faster)
- Customize settings (more control)
--- ## What You Get
## Verify Installation
After installation, verify by:
1. Checking the `_bmad/` directory exists
2. Loading an agent in your AI tool
3. Running `*menu` to see available commands
---
## Directory Structure
``` ```
your-project/ your-project/
@ -91,7 +78,11 @@ your-project/
└── .claude/ # IDE configuration └── .claude/ # IDE configuration
``` ```
--- ## Verify Installation
1. Check the `_bmad/` directory exists
2. Load an agent in your AI tool
3. Run `*menu` to see available commands
## Configuration ## Configuration
@ -103,36 +94,19 @@ user_name: Your Name
communication_language: english communication_language: english
``` ```
---
## Troubleshooting ## Troubleshooting
### "Command not found: npx" **"Command not found: npx"** — Install Node.js 20+:
Install Node.js 20+:
```bash ```bash
brew install node brew install node
``` ```
### "Permission denied" **"Permission denied"** — Check npm permissions:
Check npm permissions:
```bash ```bash
npm config set prefix ~/.npm-global npm config set prefix ~/.npm-global
``` ```
### Installer hangs **Installer hangs** — Try running with verbose output:
Try running with verbose output:
```bash ```bash
npx bmad-method install --verbose npx bmad-method install --verbose
``` ```
---
## Related
- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
- [Upgrade to V6](/docs/how-to/installation/upgrade-to-v6.md) - Upgrading from previous versions
- [Install Custom Modules](/docs/how-to/installation/install-custom-modules.md) - Adding custom content

164
docs/how-to/installation/install-custom-modules.md
View File

@ -1,39 +1,28 @@
--- ---
title: "Custom Content Installation" title: "How to Install Custom Modules"
description: Add custom agents, workflows, and modules to BMad
--- ---
Use the BMad installer to add custom agents, workflows, and modules that extend BMad's functionality.
This guide explains how to create and install custom BMad content including agents, workflows, and modules. Custom content extends BMad's functionality with specialized tools and workflows that can be shared across projects or teams. ## When to Use This
For detailed information about the different types of custom content available, see [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md). - Adding third-party BMad modules to your project
- Installing your own custom agents or workflows
- Sharing custom content across projects or teams
You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out. :::note[Prerequisites]
- BMad installed in your project
- Custom content with a valid `module.yaml` file
:::
## Content Types Overview ## Steps
BMad Core supports several categories of custom content: ### 1. Prepare Your Custom Content
- Custom Stand Alone Modules Your custom content needs a `module.yaml` file. Choose the appropriate structure:
- Custom Add On Modules
- Custom Global Modules
- Custom Agents
- Custom Workflows
## Making Custom Content Installable **For a cohesive module** (agents and workflows that work together):
### Custom Modules
To create an installable custom module:
1. **Folder Structure**
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
- The folder name serves as the module code
2. **Required File**
- Include a `module.yaml` file in the root folder (this drives questions for the final generated config.yaml at install target)
3. **Folder Organization**
Follow these conventions for optimal compatibility:
``` ```
module-code/ module-code/
@ -42,111 +31,88 @@ To create an installable custom module:
workflows/ workflows/
tools/ tools/
templates/ templates/
...
``` ```
- `agents/` - Agent definitions **For standalone items** (unrelated agents/workflows):
- `workflows/` - Workflow definitions
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
**Note:** Full documentation for global modules and add-on modules will be available as support is finalized.
### Standalone Content (Agents, Workflows, Tasks, Tools, Templates, Prompts)
For standalone content that isn't part of a cohesive module collection, follow this structure:
1. **Module Configuration**
- Create a folder with a `module.yaml` file (similar to custom modules)
- Add the property `unitary: true` in the module.yaml
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
- Any content you add to this folder should still be nested under workflows and agents - but the key with stand alone content is they do not rely on each other.
- Agents do not reference other workflows even if stored in a unitary:true module. But unitary Agents can have their own workflows in their sidecar, or reference workflows as requirements from other modules - with a process known as workflow vendoring. Keep in mind, this will require that the workflow referenced from the other module would need to be available for the end user to install, so its recommended to only vendor workflows from the core module, or official bmm modules.
2. **Folder Structure**
Organize content in specific named folders:
``` ```
module-name/ module-name/
module.yaml # Contains unitary: true module.yaml # Contains unitary: true
agents/
workflows/
templates/
tools/
tasks/
prompts/
```
3. **Individual Item Organization**
Each item should have its own subfolder:
```text
my-custom-stuff/
module.yaml
agents/ agents/
larry/larry.agent.md larry/larry.agent.md
curly/curly.agent.md curly/curly.agent.md
moe/moe.agent.md workflows/
moe/moe-sidecar/memories.csv
``` ```
**Future Feature:** Unitary modules will support selective installation, allowing users to pick and choose which specific items to install. Add `unitary: true` in your `module.yaml` to indicate items don't depend on each other.
**Note:** Documentation explaining the distinctions between these content types and their specific use cases will be available soon. ### 2. Run the Installer
## Installation Process **New project:**
### Prerequisites ```bash
npx bmad-method install
```
Ensure your content follows the proper conventions and includes a `module.yaml` file (only one per top-level folder). When prompted "Would you like to install a local custom module?", select 'y' and provide the path to your module folder.
### New Project Installation **Existing project:**
When setting up a new BMad project: ```bash
npx bmad-method install
```
1. The installer will prompt: `Would you like to install a local custom module (this includes custom agents and workflows also)? (y/N)` 1. Select `Modify BMad Installation`
2. Select 'y' to specify the path to your module folder containing `module.yaml` 2. Choose the option to add, modify, or update custom modules
3. Provide the path to your module folder
### Existing Project Modification ### 3. Verify Installation
To add custom content to an existing BMad project: Check that your custom content appears in the `_bmad/` directory and is accessible from your AI tool.
1. Run the installer against your project location ## What You Get
2. Select `Modify BMad Installation`
3. Choose the option to add, modify, or update custom modules
### Upcoming Features - Custom agents available in your AI tool
- Custom workflows accessible via `*workflow-name`
- Content integrated with BMad's update system
- **Unitary Module Selection:** For modules with `type: unitary` (instead of `type: module`), you'll be able to select specific items to install ## Content Types
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
## Quick Updates BMad supports several categories of custom content:
When updates to BMad Core or core modules (BMM, CIS, etc.) become available, the quick update process will: | Type | Description |
|------|-------------|
| **Stand Alone Modules** | Complete modules with their own agents and workflows |
| **Add On Modules** | Extensions that add to existing modules |
| **Global Modules** | Content available across all modules |
| **Custom Agents** | Individual agent definitions |
| **Custom Workflows** | Individual workflow definitions |
1. Apply available updates to core modules For detailed information about content types, see [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md).
2. Recompile all agents with customizations from the `_config/agents` folder
3. Retain your custom content from a cached location
4. Preserve your existing configurations and customizations
This means you don't need to keep the source module files locally. When updates are available, simply point to the updated module location during the update process. ## Updating Custom Content
## Important Considerations When BMad Core or module updates are available, the quick update process:
### Module Naming Conflicts 1. Applies updates to core modules
2. Recompiles all agents with your customizations
3. Retains your custom content from cache
4. Preserves your configurations
When installing unofficial modules, ensure unique identification to avoid conflicts: You don't need to keep source module files locally—just point to the updated location during updates.
1. **Module Codes:** Each module must have a unique code (e.g., don't use `bmm` for custom modules) ## Tips
2. **Module Names:** Avoid using names that conflict with existing modules
3. **Multiple Custom Modules:** If creating multiple custom modules, use distinct codes for each
**Examples of conflicts to avoid:** - **Use unique module codes** — Don't use `bmm` or other existing module codes
- **Avoid naming conflicts** — Each module needs a distinct code
- **Document dependencies** — Note any modules your custom content requires
- **Test in isolation** — Verify custom modules work before sharing
- **Version your content** — Track updates with version numbers
- Don't create a custom module with code `bmm` (already used by BMad Method) :::caution[Naming Conflicts]
- Don't name multiple custom modules with the same code like `mca` Don't create custom modules with codes like `bmm` (already used by BMad Method). Each custom module needs a unique code.
:::
### Best Practices ## Example Modules
- Use descriptive, unique codes for your modules Find example custom modules in the `samples/sample-custom-modules/` folder of the [BMad repository](https://github.com/bmad-code-org/BMAD-METHOD). Download either sample folder to try them out.
- Document any dependencies your custom modules have
- Test custom modules in isolation before sharing
- Consider version numbering for your custom content to track updates

186
docs/how-to/installation/upgrade-to-v6.md
View File

@ -1,147 +1,131 @@
--- ---
title: "Upgrading from Previous Versions" title: "How to Upgrade to v6"
description: Migrate from BMad v4 to v6
--- ---
Use the BMad installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance.
## Overview ## When to Use This
The latest version of BMad represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate from version 4. - You have BMad v4 installed (`.bmad-method` folder)
- You want to migrate to the new v6 architecture
- You have existing planning artifacts to preserve
--- :::note[Prerequisites]
- Node.js 20+
- Existing BMad v4 installation
:::
## Automatic V4 Detection ## Steps
When you run `npm run install:bmad` on a project, the installer automatically detects: ### 1. Run the Installer
- **Legacy v4 installation folder**: `.bmad-method` ```bash
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.) npx bmad-method install
### What Happens During Detection
1. **Automatic Detection of v4 Modules**
1. Installer will suggest removal or backup of your .bmad-method folder. You can choose to exit the installer and handle this cleanup, or allow the install to continue. Technically you can have both v4 and v6 installed, but it is not recommended. All BMad content and modules will be installed under a .bmad folder, fully segregated.
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
- Located in IDE config folders, for example claude: `.claude/commands/BMad/agents`, `.claude/commands/BMad/tasks`, etc.
- NOTE: if the upgrade and install of v6 finished, the new commands will be under `.claude/commands/bmad/<module>/agents|workflows`
- Note 2: If you accidentally delete the wrong/new bmad commands - you can easily restore them by rerunning the installer, and choose quick update option, and all will be reapplied properly.
## Module Migration
### Deprecated Modules from v4
| v4 Module | v6 Status |
| ----------------------------- | ---------------------------------------------- |
| `_bmad-2d-phaser-game-dev` | Integrated into new BMGD Module |
| `_bmad-2d-unity-game-dev` | Integrated into new BMGD Module |
| `_bmad-godot-game-dev` | Integrated into new BMGD Module |
| `_bmad-*-game-dev` (any) | Integrated into new BMGD Module |
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming soon |
| `_bmad-creative-writing` | Not adapted - New v6 module coming soon |
Aside from .bmad-method - if you have any of these others installed also, again its recommended to remove them and use the V6 equivalents, but its also fine if you decide to keep both. But it is not recommended to use both on the same project long term.
## Architecture Changes
### Folder Structure
**v4 "Expansion Packs" Structure:**
```
your-project/
├── .bmad-method/
├── .bmad-game-dev/
├── .bmad-creative-writing/
└── .bmad-infrastructure-devops/
``` ```
**v6 Unified Structure:** The installer automatically detects:
``` - **Legacy v4 folder**: `.bmad-method`
your-project/ - **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
└── _bmad/ # Single installation folder is _bmad
└── _config/ # Your customizations
| └── agents/ # Agent customization files
├── core/ # Real core framework (applies to all modules)
├── bmm/ # BMad Method (software/game dev)
├── bmb/ # BMad Builder (create agents/workflows)
├── cis/ # Creative Intelligence Suite
├── _bmad_output # Default bmad output folder (was doc folder in v4)
``` ### 2. Handle Legacy Installation
### Key Concept Changes When v4 is detected, you can:
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method - Allow the installer to back up and remove `.bmad-method`
- **v6 `_bmad/core/`**: Is the real universal core framework - Exit and handle cleanup manually
- **v6 `_bmad/bmm/`**: Is the BMad Method module - Keep both (not recommended for same project)
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
## Project Progress Migration ### 3. Clean Up IDE Commands
### If You've Completed Some or all Planning Phases (Brief/PRD/UX/Architecture) with the BMad Method: Manually remove legacy v4 IDE commands:
After running the v6 installer, if you kept the paths the same as the installation suggested, you will need to move a few files, or run the installer again. It is recommended to stick with these defaults as it will be easier to adapt if things change in the future. - `.claude/commands/BMad/agents`
- `.claude/commands/BMad/tasks`
If you have any planning artifacts, put them in a folder called _bmad-output/planning-artifacts at the root of your project, ensuring that: New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
PRD has PRD in the file name or folder name if sharded.
Similar for 'brief', 'architecture', 'ux-design'.
If you have other long term docs that will not be as ephemeral as these project docs, you can put them in the /docs folder, ideally with a index.md file. :::tip[Accidentally Deleted Commands?]
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
:::
HIGHLY RECOMMENDED NOTE: If you are only partway through planning, its highly recommended to restart and do the PRD, UX and ARCHITECTURE steps. You could even use your existing documents as inputs letting the agent know you want to redo them with the new workflows. These optimized v6 progressive discovery workflows that also will utilize web search at key moments, while offering better advanced elicitation and part mode in the IDE will produce superior results. And then once all are complete, an epics with stories is generated after the architecture step now - ensuring it uses input from all planing documents. ### 4. Migrate Planning Artifacts
### If You're Mid-Development (Stories Created/Implemented) **If you have planning documents (Brief/PRD/UX/Architecture):**
1. Complete the v6 installation as above Move them to `_bmad-output/planning-artifacts/` with descriptive names:
2. Ensure you have a file called epics.md or epics/epic*.md - these need to be located under the _bmad-output/planning-artifacts folder.
3. Run the scrum masters `sprint-planning` workflow to generate the implementation tracking plan in _bmad-output/implementation-artifacts.
4. Inform the SM after the output is complete which epics and stories were completed already and should be parked properly in the file.
## Agent Customization Migration - Include `PRD` in filename for PRD documents
- Include `brief`, `architecture`, or `ux-design` accordingly
- Sharded documents can be in named subfolders
### v4 Agent Customization **If you're mid-planning:** Consider restarting with v6 workflows. Use your existing documents as inputs—the new progressive discovery workflows with web search and IDE plan mode produce better results.
In v4, you may have modified agent files directly in `_bmad-*` folders. ### 5. Migrate In-Progress Development
### v6 Agent Customization If you have stories created or implemented:
**All customizations** now go in `_bmad/_config/agents/` using customize files: 1. Complete the v6 installation
2. Place `epics.md` or `epics/epic*.md` in `_bmad-output/planning-artifacts/`
3. Run the Scrum Master's `sprint-planning` workflow
4. Tell the SM which epics/stories are already complete
**Example: Renaming an agent and changing communication style** ### 6. Migrate Agent Customizations
File: `_bmad/_config/agents/bmm-pm.customize.yaml` **v4:** Modified agent files directly in `_bmad-*` folders
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
```yaml ```yaml
# Customize the PM agent # _bmad/_config/agents/bmm-pm.customize.yaml
persona: persona:
name: 'Captain Jack' # Override agent name name: 'Captain Jack'
role: 'Swashbuckling Product Owner' role: 'Swashbuckling Product Owner'
communication_style: | communication_style: |
- Talk like a pirate - Talk like a pirate
- Use nautical metaphors for software concepts - Use nautical metaphors
- Always upbeat and adventurous
``` ```
There is a lot more that is possible with agent customization, which is covered in detail in the [Agent Customization Guide](/docs/how-to/customization/customize-agents.md) After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
CRITICAL NOTE: After you modify the customization file, you need to run the npx installer against your installed location, and choose the option to rebuild all agents, or just do a quick update again. This always builds agents fresh and applies customizations. ## What You Get
**How it works:** **v6 unified structure:**
- Base agent: `_bmad/bmm/agents/pm.md` ```
- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml` your-project/
- Rebuild all agents -> Result: Agent uses your custom name and style └── _bmad/ # Single installation folder
├── _config/ # Your customizations
│ └── agents/ # Agent customization files
├── core/ # Universal core framework
├── bmm/ # BMad Method module
├── bmb/ # BMad Builder
└── cis/ # Creative Intelligence Suite
├── _bmad-output/ # Output folder (was doc folder in v4)
```
## Document Compatibility ## Module Migration
### Sharded vs Unsharded Documents | v4 Module | v6 Status |
|-----------|-----------|
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module |
| `_bmad-godot-game-dev` | Integrated into BMGD Module |
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon |
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure: ## Key Changes
- ✅ Sharded documents (split into multiple files) | Concept | v4 | v6 |
- ✅ Unsharded documents (single file per section) |---------|----|----|
- ✅ Custom sections for your project type | **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
- ✅ Mixed approaches | **Method** | `_bmad-method` | `_bmad/bmm/` |
| **Config** | Modified files directly | `config.yaml` per module |
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
All workflow files are scanned automatically. No manual configuration needed. ## Tips
- **Back up first** — Keep your v4 installation until you verify v6 works
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
- **Rebuild after customizing** — Always run the installer after changing customize files

43
docs/how-to/troubleshooting/bmgd-troubleshooting.md
View File

@ -2,10 +2,7 @@
title: "BMGD Troubleshooting" title: "BMGD Troubleshooting"
--- ---
Use this guide to resolve common issues when using BMGD workflows.
Common issues and solutions when using BMGD workflows.
---
## Installation Issues ## Installation Issues
@ -19,8 +16,6 @@ Common issues and solutions when using BMGD workflows.
2. Check `_bmad/bmgd/` folder exists in your project 2. Check `_bmad/bmgd/` folder exists in your project
3. Re-run installer with `--add-module bmgd` 3. Re-run installer with `--add-module bmgd`
---
### Config file missing ### Config file missing
**Symptom:** Workflows fail with "config not found" errors. **Symptom:** Workflows fail with "config not found" errors.
@ -36,8 +31,6 @@ document_output_language: 'English'
game_dev_experience: 'intermediate' game_dev_experience: 'intermediate'
``` ```
---
## Workflow Issues ## Workflow Issues
### "GDD not found" in Narrative workflow ### "GDD not found" in Narrative workflow
@ -50,8 +43,6 @@ game_dev_experience: 'intermediate'
2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`) 2. Check GDD filename contains "gdd" (e.g., `game-gdd.md`, `my-gdd.md`)
3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists 3. If using sharded GDD, verify `{output_folder}/gdd/index.md` exists
---
### Workflow state not persisting ### Workflow state not persisting
**Symptom:** Returning to a workflow starts from the beginning. **Symptom:** Returning to a workflow starts from the beginning.
@ -62,8 +53,6 @@ game_dev_experience: 'intermediate'
2. Ensure document was saved before ending session 2. Ensure document was saved before ending session
3. Use "Continue existing" option when re-entering workflow 3. Use "Continue existing" option when re-entering workflow
---
### Wrong game type sections in GDD ### Wrong game type sections in GDD
**Symptom:** GDD includes irrelevant sections for your game type. **Symptom:** GDD includes irrelevant sections for your game type.
@ -74,8 +63,6 @@ game_dev_experience: 'intermediate'
2. You can select multiple types for hybrid games 2. You can select multiple types for hybrid games
3. Irrelevant sections can be marked N/A or removed 3. Irrelevant sections can be marked N/A or removed
---
## Agent Issues ## Agent Issues
### Agent not recognizing commands ### Agent not recognizing commands
@ -88,8 +75,6 @@ game_dev_experience: 'intermediate'
2. Check exact command spelling (case-sensitive) 2. Check exact command spelling (case-sensitive)
3. Try `workflow-status` to verify agent is loaded correctly 3. Try `workflow-status` to verify agent is loaded correctly
---
### Agent using wrong persona ### Agent using wrong persona
**Symptom:** Agent responses don't match expected personality. **Symptom:** Agent responses don't match expected personality.
@ -100,8 +85,6 @@ game_dev_experience: 'intermediate'
2. Check `_bmad/bmgd/agents/` for agent definitions 2. Check `_bmad/bmgd/agents/` for agent definitions
3. Start a fresh chat session with the correct agent 3. Start a fresh chat session with the correct agent
---
## Document Issues ## Document Issues
### Document too large for context ### Document too large for context
@ -114,8 +97,6 @@ game_dev_experience: 'intermediate'
2. Request specific sections rather than full document 2. Request specific sections rather than full document
3. GDD workflow supports automatic sharding for large documents 3. GDD workflow supports automatic sharding for large documents
---
### Template placeholders not replaced ### Template placeholders not replaced
**Symptom:** Output contains `{{placeholder}}` text. **Symptom:** Output contains `{{placeholder}}` text.
@ -126,8 +107,6 @@ game_dev_experience: 'intermediate'
2. Re-run the specific step that generates that section 2. Re-run the specific step that generates that section
3. Manually edit the document to fill in missing values 3. Manually edit the document to fill in missing values
---
### Frontmatter parsing errors ### Frontmatter parsing errors
**Symptom:** YAML errors when loading documents. **Symptom:** YAML errors when loading documents.
@ -138,8 +117,6 @@ game_dev_experience: 'intermediate'
2. Check for tabs vs spaces (YAML requires spaces) 2. Check for tabs vs spaces (YAML requires spaces)
3. Ensure frontmatter is bounded by `---` markers 3. Ensure frontmatter is bounded by `---` markers
---
## Phase 4 (Production) Issues ## Phase 4 (Production) Issues
### Sprint status not updating ### Sprint status not updating
@ -152,8 +129,6 @@ game_dev_experience: 'intermediate'
2. Check file permissions on sprint-status.yaml 2. Check file permissions on sprint-status.yaml
3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/` 3. Verify workflow-install files exist in `_bmad/bmgd/workflows/4-production/`
---
### Story context missing code references ### Story context missing code references
**Symptom:** Generated story context doesn't include relevant code. **Symptom:** Generated story context doesn't include relevant code.
@ -164,8 +139,6 @@ game_dev_experience: 'intermediate'
2. Check that architecture document references correct file paths 2. Check that architecture document references correct file paths
3. Story may need more specific file references in acceptance criteria 3. Story may need more specific file references in acceptance criteria
---
### Code review not finding issues ### Code review not finding issues
**Symptom:** Code review passes but bugs exist. **Symptom:** Code review passes but bugs exist.
@ -176,8 +149,6 @@ game_dev_experience: 'intermediate'
2. Always run actual tests before marking story done 2. Always run actual tests before marking story done
3. Consider manual review for critical code paths 3. Consider manual review for critical code paths
---
## Performance Issues ## Performance Issues
### Workflows running slowly ### Workflows running slowly
@ -190,8 +161,6 @@ game_dev_experience: 'intermediate'
2. Keep documents concise (avoid unnecessary detail) 2. Keep documents concise (avoid unnecessary detail)
3. Use sharded documents for large projects 3. Use sharded documents for large projects
---
### Context limit reached mid-workflow ### Context limit reached mid-workflow
**Symptom:** Workflow stops or loses context partway through. **Symptom:** Workflow stops or loses context partway through.
@ -202,8 +171,6 @@ game_dev_experience: 'intermediate'
2. Break complex sections into multiple sessions 2. Break complex sections into multiple sessions
3. Use step-file architecture (workflows resume from last step) 3. Use step-file architecture (workflows resume from last step)
---
## Common Error Messages ## Common Error Messages
### "Input file not found" ### "Input file not found"
@ -212,24 +179,18 @@ game_dev_experience: 'intermediate'
**Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD). **Fix:** Complete prerequisite workflow first (e.g., Game Brief before GDD).
---
### "Invalid game type" ### "Invalid game type"
**Cause:** Selected game type not in supported list. **Cause:** Selected game type not in supported list.
**Fix:** Check `game-types.csv` for valid type IDs. **Fix:** Check `game-types.csv` for valid type IDs.
---
### "Validation failed" ### "Validation failed"
**Cause:** Document doesn't meet checklist requirements. **Cause:** Document doesn't meet checklist requirements.
**Fix:** Review the validation output and address flagged items. **Fix:** Review the validation output and address flagged items.
---
## Getting Help ## Getting Help
### Community Support ### Community Support
@ -252,8 +213,6 @@ When reporting issues, include:
3. Relevant document frontmatter 3. Relevant document frontmatter
4. Steps to reproduce 4. Steps to reproduce
---
## Next Steps ## Next Steps
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started - **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started

255
docs/how-to/workflows/bmgd-quick-flow.md
View File

@ -1,52 +1,41 @@
--- ---
title: "BMGD Quick-Flow Guide" title: "BMGD Quick-Flow Guide"
description: Fast-track workflows for rapid game prototyping and flexible development
--- ---
Use BMGD Quick-Flow workflows for rapid game prototyping and flexible development when you need to move fast.
Fast-track workflows for rapid game prototyping and flexible development. ## When to Use This
---
## Game Solo Dev Agent
For dedicated quick-flow development, use the **Game Solo Dev** agent (Indie). This agent is optimized for solo developers and small teams who want to skip the full planning phases and ship fast.
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select the agent from your IDE.
The Game Solo Dev agent includes:
- `quick-prototype` - Rapid mechanic testing
- `quick-dev` - Flexible feature implementation
- `quick-spec` - Create implementation-ready specs
- `code-review` - Quality checks
- `test-framework` - Automated testing setup
---
## Overview
Quick-flow workflows skip the full BMGD planning phases when you need to move fast. Use them for:
- Testing a game mechanic idea - Testing a game mechanic idea
- Implementing a small feature - Implementing a small feature
- Rapid prototyping before committing to design - Rapid prototyping before committing to design
- Bug fixes and tweaks - Bug fixes and tweaks
``` ## When to Use Full BMGD Instead
Full BMGD Flow:
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
Quick-Flow: - Building a major feature or system
Idea → Quick-Prototype → Quick-Dev → Done - The scope is unclear or large
``` - Multiple team members need alignment
- The work affects game pillars or core loop
- You need documentation for future reference
--- :::note[Prerequisites]
- BMad Method installed with BMGD module
- Game Solo Dev agent (Indie) or other BMGD agent available
:::
## Game Solo Dev Agent
For dedicated quick-flow development, use the **Game Solo Dev** agent. This agent is optimized for solo developers and small teams who want to skip the full planning phases.
**Switch to Game Solo Dev:** Type `@game-solo-dev` or select from your IDE.
Includes: `quick-prototype`, `quick-dev`, `quick-spec`, `code-review`, `test-framework`
## Quick-Prototype ## Quick-Prototype
**Command:** `quick-prototype` Use `quick-prototype` to rapidly test gameplay ideas with minimal setup.
**Agent:** Game Designer, Game Developer
**Purpose:** Rapidly test gameplay ideas with minimal setup
### When to Use ### When to Use
@ -55,60 +44,31 @@ Idea → Quick-Prototype → Quick-Dev → Done
- You want to experiment before committing to design - You want to experiment before committing to design
- You need a proof of concept - You need a proof of concept
### Workflow Steps ### Steps
1. **Define Scope** - What are you prototyping? (mechanic, feature, system) 1. Run `quick-prototype`
2. **Set Success Criteria** - How will you know if it works? 2. Define what you're prototyping (mechanic, feature, system)
3. **Rapid Implementation** - Build the minimum to test the idea 3. Set success criteria (2-3 items)
4. **Playtest and Evaluate** - Does it feel right? 4. Build the minimum to test the idea
5. Playtest and evaluate
### Prototype Principles ### Prototype Principles
- **Minimum Viable Prototype** - Only what's needed to test the idea - **Minimum Viable Prototype** — Only what's needed to test the idea
- **Hardcode First** - Magic numbers are fine, extract later - **Hardcode First** — Magic numbers are fine, extract later
- **Skip Edge Cases** - Happy path only for now - **Skip Edge Cases** — Happy path only for now
- **Placeholder Everything** - Cubes, debug text, temp sounds - **Placeholder Everything** — Cubes, debug text, temp sounds
- **Comment Intent** - Mark what's temporary vs keeper code - **Comment Intent** — Mark what's temporary vs keeper code
### Example Session
```
You: quick-prototype
Agent: What are you prototyping?
You: I want to test a grappling hook mechanic. Player should be
able to aim at surfaces and pull themselves toward the hook point.
Agent: What makes this prototype successful?
You: 1. Aiming feels responsive and intuitive
2. The pull movement feels satisfying, not floaty
3. Player can chain hooks without awkward pauses
Agent: [Implements minimal grappling hook]
Agent: Prototype complete! Playtest results:
- Aiming: Works, consider adding aim assist
- Movement: Pull is smooth, might need speed curve
- Chaining: Currently has 0.2s delay, feels sluggish
Next: [d] Develop further | [i] Iterate | [a] Archive
```
### After Prototyping ### After Prototyping
- **Develop** (`d`) - Use `quick-dev` to build production code - **Develop** (`d`) — Use `quick-dev` to build production code
- **Iterate** (`i`) - Adjust and re-test the prototype - **Iterate** (`i`) — Adjust and re-test the prototype
- **Archive** (`a`) - Keep as reference, move on to other ideas - **Archive** (`a`) — Keep as reference, move on to other ideas
---
## Quick-Dev ## Quick-Dev
**Command:** `quick-dev` Use `quick-dev` for flexible development with game-specific considerations.
**Agent:** Game Developer
**Purpose:** Flexible development with game-specific considerations
### When to Use ### When to Use
@ -120,172 +80,77 @@ Agent: Prototype complete! Playtest results:
### Workflow Modes ### Workflow Modes
**Mode A: Tech-Spec Driven** **Mode A: Tech-Spec Driven**
``` ```
You: quick-dev tech-spec-combat.md quick-dev tech-spec-combat.md
Agent: [Loads spec, extracts tasks, implements]
``` ```
**Mode B: Direct Instructions** **Mode B: Direct Instructions**
``` ```
You: quick-dev implement double-jump for the player quick-dev implement double-jump for the player
Agent: [Evaluates complexity, offers planning options]
``` ```
**Mode C: From Prototype** **Mode C: From Prototype**
``` ```
You: quick-dev from the grappling hook prototype quick-dev from the grappling hook prototype
Agent: [Loads prototype, productionizes code]
``` ```
### Game-Specific Checks ### Game-Specific Checks
Quick-dev includes automatic consideration of: Quick-dev includes automatic consideration of:
- **Performance** — No allocations in hot paths, object pooling
- **Performance** - No allocations in hot paths, object pooling - **Feel** — Input responsiveness, visual/audio feedback
- **Feel** - Input responsiveness, visual/audio feedback - **Integration** — Save/load, multiplayer sync, platform testing
- **Integration** - Save/load, multiplayer sync, platform testing
### Example Session
```
You: quick-dev implement enemy patrol behavior
Agent: This looks like a focused feature. Options:
[t] Plan first - Create tech-spec (recommended)
[r] Prototype first - Test the idea
[e] Execute directly
You: e
Agent: Any additional guidance? (patterns, files, constraints)
You: Use the existing AIController base class. Enemies should
patrol between waypoints and return if player leaves range.
Agent: [Implements patrol behavior]
Agent: Implementation Complete!
Files Modified: EnemyAI.cs, PatrolBehavior.cs
Tests: Unit tests added for patrol state machine
Performance: No per-frame allocations
Recommended: Playtest the changes
```
### Complexity Routing ### Complexity Routing
Quick-dev automatically detects complex requests and offers alternatives:
| Signals | Recommendation | | Signals | Recommendation |
| -------------------------------------- | ---------------------- | |---------|----------------|
| Single mechanic, bug fix, tweak | Execute directly | | Single mechanic, bug fix, tweak | Execute directly |
| Multiple systems, performance-critical | Plan first (tech-spec) | | Multiple systems, performance-critical | Plan first (tech-spec) |
| Platform/system level work | Use full BMGD workflow | | Platform/system level work | Use full BMGD workflow |
---
## Choosing Between Quick-Flows ## Choosing Between Quick-Flows
| Scenario | Use | | Scenario | Use |
| ----------------------- | ------------------------------- | |----------|-----|
| "Will this be fun?" | `quick-prototype` | | "Will this be fun?" | `quick-prototype` |
| "How should this feel?" | `quick-prototype` | | "How should this feel?" | `quick-prototype` |
| "Build this feature" | `quick-dev` | | "Build this feature" | `quick-dev` |
| "Fix this bug" | `quick-dev` | | "Fix this bug" | `quick-dev` |
| "Test then build" | `quick-prototype` → `quick-dev` | | "Test then build" | `quick-prototype` → `quick-dev` |
--- ## Flow Comparison
## Quick-Flow vs Full BMGD ```
Full BMGD Flow:
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
### Use Quick-Flow When Quick-Flow:
Idea → Quick-Prototype → Quick-Dev → Done
- The scope is small and well-understood ```
- You're experimenting or prototyping
- You have a clear tech-spec already
- The work doesn't affect core game systems significantly
### Use Full BMGD When
- Building a major feature or system
- The scope is unclear or large
- Multiple team members need alignment
- The work affects game pillars or core loop
- You need documentation for future reference
---
## Checklists ## Checklists
### Quick-Prototype Checklist **Quick-Prototype:**
**Before:**
- [ ] Prototype scope defined - [ ] Prototype scope defined
- [ ] Success criteria established (2-3 items) - [ ] Success criteria established (2-3 items)
**During:**
- [ ] Minimum viable code written - [ ] Minimum viable code written
- [ ] Placeholder assets used - [ ] Placeholder assets used
- [ ] Core functionality testable
**After:**
- [ ] Each criterion evaluated - [ ] Each criterion evaluated
- [ ] Decision made (develop/iterate/archive) - [ ] Decision made (develop/iterate/archive)
### Quick-Dev Checklist **Quick-Dev:**
**Before:**
- [ ] Context loaded (spec, prototype, or guidance) - [ ] Context loaded (spec, prototype, or guidance)
- [ ] Files to modify identified - [ ] Files to modify identified
- [ ] Patterns understood
**During:**
- [ ] All tasks completed - [ ] All tasks completed
- [ ] No allocations in hot paths - [ ] No allocations in hot paths
- [ ] Frame rate maintained
**After:**
- [ ] Game runs without errors - [ ] Game runs without errors
- [ ] Feature works as specified
- [ ] Manual playtest completed - [ ] Manual playtest completed
--- ## Tips
## Tips for Success - **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back
- **Embrace programmer art** — Focus on feel, not visuals
### 1. Timebox Prototypes - **Test on target hardware** — What feels right on dev machine might not on target
- **Document learnings** — Even failed prototypes teach something
Set a limit (e.g., 2 hours) for prototyping. If it's not working by then, step back and reconsider. - **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories
### 2. Embrace Programmer Art
Prototypes don't need to look good. Focus on feel, not visuals.
### 3. Test on Target Hardware
What feels right on your dev machine might not feel right on target platform.
### 4. Document Learnings
Even failed prototypes teach something. Note what you learned.
### 5. Know When to Graduate
If quick-dev keeps expanding scope, stop and create proper stories.
---
## Next Steps
- **[Workflows Guide](/docs/reference/workflows/bmgd-workflows.md)** - Full workflow reference
- **[Agents Guide](/docs/explanation/game-dev/agents.md)** - Agent capabilities
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Getting started with BMGD

77
docs/how-to/workflows/conduct-research.md
View File

@ -3,11 +3,8 @@ title: "How to Conduct Research"
description: How to conduct market, technical, and competitive research using BMad Method description: How to conduct market, technical, and competitive research using BMad Method
--- ---
Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions. Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions.
---
## When to Use This ## When to Use This
- Need market viability validation - Need market viability validation
@ -17,14 +14,10 @@ Use the `research` workflow to perform comprehensive multi-type research for val
- Understanding domain or industry - Understanding domain or industry
- Need deeper AI-assisted research - Need deeper AI-assisted research
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Analyst agent available - Analyst agent available
:::
---
## Steps ## Steps
@ -43,13 +36,13 @@ Start a fresh chat and load the Analyst agent.
Select the type of research you need: Select the type of research you need:
| Type | Purpose | Use When | | Type | Purpose | Use When |
| --------------- | ------------------------------------------------------ | ----------------------------------- | |------|---------|----------|
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation | | **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms | | **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
| **competitive** | Deep competitor analysis | Understanding competitive landscape | | **competitive** | Deep competitor analysis | Understanding competitive landscape |
| **user** | Customer insights, personas, JTBD | Need user understanding | | **user** | Customer insights, personas, JTBD | Need user understanding |
| **domain** | Industry deep dives, trends | Understanding domain/industry | | **domain** | Industry deep dives, trends | Understanding domain/industry |
| **deep_prompt** | Generate AI research prompts (ChatGPT, Claude, Gemini) | Need deeper AI-assisted research | | **deep_prompt** | Generate AI research prompts | Need deeper AI-assisted research |
### 4. Provide Context ### 4. Provide Context
@ -63,38 +56,24 @@ Give the agent details about what you're researching:
Choose your depth level: Choose your depth level:
- **Quick** - Fast overview - **Quick** — Fast overview
- **Standard** - Balanced depth - **Standard** — Balanced depth
- **Comprehensive** - Deep analysis - **Comprehensive** — Deep analysis
---
## What You Get ## What You Get
### Market Research Example Research output varies by type:
``` **Market Research:**
TAM: $50B - TAM/SAM/SOM analysis
SAM: $5B - Top competitors
SOM: $50M - Positioning recommendation
Top Competitors: **Technical Research:**
- Asana
- Monday
- etc.
Positioning Recommendation: ...
```
### Technical Research Example
Technology evaluation with:
- Comparison matrix - Comparison matrix
- Trade-off analysis - Trade-off analysis
- Recommendations with rationale - Recommendations with rationale
---
## Key Features ## Key Features
- Real-time web research - Real-time web research
@ -102,29 +81,17 @@ Technology evaluation with:
- Platform-specific optimization for deep_prompt type - Platform-specific optimization for deep_prompt type
- Configurable research depth - Configurable research depth
--- ## Tips
- **Use market research early** — Validates new product ideas
- **Technical research helps architecture** — Inform ADRs with data
- **Competitive research informs positioning** — Differentiate your product
- **Domain research for specialized industries** — Fintech, healthcare, etc.
## Next Steps ## Next Steps
After research: After research:
1. **Product Brief** - Capture strategic vision informed by research 1. **Product Brief** — Capture strategic vision informed by research
2. **PRD** - Use findings as context for requirements 2. **PRD** — Use findings as context for requirements
3. **Architecture** - Use technical research in ADRs 3. **Architecture** — Use technical research in ADRs
---
## Tips
- Use market research early for new products
- Technical research helps with architecture decisions
- Competitive research informs positioning
- Domain research is valuable for specialized industries
---
## Related
- [Run Brainstorming Session](/docs/how-to/workflows/run-brainstorming-session.md) - Explore ideas before research
- [Create Product Brief](/docs/how-to/workflows/create-product-brief.md) - Capture strategic vision
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Move to formal planning

66
docs/how-to/workflows/create-architecture.md
View File

@ -3,11 +3,8 @@ title: "How to Create Architecture"
description: How to create system architecture using the BMad Method description: How to create system architecture using the BMad Method
--- ---
Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation. Use the `architecture` workflow to make technical decisions explicit and prevent agent conflicts during implementation.
---
## When to Use This ## When to Use This
- Multi-epic projects (BMad Method, Enterprise) - Multi-epic projects (BMad Method, Enterprise)
@ -16,23 +13,17 @@ Use the `architecture` workflow to make technical decisions explicit and prevent
- Integration complexity exists - Integration complexity exists
- Technology choices need alignment - Technology choices need alignment
---
## When to Skip This ## When to Skip This
- Quick Flow (simple changes) - Quick Flow (simple changes)
- BMad Method Simple with straightforward tech stack - BMad Method Simple with straightforward tech stack
- Single epic with clear technical approach - Single epic with clear technical approach
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Architect agent available - Architect agent available
- PRD completed - PRD completed
:::
---
## Steps ## Steps
@ -63,25 +54,21 @@ Work with the agent to create Architecture Decision Records (ADRs) for significa
The agent produces a decision-focused architecture document. The agent produces a decision-focused architecture document.
---
## What You Get ## What You Get
An `architecture.md` document containing: An `architecture.md` document containing:
1. **Architecture Overview** - System context, principles, style 1. **Architecture Overview** — System context, principles, style
2. **System Architecture** - High-level diagram, component interactions 2. **System Architecture** — High-level diagram, component interactions
3. **Data Architecture** - Database design, state management, caching 3. **Data Architecture** — Database design, state management, caching
4. **API Architecture** - API style (REST/GraphQL/gRPC), auth, versioning 4. **API Architecture** — API style (REST/GraphQL/gRPC), auth, versioning
5. **Frontend Architecture** - Framework, state management, components 5. **Frontend Architecture** — Framework, state management, components
6. **Integration Architecture** - Third-party integrations, messaging 6. **Integration Architecture** — Third-party integrations, messaging
7. **Security Architecture** - Auth/authorization, data protection 7. **Security Architecture** — Auth/authorization, data protection
8. **Deployment Architecture** - CI/CD, environments, monitoring 8. **Deployment Architecture** — CI/CD, environments, monitoring
9. **ADRs** - Key decisions with context, options, rationale 9. **ADRs** — Key decisions with context, options, rationale
10. **FR/NFR-Specific Guidance** - Technical approach per requirement 10. **FR/NFR-Specific Guidance** — Technical approach per requirement
11. **Standards and Conventions** - Directory structure, naming, testing 11. **Standards and Conventions** — Directory structure, naming, testing
---
## ADR Format ## ADR Format
@ -110,8 +97,6 @@ An `architecture.md` document containing:
- Mitigation: Use DataLoader for batching - Mitigation: Use DataLoader for batching
``` ```
---
## Example ## Example
E-commerce platform produces: E-commerce platform produces:
@ -119,29 +104,16 @@ E-commerce platform produces:
- ADRs explaining each choice - ADRs explaining each choice
- FR/NFR-specific implementation guidance - FR/NFR-specific implementation guidance
---
## Tips ## Tips
- Focus on decisions that prevent agent conflicts - **Focus on decisions that prevent conflicts** — Multiple agents need alignment
- Use ADRs for every significant technology choice - **Use ADRs for every significant choice** — Document the "why"
- Keep it practical - don't over-architect - **Keep it practical** — Don't over-architect
- Architecture is living - update as you learn - **Architecture is living** — Update as you learn
---
## Next Steps ## Next Steps
After architecture: After architecture:
1. **Create Epics and Stories** - Work breakdown informed by architecture 1. **Create Epics and Stories** — Work breakdown informed by architecture
2. **Implementation Readiness** - Gate check before Phase 4 2. **Implementation Readiness** — Gate check before Phase 4
---
## Related
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Requirements before architecture
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Next step
- [Run Implementation Readiness](/docs/how-to/workflows/run-implementation-readiness.md) - Gate check
- [Why Solutioning Matters](/docs/explanation/architecture/why-solutioning-matters.md)

59
docs/how-to/workflows/create-epics-and-stories.md
View File

@ -3,38 +3,29 @@ title: "How to Create Epics and Stories"
description: How to break PRD requirements into epics and stories using BMad Method description: How to break PRD requirements into epics and stories using BMad Method
--- ---
Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics. Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
---
## When to Use This ## When to Use This
- After architecture workflow completes - After architecture workflow completes
- When PRD contains FRs/NFRs ready for implementation breakdown - When PRD contains FRs/NFRs ready for implementation breakdown
- Before implementation-readiness gate check - Before implementation-readiness gate check
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- PM agent available - PM agent available
- PRD completed - PRD completed
- Architecture completed - Architecture completed
:::
---
## Why After Architecture? ## Why After Architecture?
This workflow runs AFTER architecture because: This workflow runs AFTER architecture because:
1. **Informed Story Sizing** - Architecture decisions affect story complexity 1. **Informed Story Sizing** — Architecture decisions affect story complexity
2. **Dependency Awareness** - Architecture reveals technical dependencies 2. **Dependency Awareness** — Architecture reveals technical dependencies
3. **Technical Feasibility** - Stories can be properly scoped knowing the tech stack 3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack
4. **Consistency** - All stories align with documented architectural patterns 4. **Consistency** — All stories align with documented architectural patterns
---
## Steps ## Steps
@ -67,8 +58,6 @@ Ensure each story has:
- Identified dependencies - Identified dependencies
- Technical notes from architecture - Technical notes from architecture
---
## What You Get ## What You Get
Epic files (one per epic) containing: Epic files (one per epic) containing:
@ -79,8 +68,6 @@ Epic files (one per epic) containing:
4. **Dependencies between stories** 4. **Dependencies between stories**
5. **Technical notes** referencing architecture decisions 5. **Technical notes** referencing architecture decisions
---
## Example ## Example
E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces: E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produces:
@ -98,39 +85,25 @@ E-commerce PRD with FR-001 (User Registration), FR-002 (Product Catalog) produce
Each story references relevant ADRs from architecture. Each story references relevant ADRs from architecture.
---
## Story Priority Levels ## Story Priority Levels
| Priority | Meaning | | Priority | Meaning |
|----------|---------| |----------|---------|
| **P0** | Critical - Must have for MVP | | **P0** | Critical — Must have for MVP |
| **P1** | High - Important for release | | **P1** | High — Important for release |
| **P2** | Medium - Nice to have | | **P2** | Medium — Nice to have |
| **P3** | Low - Future consideration | | **P3** | Low — Future consideration |
---
## Tips ## Tips
- Keep stories small enough to complete in a session - **Keep stories small** — Complete in a single session
- Ensure acceptance criteria are testable - **Make criteria testable** — Acceptance criteria should be verifiable
- Document dependencies clearly - **Document dependencies clearly** — Know what blocks what
- Reference architecture decisions in technical notes - **Reference architecture** — Include ADR references in technical notes
---
## Next Steps ## Next Steps
After creating epics and stories: After creating epics and stories:
1. **Implementation Readiness** - Validate alignment before Phase 4 1. **Implementation Readiness** — Validate alignment before Phase 4
2. **Sprint Planning** - Organize work for implementation 2. **Sprint Planning** — Organize work for implementation
---
## Related
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Do this first
- [Run Implementation Readiness](/docs/how-to/workflows/run-implementation-readiness.md) - Gate check
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Start implementation

61
docs/how-to/workflows/create-prd.md
View File

@ -3,11 +3,8 @@ title: "How to Create a PRD"
description: How to create a Product Requirements Document using the BMad Method description: How to create a Product Requirements Document using the BMad Method
--- ---
Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs). Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).
---
## When to Use This ## When to Use This
- Medium to large feature sets - Medium to large feature sets
@ -16,15 +13,11 @@ Use the `prd` workflow to create a strategic Product Requirements Document with
- Multiple system integrations - Multiple system integrations
- Phased delivery required - Phased delivery required
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- PM agent available - PM agent available
- Optional: Product brief from Phase 1 - Optional: Product brief from Phase 1
:::
---
## Steps ## Steps
@ -48,15 +41,13 @@ The workflow will:
### 4. Define Requirements ### 4. Define Requirements
Work with the agent to define: Work with the agent to define:
- Functional Requirements (FRs) - What the system should do - Functional Requirements (FRs) — What the system should do
- Non-Functional Requirements (NFRs) - How well it should do it - Non-Functional Requirements (NFRs) — How well it should do it
### 5. Review the PRD ### 5. Review the PRD
The agent produces a comprehensive PRD scaled to your project. The agent produces a comprehensive PRD scaled to your project.
---
## What You Get ## What You Get
A `PRD.md` document containing: A `PRD.md` document containing:
@ -69,8 +60,6 @@ A `PRD.md` document containing:
- Success metrics - Success metrics
- Risks and assumptions - Risks and assumptions
---
## Scale-Adaptive Structure ## Scale-Adaptive Structure
The PRD adapts to your project complexity: The PRD adapts to your project complexity:
@ -81,50 +70,22 @@ The PRD adapts to your project complexity:
| **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis | | **Standard** | 20-30 | Comprehensive FRs/NFRs, thorough analysis |
| **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder analysis | | **Comprehensive** | 30-50+ | Extensive FRs/NFRs, multi-phase, stakeholder analysis |
---
## V6 Improvement
In V6, the PRD focuses on **WHAT** to build (requirements). Epic and Stories are created **AFTER** architecture via the `create-epics-and-stories` workflow for better quality.
---
## Example ## Example
E-commerce checkout → PRD with: E-commerce checkout → PRD with:
- 15 FRs (user account, cart management, payment flow) - 15 FRs (user account, cart management, payment flow)
- 8 NFRs (performance, security, scalability) - 8 NFRs (performance, security, scalability)
--- ## Tips
## Best Practices - **Do Product Brief first** — Run product-brief from Phase 1 for better results
- **Focus on "What" not "How"** — Planning defines what to build and why. Leave how (technical design) to Phase 3
### 1. Do Product Brief First - **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context
Run product-brief from Phase 1 to kickstart the PRD for better results.
### 2. Focus on "What" Not "How"
Planning defines **what** to build and **why**. Leave **how** (technical design) to Phase 3 (Solutioning).
### 3. Document-Project First for Brownfield
Always run `document-project` before planning brownfield projects. AI agents need existing codebase context.
---
## Next Steps ## Next Steps
After PRD: After PRD:
1. **Create UX Design** (optional) - If UX is critical 1. **Create UX Design** (optional) — If UX is critical
2. **Create Architecture** - Technical design 2. **Create Architecture** — Technical design
3. **Create Epics and Stories** - After architecture 3. **Create Epics and Stories** — After architecture
---
## Related
- [Create Product Brief](/docs/how-to/workflows/create-product-brief.md) - Input for PRD
- [Create UX Design](/docs/how-to/workflows/create-ux-design.md) - Optional UX workflow
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Next step after PRD

57
docs/how-to/workflows/create-product-brief.md
View File

@ -3,11 +3,8 @@ title: "How to Create a Product Brief"
description: How to create a product brief using the BMad Method description: How to create a product brief using the BMad Method
--- ---
Use the `product-brief` workflow to define product vision and strategy through an interactive process. Use the `product-brief` workflow to define product vision and strategy through an interactive process.
---
## When to Use This ## When to Use This
- Starting new product or major feature initiative - Starting new product or major feature initiative
@ -15,15 +12,11 @@ Use the `product-brief` workflow to define product vision and strategy through a
- Transitioning from exploration to strategy - Transitioning from exploration to strategy
- Need executive-level product documentation - Need executive-level product documentation
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Analyst agent available - Analyst agent available
- Optional: Research documents from previous workflows - Optional: Research documents from previous workflows
:::
---
## Steps ## Steps
@ -50,22 +43,18 @@ The workflow guides you through strategic product vision definition:
The agent will draft sections and let you refine them interactively. The agent will draft sections and let you refine them interactively.
---
## What You Get ## What You Get
The `product-brief.md` document includes: The `product-brief.md` document includes:
- **Executive summary** - High-level overview - **Executive summary** — High-level overview
- **Problem statement** - With evidence - **Problem statement** — With evidence
- **Proposed solution** - And differentiators - **Proposed solution** — And differentiators
- **Target users** - Segmented - **Target users** — Segmented
- **MVP scope** - Ruthlessly defined - **MVP scope** — Ruthlessly defined
- **Financial impact** - And ROI - **Financial impact** — And ROI
- **Strategic alignment** - With business goals - **Strategic alignment** — With business goals
- **Risks and open questions** - Documented upfront - **Risks and open questions** — Documented upfront
---
## Integration with Other Workflows ## Integration with Other Workflows
@ -79,11 +68,9 @@ The product brief feeds directly into the PRD workflow:
Planning workflows automatically load the product brief if it exists. Planning workflows automatically load the product brief if it exists.
---
## Common Patterns ## Common Patterns
### Greenfield Software (Full Analysis) **Greenfield Software (Full Analysis):**
``` ```
1. brainstorm-project - explore approaches 1. brainstorm-project - explore approaches
@ -92,26 +79,16 @@ Planning workflows automatically load the product brief if it exists.
4. → Phase 2: prd 4. → Phase 2: prd
``` ```
### Skip Analysis (Clear Requirements) **Skip Analysis (Clear Requirements):**
``` ```
→ Phase 2: prd or tech-spec directly → Phase 2: prd or tech-spec directly
``` ```
---
## Tips ## Tips
- Be specific about the problem you're solving - **Be specific about the problem** — Vague problems lead to vague solutions
- Ruthlessly prioritize MVP scope - **Ruthlessly prioritize MVP scope** — Less is more
- Document assumptions and risks - **Document assumptions and risks** — Surface unknowns early
- Use research findings as evidence - **Use research findings as evidence** — Back up claims with data
- This is recommended for greenfield projects - **Recommended for greenfield projects** — Sets strategic foundation
---
## Related
- [Run Brainstorming Session](/docs/how-to/workflows/run-brainstorming-session.md) - Explore ideas first
- [Conduct Research](/docs/how-to/workflows/conduct-research.md) - Validate ideas
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Next step after product brief

47
docs/how-to/workflows/create-story.md
View File

@ -3,27 +3,20 @@ title: "How to Create a Story"
description: How to create implementation-ready stories from epic backlog description: How to create implementation-ready stories from epic backlog
--- ---
Use the `create-story` workflow to prepare the next story from the epic backlog for implementation. Use the `create-story` workflow to prepare the next story from the epic backlog for implementation.
---
## When to Use This ## When to Use This
- Before implementing each story - Before implementing each story
- When moving to the next story in an epic - When moving to the next story in an epic
- After sprint-planning has been run - After sprint-planning has been run
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- SM (Scrum Master) agent available - SM (Scrum Master) agent available
- Sprint-status.yaml created by sprint-planning - Sprint-status.yaml created by sprint-planning
- Architecture and PRD available for context - Architecture and PRD available for context
:::
---
## Steps ## Steps
@ -48,8 +41,6 @@ The agent will:
The agent creates a comprehensive story file ready for development. The agent creates a comprehensive story file ready for development.
---
## What You Get ## What You Get
A `story-[slug].md` file containing: A `story-[slug].md` file containing:
@ -61,23 +52,18 @@ A `story-[slug].md` file containing:
- Dependencies on other stories - Dependencies on other stories
- Definition of Done - Definition of Done
---
## Story Content Sources ## Story Content Sources
The create-story workflow pulls from: The create-story workflow pulls from:
- **PRD** - Requirements and acceptance criteria - **PRD** — Requirements and acceptance criteria
- **Architecture** - Technical approach and ADRs - **Architecture** — Technical approach and ADRs
- **Epic file** - Story context and dependencies - **Epic file** — Story context and dependencies
- **Existing code** - Patterns to follow (brownfield) - **Existing code** — Patterns to follow (brownfield)
---
## Example Output ## Example Output
```markdown ```markdown
## Objective ## Objective
Implement email verification flow for new user registrations. Implement email verification flow for new user registrations.
@ -93,7 +79,7 @@ Implement email verification flow for new user registrations.
- Follow existing email template patterns in /templates - Follow existing email template patterns in /templates
## Dependencies ## Dependencies
- Story 1.1 (User Registration) - DONE ✅ - Story 1.1 (User Registration) - DONE
## Definition of Done ## Definition of Done
- All acceptance criteria pass - All acceptance criteria pass
@ -101,19 +87,16 @@ Implement email verification flow for new user registrations.
- Code review approved - Code review approved
``` ```
---
## Tips ## Tips
- Complete one story before creating the next - **Complete one story before creating the next** — Focus on finishing
- Ensure dependencies are marked DONE before starting - **Ensure dependencies are DONE** — Don't start blocked stories
- Review technical notes for architecture alignment - **Review technical notes** — Align with architecture
- Use the story file as context for dev-story - **Use the story file as context** — Pass to dev-story workflow
--- ## Next Steps
## Related After creating a story:
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Initialize tracking 1. **Implement Story** — Run dev-story with the DEV agent
- [Implement Story](/docs/how-to/workflows/implement-story.md) - Next step 2. **Code Review** — Run code-review after implementation
- [Run Code Review](/docs/how-to/workflows/run-code-review.md) - After implementation

47
docs/how-to/workflows/create-ux-design.md
View File

@ -3,11 +3,8 @@ title: "How to Create a UX Design"
description: How to create UX specifications using the BMad Method description: How to create UX specifications using the BMad Method
--- ---
Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator. Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator.
---
## When to Use This ## When to Use This
- UX is primary competitive advantage - UX is primary competitive advantage
@ -16,8 +13,6 @@ Use the `create-ux-design` workflow to create UX specifications for projects whe
- Design system creation - Design system creation
- Accessibility-critical experiences - Accessibility-critical experiences
---
## When to Skip This ## When to Skip This
- Simple CRUD interfaces - Simple CRUD interfaces
@ -25,15 +20,11 @@ Use the `create-ux-design` workflow to create UX specifications for projects whe
- Changes to existing screens you're happy with - Changes to existing screens you're happy with
- Quick Flow projects - Quick Flow projects
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- UX Designer agent available - UX Designer agent available
- PRD completed - PRD completed
:::
---
## Steps ## Steps
@ -58,17 +49,15 @@ Point the agent to your PRD and describe:
The workflow uses a collaborative approach: The workflow uses a collaborative approach:
1. **Visual exploration** - Generate multiple options 1. **Visual exploration** — Generate multiple options
2. **Informed decisions** - Evaluate with user needs 2. **Informed decisions** — Evaluate with user needs
3. **Collaborative design** - Refine iteratively 3. **Collaborative design** — Refine iteratively
4. **Living documentation** - Evolves with project 4. **Living documentation** — Evolves with project
### 5. Review the UX Spec ### 5. Review the UX Spec
The agent produces comprehensive UX documentation. The agent produces comprehensive UX documentation.
---
## What You Get ## What You Get
The `ux-spec.md` document includes: The `ux-spec.md` document includes:
@ -79,8 +68,6 @@ The `ux-spec.md` document includes:
- Design system (components, patterns, tokens) - Design system (components, patterns, tokens)
- Epic breakdown (UX stories) - Epic breakdown (UX stories)
---
## Example ## Example
Dashboard redesign produces: Dashboard redesign produces:
@ -90,8 +77,6 @@ Dashboard redesign produces:
- Responsive grid - Responsive grid
- 3 epics (Layout, Visualization, Accessibility) - 3 epics (Layout, Visualization, Accessibility)
---
## Integration ## Integration
The UX spec feeds into: The UX spec feeds into:
@ -99,19 +84,17 @@ The UX spec feeds into:
- Epic and story creation - Epic and story creation
- Architecture decisions (Phase 3) - Architecture decisions (Phase 3)
---
## Tips ## Tips
- Focus on user problems, not solutions first - **Focus on user problems first** — Solutions come second
- Generate multiple options before deciding - **Generate multiple options** — Don't settle on the first idea
- Consider accessibility from the start - **Consider accessibility from the start** — Not an afterthought
- Document component reusability - **Document component reusability** — Build a system, not just screens
--- ## Next Steps
## Related After UX design:
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Create requirements first 1. **Update PRD** — Incorporate UX findings
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Technical design 2. **Create Architecture** — Technical design informed by UX
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Work breakdown 3. **Create Epics and Stories** — Include UX-specific stories

86
docs/how-to/workflows/implement-story.md
View File

@ -3,27 +3,20 @@ title: "How to Implement a Story"
description: How to implement a story using the dev-story workflow description: How to implement a story using the dev-story workflow
--- ---
Use the `dev-story` workflow to implement a story with tests following the architecture and conventions. Use the `dev-story` workflow to implement a story with tests following the architecture and conventions.
---
## When to Use This ## When to Use This
- After create-story has prepared the story file - After create-story has prepared the story file
- When ready to write code for a story - When ready to write code for a story
- Story dependencies are marked DONE - Story dependencies are marked DONE
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- DEV agent available - DEV agent available
- Story file created by create-story - Story file created by create-story
- Architecture and tech-spec available for context - Architecture and tech-spec available for context
:::
---
## Steps ## Steps
@ -53,75 +46,52 @@ The DEV agent:
Work with the agent until all acceptance criteria are met. Work with the agent until all acceptance criteria are met.
---
## What Happens ## What Happens
The dev-story workflow: The dev-story workflow:
1. **Reads context** - Story file, architecture, existing patterns 1. **Reads context** — Story file, architecture, existing patterns
2. **Plans implementation** - Identifies files to create/modify 2. **Plans implementation** — Identifies files to create/modify
3. **Writes code** - Following conventions and patterns 3. **Writes code** — Following conventions and patterns
4. **Writes tests** - Unit, integration, or E2E as appropriate 4. **Writes tests** — Unit, integration, or E2E as appropriate
5. **Validates** - Runs tests and checks acceptance criteria 5. **Validates** — Runs tests and checks acceptance criteria
---
## Key Principles ## Key Principles
### One Story at a Time **One Story at a Time** — Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality.
Complete each story's full lifecycle before starting the next. This prevents context switching and ensures quality. **Follow Architecture** — The DEV agent references ADRs for technology decisions, standards for naming and structure, and existing patterns in the codebase.
### Follow Architecture **Write Tests** — Every story includes appropriate tests: unit tests for business logic, integration tests for API endpoints, E2E tests for critical flows.
The DEV agent references:
- ADRs for technology decisions
- Standards for naming and structure
- Existing patterns in the codebase
### Write Tests
Every story includes appropriate tests:
- Unit tests for business logic
- Integration tests for API endpoints
- E2E tests for critical flows
---
## After Implementation ## After Implementation
1. **Update sprint-status.yaml** - Mark story as READY FOR REVIEW 1. **Update sprint-status.yaml** — Mark story as READY FOR REVIEW
2. **Run code-review** - Quality assurance 2. **Run code-review** — Quality assurance
3. **Address feedback** - If code review finds issues 3. **Address feedback** — If code review finds issues
4. **Mark DONE** - After code review passes 4. **Mark DONE** — After code review passes
---
## Tips ## Tips
- Keep the story file open for reference - **Keep the story file open** — Reference it during implementation
- Ask the agent to explain decisions - **Ask the agent to explain decisions** — Understand the approach
- Run tests frequently during implementation - **Run tests frequently** — Catch issues early
- Don't skip tests for "simple" changes - **Don't skip tests** — Even for "simple" changes
---
## Troubleshooting ## Troubleshooting
**Q: Story needs significant changes mid-implementation?** **Story needs significant changes mid-implementation?**
A: Run `correct-course` to analyze impact and route appropriately. Run `correct-course` to analyze impact and route appropriately.
**Q: Can I work on multiple stories in parallel?** **Can I work on multiple stories in parallel?**
A: Not recommended. Complete one story's full lifecycle first. Not recommended. Complete one story's full lifecycle first.
**Q: What if implementation reveals the story is too large?** **What if implementation reveals the story is too large?**
A: Split the story and document the change. Split the story and document the change.
--- ## Next Steps
## Related After implementing a story:
- [Create Story](/docs/how-to/workflows/create-story.md) - Prepare the story first 1. **Code Review** — Run code-review with the DEV agent
- [Run Code Review](/docs/how-to/workflows/run-code-review.md) - After implementation 2. **Create Next Story** — Run create-story with the SM agent
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Sprint organization

69
docs/how-to/workflows/quick-spec.md
View File

@ -3,10 +3,7 @@ title: "How to Use Quick Spec"
description: How to create a technical specification using Quick Spec workflow description: How to create a technical specification using Quick Spec workflow
--- ---
Use the `quick-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
---
## When to Use This ## When to Use This
@ -16,15 +13,11 @@ Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to
- Adding to existing brownfield codebase - Adding to existing brownfield codebase
- Quick Flow track projects - Quick Flow track projects
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- PM agent or Quick Flow Solo Dev agent available - PM agent or Quick Flow Solo Dev agent available
- Project directory (can be empty for greenfield) - Project directory (can be empty for greenfield)
:::
---
## Steps ## Steps
@ -63,12 +56,9 @@ For brownfield projects, the agent will:
The agent generates a comprehensive tech-spec with ready-to-implement stories. The agent generates a comprehensive tech-spec with ready-to-implement stories.
---
## What You Get ## What You Get
### tech-spec.md **tech-spec.md:**
- Problem statement and solution - Problem statement and solution
- Detected framework versions and dependencies - Detected framework versions and dependencies
- Brownfield code patterns (if applicable) - Brownfield code patterns (if applicable)
@ -76,18 +66,11 @@ The agent generates a comprehensive tech-spec with ready-to-implement stories.
- Specific file paths to modify - Specific file paths to modify
- Complete implementation guidance - Complete implementation guidance
### Story Files **Story Files:**
- Single changes: `story-[slug].md`
- Small features: `epics.md` + `story-[epic-slug]-1.md`, etc.
For single changes: ## Example: Bug Fix
- `story-[slug].md` - Single user story ready for development
For small features:
- `epics.md` - Epic organization
- `story-[epic-slug]-1.md`, `story-[epic-slug]-2.md`, etc.
---
## Example: Bug Fix (Single Change)
**You:** "I want to fix the login validation bug that allows empty passwords" **You:** "I want to fix the login validation bug that allows empty passwords"
@ -99,11 +82,7 @@ For small features:
5. Generates tech-spec.md with specific file paths 5. Generates tech-spec.md with specific file paths
6. Creates story-login-fix.md 6. Creates story-login-fix.md
**Total time:** 15-30 minutes (mostly implementation) ## Example: Small Feature
---
## Example: Small Feature (Multi-Story)
**You:** "I want to add OAuth social login (Google, GitHub)" **You:** "I want to add OAuth social login (Google, GitHub)"
@ -118,10 +97,6 @@ For small features:
- story-oauth-1.md (Backend OAuth setup) - story-oauth-1.md (Backend OAuth setup)
- story-oauth-2.md (Frontend login buttons) - story-oauth-2.md (Frontend login buttons)
**Total time:** 1-3 hours (mostly implementation)
---
## Implementing After Tech Spec ## Implementing After Tech Spec
```bash ```bash
@ -133,27 +108,15 @@ For small features:
# Then: Load DEV agent and run dev-story for each story # Then: Load DEV agent and run dev-story for each story
``` ```
---
## Tips ## Tips
### Be Specific in Discovery - **Be specific in discovery** — "Fix email validation in UserService to allow plus-addressing" beats "Fix validation bug"
- **Trust convention detection** — If it detects your patterns correctly, say yes! It's faster than establishing new conventions
- **Keep single changes atomic** — If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you
- ✅ "Fix email validation in UserService to allow plus-addressing" ## Next Steps
- ❌ "Fix validation bug"
### Trust Convention Detection After tech spec:
If it detects your patterns correctly, say yes! It's faster than establishing new conventions. 1. **Implement Story** — Run dev-story with the DEV agent
2. **Sprint Planning** — Optional for multi-story features
### Keep Single Changes Atomic
If your "single change" needs 3+ files, it might be a multi-story feature. Let the workflow guide you.
---
## Related
- [Quick Flow](/docs/explanation/features/quick-flow.md) - Understanding Quick Spec Flow
- [Implement Story](/docs/how-to/workflows/implement-story.md) - After tech spec
- [Create PRD](/docs/how-to/workflows/create-prd.md) - For larger projects needing full BMad Method

51
docs/how-to/workflows/run-brainstorming-session.md
View File

@ -3,11 +3,8 @@ title: "How to Run a Brainstorming Session"
description: How to run a brainstorming session using the BMad Method description: How to run a brainstorming session using the BMad Method
--- ---
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks. Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
---
## When to Use This ## When to Use This
- Very vague or seed kernel of an idea that needs exploration - Very vague or seed kernel of an idea that needs exploration
@ -15,14 +12,10 @@ Use the `brainstorm-project` workflow to explore solution approaches through par
- See your idea from different angles and viewpoints - See your idea from different angles and viewpoints
- No idea what you want to build, but want to find some inspiration - No idea what you want to build, but want to find some inspiration
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Analyst agent available - Analyst agent available
:::
---
## Steps ## Steps
@ -48,17 +41,15 @@ Tell the agent about your project idea, even if it's vague:
The workflow generates solution approaches through parallel ideation tracks: The workflow generates solution approaches through parallel ideation tracks:
- **Architecture track** - Technical approaches and patterns - **Architecture track** — Technical approaches and patterns
- **UX track** - User experience possibilities - **UX track** — User experience possibilities
- **Integration track** - How it connects with other systems - **Integration track** — How it connects with other systems
- **Value track** - Business value and differentiation - **Value track** — Business value and differentiation
### 5. Evaluate Options ### 5. Evaluate Options
Review the generated options with rationale for each approach. Review the generated options with rationale for each approach.
---
## What You Get ## What You Get
- Multiple solution approaches with trade-offs - Multiple solution approaches with trade-offs
@ -66,29 +57,17 @@ Review the generated options with rationale for each approach.
- UX and integration considerations - UX and integration considerations
- Clear rationale for each direction - Clear rationale for each direction
--- ## Tips
- **Don't worry about having a fully formed idea** — Vague is fine
- **Let the agent guide exploration** — Follow the prompts
- **Consider multiple tracks** — Don't settle on the first option
- **Use outputs as input for product-brief** — Build on brainstorming results
## Next Steps ## Next Steps
After brainstorming: After brainstorming:
1. **Research** - Validate ideas with market/technical research 1. **Research** — Validate ideas with market/technical research
2. **Product Brief** - Capture strategic vision 2. **Product Brief** — Capture strategic vision
3. **PRD** - Move to formal planning 3. **PRD** — Move to formal planning
---
## Tips
- Don't worry about having a fully formed idea
- Let the agent guide the exploration
- Consider multiple tracks before deciding
- Use outputs as input for product-brief workflow
---
## Related
- [Conduct Research](/docs/how-to/workflows/conduct-research.md) - Validate your ideas
- [Create Product Brief](/docs/how-to/workflows/create-product-brief.md) - Capture strategic vision
- [Create PRD](/docs/how-to/workflows/create-prd.md) - Move to formal planning

94
docs/how-to/workflows/run-code-review.md
View File

@ -3,27 +3,20 @@ title: "How to Run Code Review"
description: How to run code review for quality assurance description: How to run code review for quality assurance
--- ---
Use the `code-review` workflow to perform a thorough quality review of implemented code. Use the `code-review` workflow to perform a thorough quality review of implemented code.
---
## When to Use This ## When to Use This
- After dev-story completes implementation - After dev-story completes implementation
- Before marking a story as DONE - Before marking a story as DONE
- Every story goes through code review - no exceptions - Every story goes through code review — no exceptions
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed - BMad Method installed
- DEV agent available - DEV agent available
- Story implementation complete - Story implementation complete
- Tests written and passing - Tests written and passing
:::
---
## Steps ## Steps
@ -55,56 +48,21 @@ If issues are found:
2. Re-run tests 2. Re-run tests
3. Run code-review again 3. Run code-review again
---
## What Gets Reviewed ## What Gets Reviewed
The code review checks: | Category | Checks |
|----------|--------|
### Code Quality | **Code Quality** | Clean code, appropriate abstractions, no code smells, proper error handling |
- Clean, readable code | **Architecture Alignment** | Follows ADRs, consistent with patterns, proper separation of concerns |
- Appropriate abstractions | **Testing** | Adequate coverage, meaningful tests, edge cases, follows project patterns |
- No code smells | **Security** | No hardcoded secrets, input validation, proper auth, no common vulnerabilities |
- Proper error handling | **Performance** | No obvious issues, appropriate data structures, efficient queries |
### Architecture Alignment
- Follows ADRs and architecture decisions
- Consistent with existing patterns
- Proper separation of concerns
### Testing
- Adequate test coverage
- Tests are meaningful (not just for coverage)
- Edge cases handled
- Tests follow project patterns
### Security
- No hardcoded secrets
- Input validation
- Authentication/authorization proper
- No common vulnerabilities
### Performance
- No obvious performance issues
- Appropriate data structures
- Efficient queries
---
## Review Outcomes ## Review Outcomes
### ✅ Approved **Approved** — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml.
- Code meets quality standards **Changes Requested** — Issues identified that need fixing. Fix issues in dev-story, then re-run code-review.
- Tests pass
- **Action:** Mark story as DONE in sprint-status.yaml
### 🔧 Changes Requested
- Issues identified that need fixing
- **Action:** Fix issues in dev-story, then re-run code-review
---
## Quality Gates ## Quality Gates
@ -115,27 +73,17 @@ Every story goes through code-review before being marked done. This ensures:
- Test coverage - Test coverage
- Security review - Security review
---
## Tips ## Tips
- Don't skip code review for "simple" changes - **Don't skip for "simple" changes** — Simple changes can have subtle bugs
- Address all findings, not just critical ones - **Address all findings** — Not just critical ones
- Use findings as learning opportunities - **Use findings as learning opportunities** — Improve over time
- Re-run review after fixes - **Re-run review after fixes** — Verify issues are resolved
--- ## Next Steps
## After Code Review After code review:
1. **If approved:** Update sprint-status.yaml to mark story DONE 1. **If approved** — Update sprint-status.yaml to mark story DONE
2. **If changes requested:** Fix issues and re-run review 2. **If changes requested** — Fix issues and re-run review
3. **Move to next story:** Run create-story for the next item 3. **Move to next story** — Run create-story for the next item
---
## Related
- [Implement Story](/docs/how-to/workflows/implement-story.md) - Before code review
- [Create Story](/docs/how-to/workflows/create-story.md) - Move to next story
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Sprint organization

83
docs/how-to/workflows/run-implementation-readiness.md
View File

@ -3,11 +3,8 @@ title: "How to Run Implementation Readiness"
description: How to validate planning and solutioning before implementation description: How to validate planning and solutioning before implementation
--- ---
Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation. Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation.
---
## When to Use This ## When to Use This
- **Always** before Phase 4 for BMad Method and Enterprise projects - **Always** before Phase 4 for BMad Method and Enterprise projects
@ -15,22 +12,16 @@ Use the `implementation-readiness` workflow to validate that planning and soluti
- Before sprint-planning workflow - Before sprint-planning workflow
- When stakeholders request readiness check - When stakeholders request readiness check
---
## When to Skip This ## When to Skip This
- Quick Flow (no solutioning phase) - Quick Flow (no solutioning phase)
- BMad Method Simple (no gate check required) - BMad Method Simple (no gate check required)
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Architect agent available - Architect agent available
- PRD, Architecture, and Epics completed - PRD, Architecture, and Epics completed
:::
---
## Steps ## Steps
@ -56,66 +47,42 @@ The workflow systematically checks:
The agent produces a gate decision with rationale. The agent produces a gate decision with rationale.
---
## Gate Decision Outcomes ## Gate Decision Outcomes
### ✅ PASS | Decision | Meaning | Action |
|----------|---------|--------|
- All critical criteria met | **PASS** | All critical criteria met, minor gaps acceptable | Proceed to Phase 4 |
- Minor gaps acceptable with documented plan | **CONCERNS** | Some criteria not met but not blockers | Proceed with caution, address gaps in parallel |
- **Action:** Proceed to Phase 4 | **FAIL** | Critical gaps or contradictions | BLOCK Phase 4, resolve issues first |
### ⚠️ CONCERNS
- Some criteria not met but not blockers
- Gaps identified with clear resolution path
- **Action:** Proceed with caution, address gaps in parallel
### ❌ FAIL
- Critical gaps or contradictions
- Architecture missing key decisions
- Epics conflict with PRD/architecture
- **Action:** BLOCK Phase 4, resolve issues first
---
## What Gets Checked ## What Gets Checked
### PRD/GDD Completeness **PRD/GDD Completeness:**
- Problem statement clear and evidence-based - Problem statement clear and evidence-based
- Success metrics defined - Success metrics defined
- User personas identified - User personas identified
- Functional requirements (FRs) complete - FRs and NFRs complete
- Non-functional requirements (NFRs) specified
- Risks and assumptions documented - Risks and assumptions documented
### Architecture Completeness **Architecture Completeness:**
- System architecture defined - System, data, API architecture defined
- Data architecture specified
- API architecture decided
- Key ADRs documented - Key ADRs documented
- Security architecture addressed - Security architecture addressed
- FR/NFR-specific guidance provided - FR/NFR-specific guidance provided
- Standards and conventions defined - Standards and conventions defined
### Epic/Story Completeness **Epic/Story Completeness:**
- All PRD features mapped to stories - All PRD features mapped to stories
- Stories have acceptance criteria - Stories have acceptance criteria
- Stories prioritized (P0/P1/P2/P3) - Stories prioritized (P0/P1/P2/P3)
- Dependencies identified - Dependencies identified
- Story sequencing logical
### Alignment Checks **Alignment Checks:**
- Architecture addresses all PRD FRs/NFRs - Architecture addresses all PRD FRs/NFRs
- Epics align with architecture decisions - Epics align with architecture decisions
- No contradictions between epics - No contradictions between epics
- NFRs have technical approach
- Integration points clear - Integration points clear
---
## What You Get ## What You Get
An `implementation-readiness.md` document containing: An `implementation-readiness.md` document containing:
@ -128,11 +95,9 @@ An `implementation-readiness.md` document containing:
6. **Gate Decision** with rationale 6. **Gate Decision** with rationale
7. **Next Steps** 7. **Next Steps**
---
## Example ## Example
E-commerce platform → CONCERNS ⚠️ E-commerce platform → CONCERNS
**Gaps identified:** **Gaps identified:**
- Missing security architecture section - Missing security architecture section
@ -144,19 +109,17 @@ E-commerce platform → CONCERNS ⚠️
**Action:** Proceed with caution, address before payment epic. **Action:** Proceed with caution, address before payment epic.
---
## Tips ## Tips
- Run this before every Phase 4 start - **Run before every Phase 4 start** — It's a valuable checkpoint
- Take FAIL decisions seriously - fix issues first - **Take FAIL decisions seriously** — Fix issues first
- Use CONCERNS as a checklist for parallel work - **Use CONCERNS as a checklist** — Track parallel work
- Document why you proceed despite concerns - **Document why you proceed despite concerns** — Transparency matters
--- ## Next Steps
## Related After implementation readiness:
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow 1. **If PASS** — Run sprint-planning to start Phase 4
- [Create Epics and Stories](/docs/how-to/workflows/create-epics-and-stories.md) - Work breakdown 2. **If CONCERNS** — Proceed with documented gaps to address
- [Run Sprint Planning](/docs/how-to/workflows/run-sprint-planning.md) - Start implementation 3. **If FAIL** — Return to relevant workflow to fix issues

49
docs/how-to/workflows/run-sprint-planning.md
View File

@ -3,27 +3,20 @@ title: "How to Run Sprint Planning"
description: How to initialize sprint tracking for implementation description: How to initialize sprint tracking for implementation
--- ---
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation. Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
---
## When to Use This ## When to Use This
- Once at the start of Phase 4 (Implementation) - Once at the start of Phase 4 (Implementation)
- After implementation-readiness gate passes - After implementation-readiness gate passes
- When starting a new sprint cycle - When starting a new sprint cycle
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- SM (Scrum Master) agent available - SM (Scrum Master) agent available
- Epic files created from `create-epics-and-stories` - Epic files created from `create-epics-and-stories`
- Implementation-readiness passed (for BMad Method/Enterprise) - Implementation-readiness passed (for BMad Method/Enterprise)
:::
---
## Steps ## Steps
@ -45,8 +38,6 @@ Point the agent to your epic files created during Phase 3.
The agent organizes stories into the sprint tracking file. The agent organizes stories into the sprint tracking file.
---
## What You Get ## What You Get
A `sprint-status.yaml` file containing: A `sprint-status.yaml` file containing:
@ -56,12 +47,8 @@ A `sprint-status.yaml` file containing:
- Dependencies between stories - Dependencies between stories
- Priority ordering - Priority ordering
---
## Story Lifecycle States ## Story Lifecycle States
Stories move through these states in the sprint status file:
| State | Description | | State | Description |
|-------|-------------| |-------|-------------|
| **TODO** | Story identified but not started | | **TODO** | Story identified but not started |
@ -69,43 +56,39 @@ Stories move through these states in the sprint status file:
| **READY FOR REVIEW** | Implementation complete, awaiting code review | | **READY FOR REVIEW** | Implementation complete, awaiting code review |
| **DONE** | Accepted and complete | | **DONE** | Accepted and complete |
---
## Typical Sprint Flow ## Typical Sprint Flow
### Sprint 0 (Planning Phase) **Sprint 0 (Planning Phase):**
- Complete Phases 1-3 - Complete Phases 1-3
- PRD/GDD + Architecture complete - PRD/GDD + Architecture complete
- Epics+Stories created via create-epics-and-stories - Epics+Stories created via create-epics-and-stories
### Sprint 1+ (Implementation Phase) **Sprint 1+ (Implementation Phase):**
**Start of Phase 4:** Start of Phase 4:
1. SM runs `sprint-planning` (once) 1. SM runs `sprint-planning` (once)
**Per Story (repeat until epic complete):** Per Story (repeat until epic complete):
1. SM runs `create-story` 1. SM runs `create-story`
2. DEV runs `dev-story` 2. DEV runs `dev-story`
3. DEV runs `code-review` 3. DEV runs `code-review`
4. Update sprint-status.yaml 4. Update sprint-status.yaml
**After Epic Complete:** After Epic Complete:
- SM runs `retrospective` - SM runs `retrospective`
- Move to next epic - Move to next epic
---
## Tips ## Tips
- Run sprint-planning only once at Phase 4 start - **Run sprint-planning only once** — At Phase 4 start
- Use `sprint-status` during Phase 4 to check current state - **Use sprint-status during Phase 4** — Check current state anytime
- Keep the sprint-status.yaml file as single source of truth - **Keep sprint-status.yaml as single source of truth** — All status updates go here
- Update story status after each stage - **Update story status after each stage** — Keep it current
--- ## Next Steps
## Related After sprint planning:
- [Create Story](/docs/how-to/workflows/create-story.md) - Prepare stories for implementation 1. **Create Story** — Prepare the first story for implementation
- [Implement Story](/docs/how-to/workflows/implement-story.md) - Dev workflow 2. **Implement Story** — Run dev-story with the DEV agent
- [Run Code Review](/docs/how-to/workflows/run-code-review.md) - Quality assurance 3. **Code Review** — Quality assurance after implementation

70
docs/how-to/workflows/run-test-design.md
View File

@ -3,11 +3,8 @@ title: "How to Run Test Design"
description: How to create comprehensive test plans using TEA's test-design workflow description: How to create comprehensive test plans using TEA's test-design workflow
--- ---
Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies. Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies.
---
## When to Use This ## When to Use This
**System-level (Phase 3):** **System-level (Phase 3):**
@ -20,16 +17,12 @@ Use TEA's `*test-design` workflow to create comprehensive test plans with risk a
- Before implementing stories in the epic - Before implementing stories in the epic
- To identify epic-specific testing needs - To identify epic-specific testing needs
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- TEA agent available - TEA agent available
- For system-level: Architecture document complete - For system-level: Architecture document complete
- For epic-level: Epic defined with stories - For epic-level: Epic defined with stories
:::
---
## Steps ## Steps
@ -47,8 +40,8 @@ Start a fresh chat and load the TEA (Test Architect) agent.
TEA will ask if you want: TEA will ask if you want:
- **System-level** - For architecture testability review (Phase 3) - **System-level** — For architecture testability review (Phase 3)
- **Epic-level** - For epic-specific test planning (Phase 4) - **Epic-level** — For epic-specific test planning (Phase 4)
### 4. Provide Context ### 4. Provide Context
@ -64,20 +57,16 @@ For epic-level:
TEA generates a comprehensive test design document. TEA generates a comprehensive test design document.
---
## What You Get ## What You Get
### System-Level Output (`test-design-system.md`) **System-Level Output (`test-design-system.md`):**
- Testability review of architecture - Testability review of architecture
- ADR → test mapping - ADR → test mapping
- Architecturally Significant Requirements (ASRs) - Architecturally Significant Requirements (ASRs)
- Environment needs - Environment needs
- Test infrastructure recommendations - Test infrastructure recommendations
### Epic-Level Output (`test-design-epic-N.md`) **Epic-Level Output (`test-design-epic-N.md`):**
- Risk assessment for the epic - Risk assessment for the epic
- Test priorities - Test priorities
- Coverage plan - Coverage plan
@ -85,44 +74,25 @@ TEA generates a comprehensive test design document.
- Integration risks - Integration risks
- Mitigation strategies - Mitigation strategies
---
## Test Design for Different Tracks ## Test Design for Different Tracks
### Greenfield - BMad Method | Track | Phase 3 Focus | Phase 4 Focus |
|-------|---------------|---------------|
| Stage | Test Design Focus | | **Greenfield** | System-level testability review | Per-epic risk assessment and test plan |
|-------|-------------------| | **Brownfield** | System-level + existing test baseline | Regression hotspots, integration risks |
| Phase 3 | System-level testability review | | **Enterprise** | Compliance-aware testability | Security/performance/compliance focus |
| Phase 4 | Per-epic risk assessment and test plan |
### Brownfield - BMad Method/Enterprise
| Stage | Test Design Focus |
|-------|-------------------|
| Phase 3 | System-level + existing test baseline |
| Phase 4 | Regression hotspots, integration risks |
### Enterprise
| Stage | Test Design Focus |
|-------|-------------------|
| Phase 3 | Compliance-aware testability |
| Phase 4 | Security/performance/compliance focus |
---
## Tips ## Tips
- Run system-level test-design right after architecture - **Run system-level right after architecture** — Early testability review
- Run epic-level test-design at the start of each epic - **Run epic-level at the start of each epic** — Targeted test planning
- Update test design if ADRs change - **Update if ADRs change** — Keep test design aligned
- Use the output to guide `*atdd` and `*automate` workflows - **Use output to guide other workflows** — Feeds into `*atdd` and `*automate`
--- ## Next Steps
## Related After test design:
- [TEA Overview](/docs/explanation/features/tea-overview.md) - Understanding the Test Architect 1. **Setup Test Framework** — If not already configured
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md) - Setting up testing infrastructure 2. **Implementation Readiness** — System-level feeds into gate check
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow 3. **Story Implementation** — Epic-level guides testing during dev

75
docs/how-to/workflows/setup-party-mode.md
View File

@ -3,11 +3,8 @@ title: "How to Set Up Party Mode"
description: How to set up and use Party Mode for multi-agent collaboration description: How to set up and use Party Mode for multi-agent collaboration
--- ---
Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team. Use Party Mode to orchestrate dynamic multi-agent conversations with your entire BMad team.
---
## When to Use This ## When to Use This
- Exploring complex topics that benefit from diverse expert perspectives - Exploring complex topics that benefit from diverse expert perspectives
@ -15,14 +12,10 @@ Use Party Mode to orchestrate dynamic multi-agent conversations with your entire
- Getting comprehensive views across multiple domains - Getting comprehensive views across multiple domains
- Strategic decisions with trade-offs - Strategic decisions with trade-offs
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed with multiple agents - BMad Method installed with multiple agents
- Any agent loaded that supports party mode - Any agent loaded that supports party mode
:::
---
## Steps ## Steps
@ -62,56 +55,36 @@ The facilitator will:
Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells. Type "exit" or "done" to conclude the session. Participating agents will say personalized farewells.
---
## What Happens ## What Happens
1. **Agent Roster** - Party Mode loads your complete agent roster 1. **Agent Roster** — Party Mode loads your complete agent roster
2. **Introduction** - Available team members are introduced 2. **Introduction** — Available team members are introduced
3. **Topic Analysis** - The facilitator analyzes your topic 3. **Topic Analysis** — The facilitator analyzes your topic
4. **Agent Selection** - 2-3 most relevant agents are selected 4. **Agent Selection** — 2-3 most relevant agents are selected
5. **Discussion** - Agents respond, reference each other, engage in cross-talk 5. **Discussion** — Agents respond, reference each other, engage in cross-talk
6. **Exit** - Session concludes with farewells 6. **Exit** — Session concludes with farewells
---
## Example Party Compositions ## Example Party Compositions
### Product Strategy | Topic | Typical Agents |
- PM + Innovation Strategist (CIS) + Analyst |-------|---------------|
| **Product Strategy** | PM + Innovation Strategist (CIS) + Analyst |
### Technical Design | **Technical Design** | Architect + Creative Problem Solver (CIS) + Game Architect |
- Architect + Creative Problem Solver (CIS) + Game Architect | **User Experience** | UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS) |
| **Quality Assessment** | TEA + DEV + Architect |
### User Experience
- UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
### Quality Assessment
- TEA + DEV + Architect
---
## Key Features ## Key Features
- **Intelligent agent selection** - Selects based on expertise needed - **Intelligent agent selection** — Selects based on expertise needed
- **Authentic personalities** - Each agent maintains their unique voice - **Authentic personalities** — Each agent maintains their unique voice
- **Natural cross-talk** - Agents reference and build on each other - **Natural cross-talk** — Agents reference and build on each other
- **Optional TTS** - Voice configurations for each agent - **Optional TTS** — Voice configurations for each agent
- **Graceful exit** - Personalized farewells - **Graceful exit** — Personalized farewells
---
## Tips ## Tips
- Be specific about your topic for better agent selection - **Be specific about your topic** — Better agent selection
- Let the conversation flow naturally - **Let the conversation flow** — Don't over-direct
- Ask follow-up questions to go deeper - **Ask follow-up questions** — Go deeper on interesting points
- Take notes on key insights - **Take notes on key insights** — Capture valuable perspectives
- Use for strategic decisions, not routine tasks - **Use for strategic decisions** — Not routine tasks
---
## Related
- [Party Mode](/docs/explanation/features/party-mode.md) - Understanding Party Mode
- [Agent Roles](/docs/explanation/core-concepts/agent-roles.md) - Available agents

49
docs/how-to/workflows/setup-test-framework.md
View File

@ -3,11 +3,8 @@ title: "How to Set Up a Test Framework"
description: How to set up a production-ready test framework using TEA description: How to set up a production-ready test framework using TEA
--- ---
Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project. Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project.
---
## When to Use This ## When to Use This
- No existing test framework in your project - No existing test framework in your project
@ -15,15 +12,11 @@ Use TEA's `*framework` workflow to scaffold a production-ready test framework fo
- Starting a new project that needs testing infrastructure - Starting a new project that needs testing infrastructure
- Phase 3 (Solutioning) after architecture is complete - Phase 3 (Solutioning) after architecture is complete
--- :::note[Prerequisites]
## Prerequisites
- BMad Method installed - BMad Method installed
- Architecture completed (or at least tech stack decided) - Architecture completed (or at least tech stack decided)
- TEA agent available - TEA agent available
:::
---
## Steps ## Steps
@ -50,13 +43,11 @@ TEA will ask about:
TEA generates: TEA generates:
- **Test scaffold** - Directory structure and config files - **Test scaffold** — Directory structure and config files
- **Sample specs** - Example tests following best practices - **Sample specs** — Example tests following best practices
- **`.env.example`** - Environment variable template - **`.env.example`** — Environment variable template
- **`.nvmrc`** - Node version specification - **`.nvmrc`** — Node version specification
- **README updates** - Testing documentation - **README updates** — Testing documentation
---
## What You Get ## What You Get
@ -71,8 +62,6 @@ tests/
└── README.md └── README.md
``` ```
---
## Optional: Playwright Utils Integration ## Optional: Playwright Utils Integration
TEA can integrate with `@seontechnologies/playwright-utils` for advanced fixtures: TEA can integrate with `@seontechnologies/playwright-utils` for advanced fixtures:
@ -85,29 +74,25 @@ Enable during BMad installation or set `tea_use_playwright_utils: true` in confi
**Utilities available:** api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor **Utilities available:** api-request, network-recorder, auth-session, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor
---
## Optional: MCP Enhancements ## Optional: MCP Enhancements
TEA can use Playwright MCP servers for enhanced capabilities: TEA can use Playwright MCP servers for enhanced capabilities:
- `playwright` - Browser automation - `playwright` — Browser automation
- `playwright-test` - Test runner with failure analysis - `playwright-test` — Test runner with failure analysis
Configure in your IDE's MCP settings. Configure in your IDE's MCP settings.
---
## Tips ## Tips
- Run `*framework` only once per repository - **Run only once per repository** — Framework setup is a one-time operation
- Run after architecture is complete so framework aligns with tech stack - **Run after architecture is complete** — Framework aligns with tech stack
- Follow up with `*ci` to set up CI/CD pipeline - **Follow up with CI setup** — Run `*ci` to configure CI/CD pipeline
--- ## Next Steps
## Related After test framework setup:
- [TEA Overview](/docs/explanation/features/tea-overview.md) - Understanding the Test Architect 1. **Test Design** — Create test plans for system or epics
- [Run Test Design](/docs/how-to/workflows/run-test-design.md) - Creating test plans 2. **CI Configuration** — Set up automated test runs
- [Create Architecture](/docs/how-to/workflows/create-architecture.md) - Architecture workflow 3. **Story Implementation** — Tests are ready for development

128
docs/reference/agents/index.md
View File

@ -3,139 +3,107 @@ title: "Agents Reference"
description: Complete reference for BMad Method agents and their commands description: Complete reference for BMad Method agents and their commands
--- ---
Quick reference of all BMad Method agents and their available commands. Quick reference of all BMad Method agents and their available commands.
--- :::tip[Universal Commands]
All agents support: `*menu` (redisplay options), `*dismiss` (dismiss agent), and `*party-mode` (multi-agent collaboration).
:::
## Analyst (Mary) ## Analyst (Mary)
Business analysis and research. Business analysis and research.
**Commands:** **Commands:**
- `*workflow-status` - Get workflow status or initialize tracking - `*workflow-status` — Get workflow status or initialize tracking
- `*brainstorm-project` - Guided brainstorming session - `*brainstorm-project` — Guided brainstorming session
- `*research` - Market, domain, competitive, or technical research - `*research` — Market, domain, competitive, or technical research
- `*product-brief` - Create a product brief (input for PRD) - `*product-brief` — Create a product brief (input for PRD)
- `*document-project` - Document existing brownfield projects - `*document-project` — Document existing brownfield projects
---
## PM (John) ## PM (John)
Product requirements and planning. Product requirements and planning.
**Commands:** **Commands:**
- `*workflow-status` - Get workflow status or initialize tracking - `*workflow-status` — Get workflow status or initialize tracking
- `*create-prd` - Create Product Requirements Document - `*create-prd` — Create Product Requirements Document
- `*create-epics-and-stories` - Break PRD into epics and user stories (after Architecture) - `*create-epics-and-stories` — Break PRD into epics and user stories (after Architecture)
- `*implementation-readiness` - Validate PRD, UX, Architecture, Epics alignment - `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
- `*correct-course` - Course correction during implementation - `*correct-course` — Course correction during implementation
---
## Architect (Winston) ## Architect (Winston)
System architecture and technical design. System architecture and technical design.
**Commands:** **Commands:**
- `*workflow-status` - Get workflow status or initialize tracking - `*workflow-status` — Get workflow status or initialize tracking
- `*create-architecture` - Create architecture document to guide development - `*create-architecture` — Create architecture document to guide development
- `*implementation-readiness` - Validate PRD, UX, Architecture, Epics alignment - `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
- `*create-excalidraw-diagram` - System architecture or technical diagrams - `*create-excalidraw-diagram` — System architecture or technical diagrams
- `*create-excalidraw-dataflow` - Data flow diagrams - `*create-excalidraw-dataflow` — Data flow diagrams
---
## SM (Bob) ## SM (Bob)
Sprint planning and story preparation. Sprint planning and story preparation.
**Commands:** **Commands:**
- `*sprint-planning` - Generate sprint-status.yaml from epic files - `*sprint-planning` — Generate sprint-status.yaml from epic files
- `*create-story` - Create story from epic (prep for development) - `*create-story` — Create story from epic (prep for development)
- `*validate-create-story` - Validate story quality - `*validate-create-story` — Validate story quality
- `*epic-retrospective` - Team retrospective after epic completion - `*epic-retrospective` — Team retrospective after epic completion
- `*correct-course` - Course correction during implementation - `*correct-course` — Course correction during implementation
---
## DEV (Amelia) ## DEV (Amelia)
Story implementation and code review. Story implementation and code review.
**Commands:** **Commands:**
- `*dev-story` - Execute story workflow (implementation with tests) - `*dev-story` — Execute story workflow (implementation with tests)
- `*code-review` - Thorough code review - `*code-review` — Thorough code review
---
## Quick Flow Solo Dev (Barry) ## Quick Flow Solo Dev (Barry)
Fast solo development without handoffs. Fast solo development without handoffs.
**Commands:** **Commands:**
- `*quick-spec` - Architect technical spec with implementation-ready stories - `*quick-spec` — Architect technical spec with implementation-ready stories
- `*quick-dev` - Implement tech spec end-to-end solo - `*quick-dev` — Implement tech spec end-to-end solo
- `*code-review` - Review and improve code - `*code-review` — Review and improve code
---
## TEA (Murat) ## TEA (Murat)
Test architecture and quality strategy. Test architecture and quality strategy.
**Commands:** **Commands:**
- `*framework` - Initialize production-ready test framework - `*framework` — Initialize production-ready test framework
- `*atdd` - Generate E2E tests first (before implementation) - `*atdd` — Generate E2E tests first (before implementation)
- `*automate` - Comprehensive test automation - `*automate` — Comprehensive test automation
- `*test-design` - Create comprehensive test scenarios - `*test-design` — Create comprehensive test scenarios
- `*trace` - Map requirements to tests, quality gate decision - `*trace` — Map requirements to tests, quality gate decision
- `*nfr-assess` - Validate non-functional requirements - `*nfr-assess` — Validate non-functional requirements
- `*ci` - Scaffold CI/CD quality pipeline - `*ci` — Scaffold CI/CD quality pipeline
- `*test-review` - Review test quality - `*test-review` — Review test quality
---
## UX Designer (Sally) ## UX Designer (Sally)
User experience and UI design. User experience and UI design.
**Commands:** **Commands:**
- `*create-ux-design` - Generate UX design and UI plan from PRD - `*create-ux-design` — Generate UX design and UI plan from PRD
- `*validate-design` - Validate UX specification and design artifacts - `*validate-design` — Validate UX specification and design artifacts
- `*create-excalidraw-wireframe` - Create website or app wireframe - `*create-excalidraw-wireframe` — Create website or app wireframe
---
## Technical Writer (Paige) ## Technical Writer (Paige)
Technical documentation and diagrams. Technical documentation and diagrams.
**Commands:** **Commands:**
- `*document-project` - Comprehensive project documentation - `*document-project` — Comprehensive project documentation
- `*generate-mermaid` - Generate Mermaid diagrams - `*generate-mermaid` — Generate Mermaid diagrams
- `*create-excalidraw-flowchart` - Process and logic flow visualizations - `*create-excalidraw-flowchart` — Process and logic flow visualizations
- `*create-excalidraw-diagram` - System architecture or technical diagrams - `*create-excalidraw-diagram` — System architecture or technical diagrams
- `*create-excalidraw-dataflow` - Data flow visualizations - `*create-excalidraw-dataflow` — Data flow visualizations
- `*validate-doc` - Review documentation against standards - `*validate-doc` — Review documentation against standards
- `*improve-readme` - Review and improve README files - `*improve-readme` — Review and improve README files
- `*explain-concept` - Create clear technical explanations - `*explain-concept` — Create clear technical explanations
- `*standards-guide` - Show BMad documentation standards - `*standards-guide` — Show BMad documentation standards
---
## Universal Commands
Available to all agents:
- `*menu` - Redisplay menu options
- `*dismiss` - Dismiss agent
- `*party-mode` - Multi-agent collaboration (most agents)
---
## Related
- [Agent Roles](/docs/explanation/core-concepts/agent-roles.md) - Understanding agent responsibilities
- [What Are Agents](/docs/explanation/core-concepts/what-are-agents.md) - Foundational concepts

66
docs/reference/configuration/core-tasks.md
View File

@ -2,66 +2,66 @@
title: "Core Tasks" title: "Core Tasks"
--- ---
Reusable task definitions that can be invoked by any BMad module, workflow, or agent.
Core Tasks are reusable task definitions that can be invoked by any BMad module, workflow, or agent. These tasks provide standardized functionality for common operations. ## Contents
## Table of Contents
- [Index Docs](#index-docs) — Generate directory index files - [Index Docs](#index-docs) — Generate directory index files
- [Adversarial Review](#adversarial-review-general) — Critical content review - [Adversarial Review](#adversarial-review) — Critical content review
- [Shard Document](#shard-document) — Split large documents into sections - [Shard Document](#shard-document) — Split large documents into sections
---
## Index Docs ## Index Docs
**Generates or updates an index.md file documenting all documents in a specified directory.** **Generates or updates an index.md file documenting all files in a specified directory.**
This task scans a target directory, reads file contents to understand their purpose, and creates a well-organized index with accurate descriptions. Files are grouped by type, purpose, or subdirectory, and descriptions are generated from actual content rather than guessing from filenames. **Use it when:**
- You need navigable documentation for a folder of markdown files
**Use it when:** You need to create navigable documentation for a folder of markdown files, or you want to maintain an updated index as content evolves. - You want to maintain an updated index as content evolves
**How it works:** **How it works:**
1. Scan the target directory for files and subdirectories 1. Scan the target directory for files and subdirectories
2. Group content by type, purpose, or location 2. Group content by type, purpose, or location
3. Read each file to generate brief (3-10 word) descriptions based on actual content 3. Read each file to generate brief (3-10 word) descriptions
4. Create or update index.md with organized listings using relative paths 4. Create or update index.md with organized listings
**Output format:** A markdown index with sections for Files and Subdirectories, each entry containing a relative link and description. **Output:** Markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
--- ## Adversarial Review
## Adversarial Review (General)
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.** **Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
This task applies adversarial thinking to content review—approaching the material with the assumption that problems exist. It's designed to find what's missing, not just what's wrong, and produces at least ten specific findings. The reviewer adopts a professional but skeptical tone, looking for gaps, inconsistencies, oversights, and areas that need clarification. **Use it when:**
- Reviewing code diffs before merging
**Use it when:** You need a critical eye on code diffs, specifications, user stories, documentation, or any artifact before finalizing. It's particularly valuable before merging code, releasing documentation, or considering a specification complete. - Finalizing specifications or user stories
- Releasing documentation
- Any artifact needs a critical eye before completion
**How it works:** **How it works:**
1. Load the content to review (diff, branch, uncommitted changes, document, etc.) 1. Load the content to review (diff, branch, document, etc.)
2. Perform adversarial analysis with extreme skepticism—assume problems exist 2. Perform adversarial analysis — assume problems exist
3. Find at least ten issues to fix or improve 3. Find at least ten issues to fix or improve
4. Output findings as a markdown list 4. Output findings as a markdown list
**Note:** This task is designed to run in a separate subagent/process with read access to the project but no prior context, ensuring an unbiased review. :::note[Unbiased Review]
This task runs in a separate subagent with read access but no prior context, ensuring an unbiased review.
--- :::
## Shard Document ## Shard Document
**Splits large markdown documents into smaller, organized files based on level 2 (##) sections.** **Splits large markdown documents into smaller files based on level 2 (`##`) sections.**
Uses the `@kayvan/markdown-tree-parser` tool to automatically break down large documents into a folder structure. Each level 2 heading becomes a separate file, and an index.md is generated to tie everything together. This makes large documents more maintainable and allows for easier navigation and updates to individual sections. **Use it when:**
- A markdown file has grown too large to work with effectively
**Use it when:** A markdown file has grown too large to effectively work with, or you want to break a monolithic document into manageable sections that can be edited independently. - You want to break a monolithic document into manageable sections
- Individual sections need to be edited independently
**How it works:** **How it works:**
1. Confirm source document path and verify it's a markdown file 1. Confirm source document path (must be markdown)
2. Determine destination folder (defaults to same location as source, folder named after document) 2. Determine destination folder (defaults to folder named after document)
3. Execute the sharding command using npx @kayvan/markdown-tree-parser 3. Execute sharding via `npx @kayvan/markdown-tree-parser`
4. Verify output files and index.md were created 4. Verify output files and index.md were created
5. Handle the original document—delete, move to archive, or keep with warning 5. Handle original document — delete, move to archive, or keep
**Handling the original:** After sharding, the task prompts you to delete, archive, or keep the original document. Deleting or archiving is recommended to avoid confusion and ensure updates happen in the sharded files only. :::caution[Original File]
After sharding, delete or archive the original to avoid confusion. Updates should happen in the sharded files only.
:::

30
docs/reference/configuration/global-config.md
View File

@ -1,14 +1,28 @@
--- ---
title: "Core Module Global Inheritable Config" title: "Global Inheritable Config"
--- ---
Configuration values defined in the Core Module that all other modules inherit by default.
The Core Modules module.yaml file defines configuration values that are useful and unique for all other modules to utilize, and by default all other modules installed will clone the values defined in the core module yaml.config into their own. It is possible for other modules to override these values, but the general intent it to accept the core module values and define their own values as needed, or extend the core values. ## Core Config Values
Currently, the core module.yaml config will define (asking the user upon installation, and recording to the core module config.yaml): These values are set during installation and recorded to the core `module.yaml`:
- `user_name`: string (defaults to the system defined user name)
- `communication_language`: string (defaults to english)
- `document_output_language`: string (defaults to english)
- `output_folder`: string (default `_bmad-output`)
An example of extending one of these values, in the BMad Method module.yaml it defines a planning_artifacts config, which will default to `default: "{output_folder}/planning-artifacts"` thus whatever the output_folder will be, this extended versions default will use the value from this core module and append a new folder onto it. The user can choose to replace this without utilizing the output_folder from the core if they so chose. | Config Key | Default | Description |
|------------|---------|-------------|
| `user_name` | System username | User's display name |
| `communication_language` | `english` | Language for agent communication |
| `document_output_language` | `english` | Language for generated documents |
| `output_folder` | `_bmad-output` | Directory for workflow outputs |
## Inheritance Behavior
All installed modules automatically clone these values into their own config. Modules can:
- **Accept defaults** — Use core values as-is (recommended)
- **Override values** — Replace with module-specific settings
- **Extend values** — Build on core values with additional paths
:::tip[Extending Config]
Use `{output_folder}` to reference the core value. Example: BMad Method defines `planning_artifacts` as `{output_folder}/planning-artifacts`, automatically inheriting whatever output folder the user configured.
:::

432
docs/reference/glossary/index.md
View File

@ -2,371 +2,121 @@
title: "BMad Glossary" title: "BMad Glossary"
--- ---
Terminology reference for the BMad Method.
Comprehensive terminology reference for the BMad Method.
---
## Navigation
- [Core Concepts](#core-concepts)
- [Scale and Complexity](#scale-and-complexity)
- [Planning Documents](#planning-documents)
- [Workflow and Phases](#workflow-and-phases)
- [Agents and Roles](#agents-and-roles)
- [Status and Tracking](#status-and-tracking)
- [Project Types](#project-types)
- [Implementation Terms](#implementation-terms)
- [Game Development Terms](#game-development-terms)
---
## Core Concepts ## Core Concepts
### BMad (Breakthrough Method of Agile AI Driven Development) | Term | Definition |
|------|------------|
AI-driven agile development framework with specialized agents, guided workflows, and scale-adaptive intelligence. | **Agent** | Specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. |
| **BMad** | Breakthrough Method of Agile AI Driven Development — AI-driven agile framework with specialized agents, guided workflows, and scale-adaptive intelligence. |
### BMM (BMad Method Module) | **BMad Method** | Complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity. |
| **BMM** | BMad Method Module — core orchestration system providing comprehensive lifecycle management through specialized agents and workflows. |
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows. | **Scale-Adaptive System** | Intelligent workflow orchestration that adjusts planning depth and documentation requirements based on project needs through three planning tracks. |
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context. |
### BMad Method
The complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity.
### Scale-Adaptive System
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).
### Agent
A specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. Agents have defined capabilities, communication styles, and workflow access.
### Workflow
A multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context.
---
## Scale and Complexity ## Scale and Complexity
### Quick Flow Track | Term | Definition |
|------|------------|
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. | **BMad Method Track** | Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features. Typical range: 10-50+ stories. |
| **Enterprise Method Track** | Extended planning track adding Security Architecture, DevOps Strategy, and Test Strategy. Best for compliance needs and multi-tenant systems. Typical range: 30+ stories. |
### BMad Method Track | **Planning Track** | Methodology path (Quick Flow, BMad Method, or Enterprise) chosen based on planning needs and complexity, not story count alone. |
| **Quick Flow Track** | Fast implementation track using tech-spec only. Best for bug fixes, small features, and clear-scope changes. Typical range: 1-15 stories. |
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.
### Enterprise Method Track
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.
### Planning Track
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.
**Note:** Story counts are guidance, not definitions. Tracks are determined by what planning the project needs, not story math.
---
## Planning Documents ## Planning Documents
### Tech-Spec (Technical Specification) | Term | Definition |
|------|------------|
**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. | **Architecture Document** | *BMad Method/Enterprise.* System-wide design document defining structure, components, data models, integration patterns, security, and deployment. |
| **Epics** | High-level feature groupings containing multiple related stories. Typically 5-15 stories each representing cohesive functionality. |
### PRD (Product Requirements Document) | **Game Brief** | *BMGD.* Document capturing game's core vision, pillars, target audience, and scope. Foundation for the GDD. |
| **GDD** | *BMGD.* Game Design Document — comprehensive document detailing all aspects of game design: mechanics, systems, content, and more. |
**BMad Method/Enterprise tracks.** Product-level planning document containing vision, goals, Functional Requirements (FRs), Non-Functional Requirements (NFRs), success criteria, and UX considerations. Replaces tech-spec for larger projects that need product planning. **V6 Note:** PRD focuses on WHAT to build (requirements). Epic+Stories are created separately AFTER architecture via create-epics-and-stories workflow. | **PRD** | *BMad Method/Enterprise.* Product Requirements Document containing vision, goals, FRs, NFRs, and success criteria. Focuses on WHAT to build. |
| **Product Brief** | *Phase 1.* Optional strategic document capturing product vision, market context, and high-level requirements before detailed planning. |
### Architecture Document | **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. |
**BMad Method/Enterprise tracks.** System-wide design document defining structure, components, interactions, data models, integration patterns, security, performance, and deployment.
**Scale-Adaptive:** Architecture complexity scales with track - BMad Method is lightweight to moderate, Enterprise Method is comprehensive with security/devops/test strategies.
### Epics
High-level feature groupings that contain multiple related stories. Typically span 5-15 stories each and represent cohesive functionality (e.g., "User Authentication Epic").
### Product Brief
Optional strategic planning document created in Phase 1 (Analysis) that captures product vision, market context, user needs, and high-level requirements before detailed planning.
### GDD (Game Design Document)
Game development equivalent of PRD, created by Game Designer agent for game projects. Comprehensive document detailing all aspects of game design: mechanics, systems, content, and more.
### Game Brief
Document capturing the game's core vision, pillars, target audience, and scope. Foundation for the GDD.
---
## Workflow and Phases ## Workflow and Phases
### Phase 0: Documentation (Prerequisite) | Term | Definition |
|------|------------|
**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents. | **Phase 0: Documentation** | *Brownfield.* Conditional prerequisite phase creating codebase documentation before planning. Only required if existing docs are insufficient. |
| **Phase 1: Analysis** | Discovery phase including brainstorming, research, and product brief creation. Optional for Quick Flow, recommended for BMad Method. |
### Phase 1: Analysis (Optional) | **Phase 2: Planning** | Required phase creating formal requirements. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise). |
| **Phase 3: Solutioning** | *BMad Method/Enterprise.* Architecture design phase including creation, validation, and gate checks. |
Discovery and research phase including brainstorming, research workflows, and product brief creation. Optional for Quick Flow, recommended for BMad Method, required for Enterprise Method. | **Phase 4: Implementation** | Required sprint-based development through story-by-story iteration using sprint-planning, create-story, dev-story, and code-review workflows. |
| **Quick Spec Flow** | Fast-track workflow for Quick Flow projects going straight from idea to tech-spec to implementation. |
### Phase 2: Planning (Required) | **Workflow Init** | Initialization workflow creating bmm-workflow-status.yaml, detecting project type, and determining planning track. |
| **Workflow Status** | Universal entry point checking for existing status file, displaying progress, and recommending next action. |
**Always required.** Creates formal requirements and work breakdown. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise) based on selected track.
### Phase 3: Solutioning (Track-Dependent)
Architecture design phase. Required for BMad Method and Enterprise Method tracks. Includes architecture creation, validation, and gate checks.
### Phase 4: Implementation (Required)
Sprint-based development through story-by-story iteration. Uses sprint-planning, create-story, dev-story, code-review, and retrospective workflows.
### Quick Spec Flow
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.
---
## Agents and Roles ## Agents and Roles
### PM (Product Manager) | Term | Definition |
|------|------------|
Agent responsible for creating PRDs, tech-specs, and managing product requirements. Primary agent for Phase 2 planning. | **Analyst** | Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. |
| **Architect** | Agent designing system architecture, creating architecture documents, and validating designs. Primary agent for Phase 3. |
### Analyst (Business Analyst) | **BMad Master** | Meta-level orchestrator from BMad Core facilitating party mode and providing high-level guidance across all modules. |
| **DEV** | Developer agent implementing stories, writing code, running tests, and performing code reviews. Primary implementer in Phase 4. |
Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. | **Game Architect** | *BMGD.* Agent designing game system architecture and validating game-specific technical designs. |
| **Game Designer** | *BMGD.* Agent creating game design documents (GDD) and running game-specific workflows. |
### Architect | **Party Mode** | Multi-agent collaboration feature where agents discuss challenges together. BMad Master orchestrates, selecting 2-3 relevant agents per message. |
| **PM** | Product Manager agent creating PRDs and tech-specs. Primary agent for Phase 2 planning. |
Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning. | **SM** | Scrum Master agent managing sprints, creating stories, and coordinating implementation. Primary orchestrator for Phase 4. |
| **TEA** | Test Architect agent responsible for test strategy, quality gates, and NFR assessment. Integrates throughout all phases. |
### SM (Scrum Master) | **Technical Writer** | Agent specialized in creating technical documentation, diagrams, and maintaining documentation standards. |
| **UX Designer** | Agent creating UX design documents, interaction patterns, and visual specifications for UI-heavy projects. |
Agent that manages sprints, creates stories, generates contexts, and coordinates implementation. Primary orchestrator for Phase 4 implementation.
### DEV (Developer)
Agent that implements stories, writes code, runs tests, and performs code reviews. Primary implementer in Phase 4.
### TEA (Test Architect)
Agent responsible for test strategy, quality gates, NFR assessment, and comprehensive quality assurance. Integrates throughout all phases.
### Technical Writer
Agent specialized in creating and maintaining high-quality technical documentation. Expert in documentation standards, information architecture, and professional technical writing.
### UX Designer
Agent that creates UX design documents, interaction patterns, and visual specifications for UI-heavy projects.
### Game Designer
Specialized agent for game development projects. Creates game design documents (GDD) and game-specific workflows.
### Game Architect
Agent that designs game system architecture, creates technical architecture for games, and validates game-specific designs.
### BMad Master
Meta-level orchestrator agent from BMad Core. Facilitates party mode, lists available tasks and workflows, and provides high-level guidance across all modules.
### Party Mode
Multi-agent collaboration feature where all installed agents discuss challenges together in real-time. BMad Master orchestrates, selecting 2-3 relevant agents per message for natural cross-talk and debate. Best for strategic decisions, creative brainstorming, cross-functional alignment, and complex problem-solving.
---
## Status and Tracking ## Status and Tracking
### bmm-workflow-status.yaml | Term | Definition |
|------|------------|
**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically. | **bmm-workflow-status.yaml** | *Phases 1-3.* Tracking file showing current phase, completed workflows, and next recommended actions. |
| **DoD** | Definition of Done — criteria for marking a story complete: implementation done, tests passing, code reviewed, docs updated. |
### sprint-status.yaml | **Epic Status Progression** | `backlog → in-progress → done` — lifecycle states for epics during implementation. |
| **Gate Check** | Validation workflow (implementation-readiness) ensuring PRD, Architecture, and Epics are aligned before Phase 4. |
**Phase 4 only.** Single source of truth for implementation tracking. Contains all epics, stories, and retrospectives with current status for each. Created by sprint-planning, updated by agents. | **Retrospective** | Workflow after each epic capturing learnings and improvements for continuous improvement. |
| **sprint-status.yaml** | *Phase 4.* Single source of truth for implementation tracking containing all epics, stories, and their statuses. |
### Story Status Progression | **Story Status Progression** | `backlog → ready-for-dev → in-progress → review → done` — lifecycle states for stories. |
```
backlog → ready-for-dev → in-progress → review → done
```
- **backlog** - Story exists in epic but not yet created
- **ready-for-dev** - Story file created via create-story; validation is optional
- **in-progress** - DEV is implementing via dev-story
- **review** - Implementation complete, awaiting code-review
- **done** - Completed with DoD met
### Epic Status Progression
```
backlog → in-progress → done
```
- **backlog** - Epic not yet started
- **in-progress** - Epic actively being worked on
- **done** - All stories in epic completed
### Retrospective
Workflow run after completing each epic to capture learnings, identify improvements, and feed insights into next epic planning. Critical for continuous improvement.
---
## Project Types ## Project Types
### Greenfield | Term | Definition |
|------|------------|
New project starting from scratch with no existing codebase. Freedom to establish patterns, choose stack, and design from clean slate. | **Brownfield** | Existing project with established codebase and patterns. Requires understanding existing architecture and planning integration. |
| **Convention Detection** | *Quick Flow.* Feature auto-detecting existing code style, naming conventions, and frameworks from brownfield codebases. |
### Brownfield | **document-project** | *Brownfield.* Workflow analyzing and documenting existing codebase with three scan levels: quick, deep, exhaustive. |
| **Feature Flags** | *Brownfield.* Implementation technique for gradual rollout, easy rollback, and A/B testing of new functionality. |
Existing project with established codebase, patterns, and constraints. Requires understanding existing architecture, respecting established conventions, and planning integration with current systems. | **Greenfield** | New project starting from scratch with freedom to establish patterns, choose stack, and design from clean slate. |
| **Integration Points** | *Brownfield.* Specific locations where new code connects with existing systems. Must be documented in tech-specs. |
**Critical:** Brownfield projects should run document-project workflow BEFORE planning to ensure AI agents have adequate context about existing code.
### document-project Workflow
**Brownfield prerequisite.** Analyzes and documents existing codebase, creating comprehensive documentation including project overview, architecture analysis, source tree, API contracts, and data models. Three scan levels: quick, deep, exhaustive.
---
## Implementation Terms ## Implementation Terms
### Story | Term | Definition |
|------|------------|
Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of development effort. Stories are grouped into epics and tracked in sprint-status.yaml. | **Context Engineering** | Loading domain-specific standards into AI context automatically via manifests, ensuring consistent outputs regardless of prompt variation. |
| **Correct Course** | Workflow for navigating significant changes when implementation is off-track. Analyzes impact and recommends adjustments. |
### Story File | **Shard / Sharding** | Splitting large planning documents into section-based files for LLM optimization. Phase 4 workflows load only needed sections. |
| **Sprint** | Time-boxed period of development work, typically 1-2 weeks. |
Markdown file containing story details: description, acceptance criteria, technical notes, dependencies, implementation guidance, and testing requirements. | **Sprint Planning** | Workflow initializing Phase 4 by creating sprint-status.yaml and extracting epics/stories from planning docs. |
| **Story** | Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of effort. Grouped into epics. |
### Story Context | **Story Context** | Implementation guidance embedded in story files during create-story, referencing existing patterns and approaches. |
| **Story File** | Markdown file containing story description, acceptance criteria, technical notes, and testing requirements. |
Implementation guidance embedded within story files during the create-story workflow. Provides implementation-specific context, references existing patterns, suggests approaches, and helps maintain consistency with established codebase conventions. | **Track Selection** | Automatic analysis by workflow-init suggesting appropriate track based on complexity indicators. User can override. |
### Sprint Planning
Workflow that initializes Phase 4 implementation by creating sprint-status.yaml, extracting all epics/stories from planning docs, and setting up tracking infrastructure.
### Sprint
Time-boxed period of development work, typically 1-2 weeks.
### Gate Check
Validation workflow (implementation-readiness) run before Phase 4 to ensure PRD + Architecture + Epics + UX (optional) are aligned with no gaps or contradictions. Required for BMad Method and Enterprise Method tracks.
### DoD (Definition of Done)
Criteria that must be met before marking a story as done. Typically includes: implementation complete, tests written and passing, code reviewed, documentation updated, and acceptance criteria validated.
### Shard / Sharding
**For runtime LLM optimization only (NOT human docs).** Splitting large planning documents (PRD, epics, architecture) into smaller section-based files to improve workflow efficiency. Phase 1-3 workflows load entire sharded documents transparently. Phase 4 workflows selectively load only needed sections for massive token savings.
---
## Game Development Terms ## Game Development Terms
### Core Fantasy | Term | Definition |
|------|------------|
The emotional experience players seek from your game. What they want to FEEL. | **Core Fantasy** | *BMGD.* The emotional experience players seek from your game — what they want to FEEL. |
| **Core Loop** | *BMGD.* Fundamental cycle of actions players repeat throughout gameplay. The heart of your game. |
### Core Loop | **Design Pillar** | *BMGD.* Core principle guiding all design decisions. Typically 3-5 pillars define a game's identity. |
| **Environmental Storytelling** | *BMGD.* Narrative communicated through the game world itself rather than explicit dialogue. |
The fundamental cycle of actions players repeat throughout gameplay. The heart of your game. | **Game Type** | *BMGD.* Genre classification determining which specialized GDD sections are included. |
| **MDA Framework** | *BMGD.* Mechanics → Dynamics → Aesthetics — framework for analyzing and designing games. |
### Design Pillar | **Meta-Progression** | *BMGD.* Persistent progression carrying between individual runs or sessions. |
| **Metroidvania** | *BMGD.* Genre featuring interconnected world exploration with ability-gated progression. |
Core principle that guides all design decisions. Typically 3-5 pillars define a game's identity. | **Narrative Complexity** | *BMGD.* How central story is to the game: Critical, Heavy, Moderate, or Light. |
| **Permadeath** | *BMGD.* Game mechanic where character death is permanent, typically requiring a new run. |
### Game Type | **Player Agency** | *BMGD.* Degree to which players can make meaningful choices affecting outcomes. |
| **Procedural Generation** | *BMGD.* Algorithmic creation of game content (levels, items, characters) rather than hand-crafted. |
Genre classification that determines which specialized GDD sections are included. | **Roguelike** | *BMGD.* Genre featuring procedural generation, permadeath, and run-based progression. |
### Narrative Complexity
How central story is to the game experience:
- **Critical** - Story IS the game (visual novels)
- **Heavy** - Deep narrative with gameplay (RPGs)
- **Moderate** - Meaningful story supporting gameplay
- **Light** - Minimal story, gameplay-focused
### Environmental Storytelling
Narrative communicated through the game world itself—visual details, audio, found documents—rather than explicit dialogue.
### MDA Framework
Mechanics → Dynamics → Aesthetics. Framework for analyzing and designing games.
### Procedural Generation
Algorithmic creation of game content (levels, items, characters) rather than hand-crafted.
### Roguelike
Genre featuring procedural generation, permadeath, and run-based progression.
### Metroidvania
Genre featuring interconnected world exploration with ability-gated progression.
### Meta-Progression
Persistent progression that carries between individual runs or sessions.
### Permadeath
Game mechanic where character death is permanent, typically requiring a new run.
### Player Agency
The degree to which players can make meaningful choices that affect outcomes.
---
## Additional Terms
### Workflow Status
Universal entry point workflow that checks for existing status file, displays current phase/progress, and recommends next action based on project state.
### Workflow Init
Initialization workflow that creates bmm-workflow-status.yaml, detects greenfield vs brownfield, determines planning track, and sets up appropriate workflow path.
### Track Selection
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.
### Correct Course
Workflow run during Phase 4 when significant changes or issues arise. Analyzes impact, proposes solutions, and routes to appropriate remediation workflows.
### Feature Flags
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.
### Integration Points
Specific locations where new code connects with existing systems. Must be documented explicitly in brownfield tech-specs and architectures.
### Context Engineering
Loading domain-specific standards and patterns into AI context automatically, rather than relying on prompts alone. In TEA, this means the `tea-index.csv` manifest loads relevant knowledge fragments so the AI doesn't relearn testing patterns each session. This approach ensures consistent, production-ready outputs regardless of prompt variation.
### Convention Detection
Quick Spec Flow feature that automatically detects existing code style, naming conventions, patterns, and frameworks from brownfield codebases, then asks user to confirm before proceeding.

148
docs/reference/workflows/bmgd-workflows.md
View File

@ -2,19 +2,14 @@
title: "BMGD Workflows Guide" title: "BMGD Workflows Guide"
--- ---
Complete reference for all BMGD workflows organized by development phase. Complete reference for all BMGD workflows organized by development phase.
--- ## Overview
## Workflow Overview
BMGD workflows are organized into four phases: BMGD workflows are organized into four phases:
![BMGD Workflow Overview](../../tutorials/getting-started/images/workflow-overview.jpg) ![BMGD Workflow Overview](../../tutorials/getting-started/images/workflow-overview.jpg)
---
## Phase 1: Preproduction ## Phase 1: Preproduction
### Brainstorm Game ### Brainstorm Game
@ -24,23 +19,19 @@ BMGD workflows are organized into four phases:
**Input:** None required **Input:** None required
**Output:** Ideas and concepts (optionally saved) **Output:** Ideas and concepts (optionally saved)
**Description:**
Guided ideation session using game-specific brainstorming techniques: Guided ideation session using game-specific brainstorming techniques:
- **MDA Framework** - Mechanics → Dynamics → Aesthetics analysis - **MDA Framework** — Mechanics → Dynamics → Aesthetics analysis
- **Core Loop Workshop** - Define the fundamental gameplay loop - **Core Loop Workshop** — Define the fundamental gameplay loop
- **Player Fantasy Mining** - Explore what players want to feel - **Player Fantasy Mining** — Explore what players want to feel
- **Genre Mashup** - Combine genres for unique concepts - **Genre Mashup** — Combine genres for unique concepts
**Steps:** **Steps:**
1. Initialize brainstorm session 1. Initialize brainstorm session
2. Load game-specific techniques 2. Load game-specific techniques
3. Execute ideation with selected techniques 3. Execute ideation with selected techniques
4. Summarize and (optionally) hand off to Game Brief 4. Summarize and (optionally) hand off to Game Brief
---
### Game Brief ### Game Brief
**Command:** `create-game-brief` **Command:** `create-game-brief`
@ -48,11 +39,9 @@ Guided ideation session using game-specific brainstorming techniques:
**Input:** Ideas from brainstorming (optional) **Input:** Ideas from brainstorming (optional)
**Output:** `{output_folder}/game-brief.md` **Output:** `{output_folder}/game-brief.md`
**Description:** Captures your game's core vision and fundamentals. Foundation for all subsequent design work.
Captures your game's core vision and fundamentals. This is the foundation for all subsequent design work.
**Sections covered:** **Sections covered:**
- Game concept and vision - Game concept and vision
- Design pillars (3-5 core principles) - Design pillars (3-5 core principles)
- Target audience and market - Target audience and market
@ -60,8 +49,6 @@ Captures your game's core vision and fundamentals. This is the foundation for al
- Core gameplay loop - Core gameplay loop
- Initial scope definition - Initial scope definition
---
## Phase 2: Design ## Phase 2: Design
### GDD (Game Design Document) ### GDD (Game Design Document)
@ -71,11 +58,9 @@ Captures your game's core vision and fundamentals. This is the foundation for al
**Input:** Game Brief **Input:** Game Brief
**Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`) **Output:** `{output_folder}/gdd.md` (or sharded into `{output_folder}/gdd/`)
**Description:**
Comprehensive game design document with genre-specific sections based on 24 supported game types. Comprehensive game design document with genre-specific sections based on 24 supported game types.
**Core sections:** **Core sections:**
1. Executive Summary 1. Executive Summary
2. Gameplay Systems 2. Gameplay Systems
3. Core Mechanics 3. Core Mechanics
@ -88,14 +73,11 @@ Comprehensive game design document with genre-specific sections based on 24 supp
10. Epic Generation (for sprint planning) 10. Epic Generation (for sprint planning)
**Features:** **Features:**
- Game type selection with specialized sections - Game type selection with specialized sections
- Hybrid game type support - Hybrid game type support
- Automatic epic generation - Automatic epic generation
- Scale-adaptive complexity - Scale-adaptive complexity
---
### Narrative Design ### Narrative Design
**Command:** `narrative` **Command:** `narrative`
@ -103,11 +85,9 @@ Comprehensive game design document with genre-specific sections based on 24 supp
**Input:** GDD (required), Game Brief (optional) **Input:** GDD (required), Game Brief (optional)
**Output:** `{output_folder}/narrative-design.md` **Output:** `{output_folder}/narrative-design.md`
**Description:**
For story-driven games. Creates comprehensive narrative documentation. For story-driven games. Creates comprehensive narrative documentation.
**Sections covered:** **Sections covered:**
1. Story Foundation (premise, themes, tone) 1. Story Foundation (premise, themes, tone)
2. Story Structure (acts, beats, pacing) 2. Story Structure (acts, beats, pacing)
3. Characters (protagonists, antagonists, supporting, arcs) 3. Characters (protagonists, antagonists, supporting, arcs)
@ -120,13 +100,10 @@ For story-driven games. Creates comprehensive narrative documentation.
10. Appendices (relationship map, timeline) 10. Appendices (relationship map, timeline)
**Narrative Complexity Levels:** **Narrative Complexity Levels:**
- **Critical** — Story IS the game (visual novels, adventure games)
- **Critical** - Story IS the game (visual novels, adventure games) - **Heavy** — Deep narrative with gameplay (RPGs, story-driven action)
- **Heavy** - Deep narrative with gameplay (RPGs, story-driven action) - **Moderate** — Meaningful story supporting gameplay
- **Moderate** - Meaningful story supporting gameplay - **Light** — Minimal story, gameplay-focused
- **Light** - Minimal story, gameplay-focused
---
## Phase 3: Technical ## Phase 3: Technical
@ -137,11 +114,9 @@ For story-driven games. Creates comprehensive narrative documentation.
**Input:** GDD, Narrative Design (optional) **Input:** GDD, Narrative Design (optional)
**Output:** `{output_folder}/game-architecture.md` **Output:** `{output_folder}/game-architecture.md`
**Description:**
Technical architecture document covering engine selection, system design, and implementation approach. Technical architecture document covering engine selection, system design, and implementation approach.
**Sections covered:** **Sections covered:**
1. Executive Summary 1. Executive Summary
2. Engine/Framework Selection 2. Engine/Framework Selection
3. Core Systems Architecture 3. Core Systems Architecture
@ -153,8 +128,6 @@ Technical architecture document covering engine selection, system design, and im
9. Build and Deployment 9. Build and Deployment
10. Technical Risks and Mitigations 10. Technical Risks and Mitigations
---
## Phase 4: Production ## Phase 4: Production
Production workflows inherit from BMM and add game-specific overrides. Production workflows inherit from BMM and add game-specific overrides.
@ -166,11 +139,8 @@ Production workflows inherit from BMM and add game-specific overrides.
**Input:** GDD with epics **Input:** GDD with epics
**Output:** `{implementation_artifacts}/sprint-status.yaml` **Output:** `{implementation_artifacts}/sprint-status.yaml`
**Description:**
Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking. Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking.
---
### Sprint Status ### Sprint Status
**Command:** `sprint-status` **Command:** `sprint-status`
@ -178,14 +148,12 @@ Generates or updates sprint tracking from epic files. Sets up the sprint backlog
**Input:** `sprint-status.yaml` **Input:** `sprint-status.yaml`
**Output:** Sprint summary, risks, next action recommendation **Output:** Sprint summary, risks, next action recommendation
**Description:** Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run.
Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run. Supports three modes:
- **interactive** (default): Displays summary with menu options **Modes:**
- **validate**: Checks sprint-status.yaml structure - **interactive** (default) — Displays summary with menu options
- **data**: Returns raw data for other workflows - **validate** — Checks sprint-status.yaml structure
- **data** — Returns raw data for other workflows
---
### Create Story ### Create Story
@ -194,13 +162,10 @@ Summarizes sprint progress, surfaces risks (stale file, orphaned stories, storie
**Input:** GDD, Architecture, Epic context **Input:** GDD, Architecture, Epic context
**Output:** `{output_folder}/epics/{epic-name}/stories/{story-name}.md` **Output:** `{output_folder}/epics/{epic-name}/stories/{story-name}.md`
**Description:**
Creates implementable story drafts with acceptance criteria, tasks, and technical notes. Stories are marked ready-for-dev directly when created. Creates implementable story drafts with acceptance criteria, tasks, and technical notes. Stories are marked ready-for-dev directly when created.
**Validation:** `validate-create-story` **Validation:** `validate-create-story`
---
### Dev Story ### Dev Story
**Command:** `dev-story` **Command:** `dev-story`
@ -208,11 +173,8 @@ Creates implementable story drafts with acceptance criteria, tasks, and technica
**Input:** Story (ready for dev) **Input:** Story (ready for dev)
**Output:** Implemented code **Output:** Implemented code
**Description:**
Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion. Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion.
---
### Code Review ### Code Review
**Command:** `code-review` **Command:** `code-review`
@ -220,11 +182,8 @@ Implements story tasks following acceptance criteria. Uses TDD approach (red-gre
**Input:** Story (ready for review) **Input:** Story (ready for review)
**Output:** Review feedback, approved/needs changes **Output:** Review feedback, approved/needs changes
**Description:**
Thorough QA code review with game-specific considerations (performance, 60fps, etc.). Thorough QA code review with game-specific considerations (performance, 60fps, etc.).
---
### Retrospective ### Retrospective
**Command:** `epic-retrospective` **Command:** `epic-retrospective`
@ -232,11 +191,8 @@ Thorough QA code review with game-specific considerations (performance, 60fps, e
**Input:** Completed epic **Input:** Completed epic
**Output:** Retrospective document **Output:** Retrospective document
**Description:**
Facilitates team retrospective after epic completion. Captures learnings and improvements. Facilitates team retrospective after epic completion. Captures learnings and improvements.
---
### Correct Course ### Correct Course
**Command:** `correct-course` **Command:** `correct-course`
@ -244,25 +200,18 @@ Facilitates team retrospective after epic completion. Captures learnings and imp
**Input:** Current project state **Input:** Current project state
**Output:** Correction plan **Output:** Correction plan
**Description:**
Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments. Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments.
---
## Workflow Status ## Workflow Status
**Command:** `workflow-status` **Command:** `workflow-status`
**Agent:** All agents **Agent:** All agents
**Output:** Project status summary
**Description:**
Checks current project status across all phases. Shows completed documents, current phase, and next steps. Checks current project status across all phases. Shows completed documents, current phase, and next steps.
---
## Quick-Flow Workflows ## Quick-Flow Workflows
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md)** for detailed usage. Fast-track workflows that skip full planning phases. See [Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md) for detailed usage.
### Quick-Prototype ### Quick-Prototype
@ -271,17 +220,13 @@ Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](/d
**Input:** Idea or concept to test **Input:** Idea or concept to test
**Output:** Working prototype, playtest results **Output:** Working prototype, playtest results
**Description:**
Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish. Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish.
**Use when:** **Use when:**
- Testing if a mechanic is fun - Testing if a mechanic is fun
- Proving a concept before committing to design - Proving a concept before committing to design
- Experimenting with gameplay ideas - Experimenting with gameplay ideas
---
### Quick-Dev ### Quick-Dev
**Command:** `quick-dev` **Command:** `quick-dev`
@ -289,17 +234,13 @@ Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses
**Input:** Tech-spec, prototype, or direct instructions **Input:** Tech-spec, prototype, or direct instructions
**Output:** Implemented feature **Output:** Implemented feature
**Description:**
Flexible development workflow with game-specific considerations (performance, feel, integration). Flexible development workflow with game-specific considerations (performance, feel, integration).
**Use when:** **Use when:**
- Implementing features from tech-specs - Implementing features from tech-specs
- Building on successful prototypes - Building on successful prototypes
- Making changes that don't need full story workflow - Making changes that don't need full story workflow
---
## Quality Assurance Workflows ## Quality Assurance Workflows
Game testing workflows for automated testing, playtesting, and quality assurance across Unity, Unreal, and Godot. Game testing workflows for automated testing, playtesting, and quality assurance across Unity, Unreal, and Godot.
@ -311,22 +252,18 @@ Game testing workflows for automated testing, playtesting, and quality assurance
**Input:** Game project **Input:** Game project
**Output:** Configured test framework **Output:** Configured test framework
**Description:**
Initialize a production-ready test framework for your game engine: Initialize a production-ready test framework for your game engine:
- **Unity**: Unity Test Framework with Edit Mode and Play Mode tests - **Unity** — Unity Test Framework with Edit Mode and Play Mode tests
- **Unreal**: Unreal Automation system with functional tests - **Unreal** — Unreal Automation system with functional tests
- **Godot**: GUT (Godot Unit Test) framework - **Godot** — GUT (Godot Unit Test) framework
**Creates:** **Creates:**
- Test directory structure - Test directory structure
- Framework configuration - Framework configuration
- Sample unit and integration tests - Sample unit and integration tests
- Test documentation - Test documentation
---
### Test Design ### Test Design
**Command:** `test-design` **Command:** `test-design`
@ -334,7 +271,6 @@ Initialize a production-ready test framework for your game engine:
**Input:** GDD, Architecture **Input:** GDD, Architecture
**Output:** `{output_folder}/game-test-design.md` **Output:** `{output_folder}/game-test-design.md`
**Description:**
Creates comprehensive test scenarios covering: Creates comprehensive test scenarios covering:
- Core gameplay mechanics - Core gameplay mechanics
@ -344,8 +280,6 @@ Creates comprehensive test scenarios covering:
Uses GIVEN/WHEN/THEN format with priority levels (P0-P3). Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
---
### Automate ### Automate
**Command:** `automate` **Command:** `automate`
@ -353,15 +287,12 @@ Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
**Input:** Test design, game code **Input:** Test design, game code
**Output:** Automated test files **Output:** Automated test files
**Description:**
Generates engine-appropriate automated tests: Generates engine-appropriate automated tests:
- Unit tests for pure logic - Unit tests for pure logic
- Integration tests for system interactions - Integration tests for system interactions
- Smoke tests for critical path validation - Smoke tests for critical path validation
---
### Playtest Plan ### Playtest Plan
**Command:** `playtest-plan` **Command:** `playtest-plan`
@ -369,7 +300,6 @@ Generates engine-appropriate automated tests:
**Input:** Build, test objectives **Input:** Build, test objectives
**Output:** `{output_folder}/playtest-plan.md` **Output:** `{output_folder}/playtest-plan.md`
**Description:**
Creates structured playtesting sessions: Creates structured playtesting sessions:
- Session structure (pre/during/post) - Session structure (pre/during/post)
@ -378,12 +308,9 @@ Creates structured playtesting sessions:
- Analysis templates - Analysis templates
**Playtest Types:** **Playtest Types:**
- **Internal** — Team validation
- Internal (team validation) - **External** — Unbiased feedback
- External (unbiased feedback) - **Focused** — Specific feature testing
- Focused (specific feature testing)
---
### Performance Test ### Performance Test
@ -392,7 +319,6 @@ Creates structured playtesting sessions:
**Input:** Platform targets **Input:** Platform targets
**Output:** `{output_folder}/performance-test-plan.md` **Output:** `{output_folder}/performance-test-plan.md`
**Description:**
Designs performance testing strategy: Designs performance testing strategy:
- Frame rate targets per platform - Frame rate targets per platform
@ -401,8 +327,6 @@ Designs performance testing strategy:
- Benchmark scenarios - Benchmark scenarios
- Profiling methodology - Profiling methodology
---
### Test Review ### Test Review
**Command:** `test-review` **Command:** `test-review`
@ -410,7 +334,6 @@ Designs performance testing strategy:
**Input:** Existing test suite **Input:** Existing test suite
**Output:** `{output_folder}/test-review-report.md` **Output:** `{output_folder}/test-review-report.md`
**Description:**
Reviews test quality and coverage: Reviews test quality and coverage:
- Test suite metrics - Test suite metrics
@ -418,8 +341,6 @@ Reviews test quality and coverage:
- Coverage gaps - Coverage gaps
- Recommendations - Recommendations
---
## Utility Workflows ## Utility Workflows
### Party Mode ### Party Mode
@ -427,40 +348,21 @@ Reviews test quality and coverage:
**Command:** `party-mode` **Command:** `party-mode`
**Agent:** All agents **Agent:** All agents
**Description:**
Brings multiple agents together for collaborative discussion on complex decisions. Brings multiple agents together for collaborative discussion on complex decisions.
---
### Advanced Elicitation ### Advanced Elicitation
**Command:** `advanced-elicitation` **Command:** `advanced-elicitation`
**Agent:** All agents (web only) **Agent:** All agents (web only)
**Description:**
Deep exploration techniques to challenge assumptions and surface hidden requirements. Deep exploration techniques to challenge assumptions and surface hidden requirements.
---
## Standalone BMGD Workflows ## Standalone BMGD Workflows
BMGD Phase 4 workflows are standalone implementations tailored for game development: :::note[Implementation Detail]
BMGD Phase 4 workflows are standalone implementations tailored for game development. They are self-contained with game-specific logic, templates, and checklists — no dependency on BMM workflow files.
:::
```yaml ```yaml
workflow: '{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml' workflow: '{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml'
``` ```
This means:
1. BMGD workflows are self-contained with game-specific logic
2. Game-focused templates, checklists, and instructions
3. No dependency on BMM workflow files
---
## Next Steps
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
- **[Quick-Flow Guide](/docs/how-to/workflows/bmgd-quick-flow.md)** - Rapid prototyping and development
- **[Agents Guide](/docs/explanation/game-dev/agents.md)** - Agent reference
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Game type templates

23
docs/reference/workflows/core-workflows.md
View File

@ -2,32 +2,31 @@
title: "Core Workflows" title: "Core Workflows"
--- ---
Domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent.
Core Workflows are domain-agnostic workflows that can be utilized by any BMad-compliant module, workflow, or agent. These workflows are installed by default and available at any time. ## Party Mode
## Available Core Workflows Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage multiple specialized perspectives simultaneously — each agent maintains their unique personality, expertise, and communication style.
### [Party Mode](/docs/explanation/features/party-mode.md) See [Party Mode](/docs/explanation/features/party-mode.md) for detailed usage.
Orchestrate dynamic multi-agent conversations with your entire BMad team. Engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style. ## Brainstorming
### [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights.
Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights that are already within you. See [Brainstorming Techniques](/docs/explanation/features/brainstorming-techniques.md) for detailed usage.
### [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) ## Advanced Elicitation
Push the LLM to rethink its work through 50+ reasoning methods—the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated, essentially "LLM brainstorming" to find better approaches and uncover improvements. Push the LLM to rethink its work through 50+ reasoning methods — the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated.
--- See [Advanced Elicitation](/docs/explanation/features/advanced-elicitation.md) for detailed usage.
## Workflow Integration ## Workflow Integration
Core Workflows are designed to be invoked and configured by other modules. When called from another workflow, they accept contextual parameters to customize the session: Core Workflows accept contextual parameters when called from other modules:
- **Topic focus** — Direct the session toward a specific domain or question - **Topic focus** — Direct the session toward a specific domain or question
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime - **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation - **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
- **Output goals** — Define what the final output needs to accomplish - **Output goals** — Define what the final output needs to accomplish
This allows modules to leverage these workflows' capabilities while maintaining focus on their specific domain and objectives.

65
docs/reference/workflows/document-project.md
View File

@ -1,74 +1,73 @@
--- ---
title: "Document Project Workflow - Technical Reference" title: "Document Project Workflow"
--- ---
Analyzes and documents brownfield projects for AI-assisted development.
**Module:** BMM (BMad Method Module) :::note[Quick Facts]
- **Module:** BMM (BMad Method Module)
- **Command:** `*document-project`
- **Agents:** Analyst, Technical Writer
- **Output:** Master index + documentation files in `{output_folder}`
:::
## Purpose ## Purpose
Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type. Scans your codebase, architecture, and patterns to create comprehensive reference documentation. Generates a master index and multiple documentation files tailored to your project structure and type.
## How to Invoke ## How to Invoke
```bash ```bash
/bmad:bmm:workflows:document-project *document-project
``` ```
---
## Scan Levels ## Scan Levels
Choose the right scan depth for your needs: Choose the right depth for your needs:
### 1. Quick Scan (Default) ### Quick Scan (Default)
**What it does:** Pattern-based analysis without reading source files **What it does:** Pattern-based analysis without reading source files
**Reads:** Config files, package manifests, directory structure, README
**Use when:**
**Reads:** Config files, package manifests, directory structure, README
**Use when:**
- You need a fast project overview - You need a fast project overview
- Initial understanding of project structure - Initial understanding of project structure
- Planning next steps before deeper analysis - Planning next steps before deeper analysis
**Does NOT read:** Source code files (`_.js`, `_.ts`, `_.py`, `_.go`, etc.) ### Deep Scan
### 2. Deep Scan
**What it does:** Reads files in critical directories based on project type **What it does:** Reads files in critical directories based on project type
**Reads:** Files in critical paths defined by documentation requirements
**Use when:**
**Reads:** Files in critical paths defined by documentation requirements
**Use when:**
- Creating comprehensive documentation for brownfield PRD - Creating comprehensive documentation for brownfield PRD
- Need detailed analysis of key areas - Need detailed analysis of key areas
- Want balance between depth and speed - Want balance between depth and speed
**Example:** For a web app, reads controllers/, models/, components/, but not every utility file ### Exhaustive Scan
### 3. Exhaustive Scan
**What it does:** Reads ALL source files in project **What it does:** Reads ALL source files in project
**Reads:** Every source file (excludes node_modules, dist, build, .git)
**Use when:**
**Reads:** Every source file (excludes node_modules, dist, build, .git)
**Use when:**
- Complete project analysis needed - Complete project analysis needed
- Migration planning requires full understanding - Migration planning requires full understanding
- Detailed audit of entire codebase - Detailed audit of entire codebase
- Deep technical debt assessment
**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice) :::caution[Deep-Dive Mode]
Deep-dive mode always uses exhaustive scan — no choice of scan level.
--- :::
## Resumability ## Resumability
The workflow can be interrupted and resumed without losing progress: The workflow can be interrupted and resumed without losing progress:
- **State Tracking:** Progress saved in `project-scan-report.json` - **State Tracking** — Progress saved in `project-scan-report.json`
- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old) - **Auto-Detection** — Workflow detects incomplete runs (<24 hours old)
- **Resume Prompt:** Choose to resume or start fresh - **Resume Prompt** — Choose to resume or start fresh
- **Step-by-Step:** Resume from exact step where interrupted - **Step-by-Step** — Resume from exact step where interrupted
- **Archiving:** Old state files automatically archived - **Archiving** — Old state files automatically archived
**Related Documentation:**
- [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
- [Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)

9
docs/reference/workflows/index.md
View File

@ -3,14 +3,13 @@ title: "Workflows Reference"
description: Reference documentation for BMad Method workflows description: Reference documentation for BMad Method workflows
--- ---
Reference documentation for all BMad Method workflows.
Complete reference documentation for all BMad Method workflows.
## Core Workflows ## Core Workflows
- [Core Workflows](/docs/reference/workflows/core-workflows.md) - Domain-agnostic workflows available to all modules - [Core Workflows](/docs/reference/workflows/core-workflows.md) — Domain-agnostic workflows available to all modules
- [Document Project](/docs/reference/workflows/document-project.md) - Brownfield project documentation workflow - [Document Project](/docs/reference/workflows/document-project.md) — Brownfield project documentation
## Module-Specific Workflows ## Module-Specific Workflows
- [BMGD Workflows](/docs/reference/workflows/bmgd-workflows.md) - Game development workflows - [BMGD Workflows](/docs/reference/workflows/bmgd-workflows.md) — Game development workflows