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 branch 'main' into feat/bug-tracking-workflow

This commit is contained in:
Brian 2026-01-15 11:19:21 +08:00 committed by GitHub
parent 49d284179a dcd581c84a
commit 02f2955c09
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
344 changed files with 19792 additions and 10912 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
CHANGELOG.md
View File

@ -1,5 +1,158 @@
# Changelog
## [6.0.0-alpha.23]
**Release: January 11, 2026**
### 🌟 Key Highlights
1. **Astro/Starlight Documentation Platform**: Complete migration from Docusaurus to modern Astro+Starlight for superior performance and customization
2. **Diataxis Framework Implementation**: Professional documentation restructuring with tutorials, how-to guides, explanations, and references
3. **Workflow Creator & Validator**: Powerful new tools for workflow creation with subprocess support and PRD validation
4. **TEA Documentation Expansion**: Comprehensive testing documentation with cheat sheets, MCP enhancements, and API testing patterns
5. **Brainstorming Revolution**: Research-backed procedural rigor with 100+ idea goal and anti-bias protocols
6. **Cursor IDE Modernization**: Refactored from rules-based to command-based architecture for better IDE integration
### 📚 Documentation Platform Revolution
**Astro/Starlight Migration:**
- **From Docusaurus to Astro**: Complete platform migration for improved performance, better customization, and modern tooling
- **Starlight Theme**: Professional documentation theme with dark mode default and responsive design
- **Build Pipeline Overhaul**: New build-docs.js orchestrates link checking, artifact generation, and Astro build
- **LLM-Friendly Documentation**: Generated llms.txt and llms-full.txt for AI agent discoverability
- **Downloadable Source Bundles**: bmad-sources.zip and bmad-prompts.zip for offline use
**Diataxis Framework Implementation:**
- **Four Content Types**: Professional separation into tutorials, how-to guides, explanations, and references
- **21 Files Migrated**: Phase 1 migration of core documentation to Diataxis structure
- **42+ Focused Documents**: Phase 2 split of large legacy files into manageable pieces
- **FAQ Restructuring**: 7 topic-specific FAQ files with standardized format
- **Tutorial Style Guide**: Comprehensive documentation standards for consistent content creation
**Link Management & Quality:**
- **Site-Relative Links**: Converted 217 links to repo-relative format (/docs/path/file.md)
- **Link Validation Tools**: New validate-doc-links.js and fix-doc-links.js for maintaining link integrity
- **Broken Link Fixes**: Resolved ~50 broken internal links across documentation
- **BMad Acronym Standardization**: Consistent use of "BMad" (Breakthrough Method of Agile AI Driven Development)
- **SEO Optimization**: Absolute URLs in AI meta tags for better web crawler discoverability
### 🔧 Workflow Creator & Validator (Major Feature)
**Workflow Creation Tool:**
- **Subprocess Support**: Advanced workflows can now spawn subprocesses for complex operations
- **PRD Validation Step**: New validation step ensures PRD quality before workflow execution
- **Trimodal Workflow Creation**: Three-mode workflow generation system
- **Quadrivariate Module Workflow**: Four-variable workflow architecture for enhanced flexibility
- **Path Violation Checks**: Validator ensures workflows don't violate path constraints
- **Max Parallel Mode POC**: Proof-of-concept for parallel workflow validation
**Workflow Quality Improvements:**
- **PRD Trimodal Compliance**: PRD workflow now follows trimodal standards
- **Standardized Step Formatting**: Consistent markdown formatting across workflow and PRD steps
- **Better Suggested Next Steps**: Improved workflow completion guidance
- **Variable Naming Standardization**: {project_root} → {project-root} across all workflows
### 🧪 TEA Documentation Expansion
**Comprehensive Testing Guides:**
- **Cheat Sheets**: Quick reference guides for common testing scenarios
- **MCP Enhancements**: Model Context Protocol improvements for testing workflows
- **API Testing Patterns**: Best practices for API testing documentation
- **Design Philosophy Callout**: Clear explanation of TEA's design principles
- **Context Engineering Glossary**: New glossary entry defining context engineering concepts
- **Fragment Count Updates**: Accurate documentation of TEA workflow components
- **Playwright Utils Examples**: Updated code examples for playwright-utils integration
### 💡 Brainstorming Workflow Overhaul
**Research-Backed Procedural Rigor:**
- **100+ Idea Goal**: Emphasis on quantity-first approach to unlock better quality ideas
- **Anti-Bias Protocol**: Domain pivot every 10 ideas to reduce cognitive biases
- **Chain-of-Thought Requirements**: Reasoning before idea generation
- **Simulated Temperature**: Prompts for higher divergence in ideation
- **Standardized Idea Format**: Quality control template for consistent output
- **Energy Checkpoints**: Multiple continuation options to maintain creative flow
**Exploration Menu Improvements:**
- **Letter-Based Navigation**: [K/T/A/B/C] options instead of numbers for clarity
- **Keep/Try/Advanced/Break/Continue**: Clear action options for idea refinement
- **Universal Facilitation Rules**: Consistent guidelines across all brainstorming steps
- **Quality Growth Enforcement**: Balance between quantity and quality metrics
### 🖥️ Cursor IDE Modernization
**Command-Based Architecture:**
- **From Rules to Commands**: Complete refactor from rules-based to command-based system
- **Command Generation**: Automatic generation of task and tool commands
- **Commands Directory**: New `.cursor/commands/bmad/` structure for generated commands
- **Cleanup Integration**: Automatic cleanup of old BMAD commands alongside rules
- **Enhanced Logging**: Better feedback on agents, tasks, tools, and workflow commands generated
### 🤖 Agent System Improvements
**Agent Builder & Validation:**
- **hasSidecar Field**: All agents now indicate sidecar support (true/false)
- **Validation Enforcement**: hasSidecar now required in agent validation
- **Better Brownfield Documentation**: Improved brownfield project documentation
- **Agent Builder Updates**: Agent builder now uses hasSidecar field
- **Agent Editor Integration**: Editor workflow respects hasSidecar configuration
### 🐛 Bug Fixes & Quality Improvements
**Critical Fixes:**
- **Windows Line Endings**: Resolved CRLF issues causing cross-platform problems
- **Code-Review File Filtering**: Fixed code-review picking up non-application files
- **ERR_REQUIRE_ESM Resolution**: Dynamic import for inquirer v9+ compatibility
- **Project-Context Conflicts**: Allow full project-context usage with conflict precedence
- **Workflow Paths**: Fixed paths for workflow and sprint status files
- **Missing Scripts**: Fixed missing scripts from installation
**Workflow & Variable Fixes:**
- **Variable Naming**: Standardized from {project_root} to {project-root} across CIS, BMGD, and BMM modules
- **Workflow References**: Fixed broken .yaml → .md workflow references
- **Advanced Elicitation Variables**: Fixed undefined variables in brainstorming
- **Dependency Format**: Corrected dependency format and added missing frontmatter
**Code Quality:**
- **Dependency Updates**: Bumped qs from 6.14.0 to 6.14.1
- **CodeRabbit Integration**: Enabled auto-review on new PRs
- **TEA Fragment Counts**: Updated fragment counts for accuracy
- **Documentation Links**: Fixed Discord channel references (#general-dev → #bmad-development)
### 🚀 Installation & CLI Improvements
**Installation Enhancements:**
- **Workflow Exclusion**: Ability to exclude workflows from being added as commands
- **Example Workflow Protection**: Example workflow in workflow builder now excluded from tools
- **CNAME Configuration**: Added CNAME file for custom domain support
- **Script Fixes**: All scripts now properly included in installation
### 📊 Statistics
- **27 commits** since alpha.22
- **217 documentation links** converted to site-relative format
- **42+ focused documents** created from large legacy files
- **7 topic-specific FAQ files** with standardized formatting
- **Complete documentation platform** migrated from Docusaurus to Astro/Starlight
- **Major workflow tools** added: Creator, Validator with subprocess support
- **Brainstorming workflow** overhauled with research-backed rigor
---
## [6.0.0-alpha.22]
**Release: December 31, 2025**

242
README.md
View File

@ -1,237 +1,91 @@
# BMad Method & BMad Core
# BMad Method
[![Stable Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=stable)](https://www.npmjs.com/package/bmad-method)
[![Alpha Version](https://img.shields.io/npm/v/bmad-method/alpha?color=orange&label=alpha)](https://www.npmjs.com/package/bmad-method)
[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
---
**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.
<div align="center">
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
## 🎉 NEW: BMAD V6 Installer - Create & Share Custom Content!
## Why BMad?
The completely revamped **BMAD V6 installer** now includes built-in support for creating, installing, and sharing custom modules, agents, workflows, templates, and tools! Build your own AI solutions or share them with your team - and real soon, with the whole BMad Community througha verified community sharing portal!
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.
**✨ What's New:**
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
- 📦 **Streamlined Custom Module Installation** - Package your custom content as installable modules
- 🤖 **Agent & Workflow Sharing** - Distribute standalone agents and workflows
- 🔄 **Unitary Module Support** - Install individual components without full modules
- ⚙️ **Dependency Management** - Automatic handling of module dependencies
- 🛡️ **Update-Safe Customization** - Your custom content persists through updates
## Quick Start
**📚 Learn More:**
- [**Custom Content Overview**](http://docs.bmad-method.org/explanation/bmad-builder/custom-content-types/) - Discover all supported content types
- [**Installation Guide**](http://docs.bmad-method.org/how-to/installation/install-custom-modules/) - Learn to create and install custom content
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
</div>
---
## AI-Driven Agile Development That Scales From Bug Fixes to Enterprise
**Build More, Architect Dreams** (BMAD) with **21 specialized AI agents** across 4 official modules, and **50+ guided workflows** that adapt to your project's complexity—from quick bug fixes to enterprise platforms, and new step file workflows that allow for incredibly long workflows to stay on the rails longer than ever before!
Additionally - when we say 'Build More, Architect Dreams' - we mean it! The BMad Builder has landed, and now as of Alpha.15 is fully supported in the installation flow via NPX - custom stand along agents, workflows and the modules of your dreams! The community forge will soon open, endless possibility awaits!
> **🚀 v6 is a MASSIVE upgrade from v4!** Complete architectural overhaul, scale-adaptive intelligence, visual workflows, and the powerful BMad Core framework. v4 users: this changes everything. [See what's new →](#whats-new-in-v6)
> **📌 v6 Alpha Status:** Near-beta quality with vastly improved stability. Documentation is being finalized. New videos coming soon to [BMadCode YouTube](https://www.youtube.com/@BMadCode).
## 🎯 Why BMad Method?
Unlike generic AI coding assistants, BMad Method provides **structured, battle-tested workflows** powered by specialized agents who understand agile development. Each agent has deep domain expertise—from product management to architecture to testing—working together seamlessly.
**✨ Key Benefits:**
- **Scale-Adaptive Intelligence** - Automatically adjusts planning depth from bug fixes to enterprise systems
- **Complete Development Lifecycle** - Analysis → Planning → Architecture → Implementation
- **Specialized Expertise** - 19 agents with specific roles (PM, Architect, Developer, UX Designer, etc.)
- **Proven Methodologies** - Built on agile best practices with AI amplification
- **IDE Integration** - Works with Claude Code, Cursor, Windsurf, VS Code
## 🏗️ The Power of BMad Core
**BMad Method** is actually a sophisticated module built on top of **BMad Core** (**C**ollaboration **O**ptimized **R**eflection **E**ngine). This revolutionary architecture means:
- **BMad Core** provides the universal framework for human-AI collaboration
- **BMad Method** leverages Core to deliver agile development workflows
- **BMad Builder** lets YOU create custom modules as powerful as BMad Method itself
With **BMad Builder**, you can architect both simple agents and vastly complex domain-specific modules (legal, medical, finance, education, creative) that will soon be sharable in an **official community marketplace**. Imagine building and sharing your own specialized AI team!
## 📊 See It In Action
<p align="center">
<img src="./docs/tutorials/getting-started/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
</p>
<p align="center">
<em>Complete BMad Method workflow showing all phases, agents, and decision points</em>
</p>
## 🚀 Get Started in 3 Steps
### 1. Install BMad Method
**Prerequisites**: [Node.js](https://nodejs.org) v20+
```bash
# Install v6 RECOMMENDED
npx bmad-method@alpha install
```
Follow the installer prompts to configure your project. Then run:
```bash
# Install v4 Legacy (not recommended if starting fresh)
npx bmad-method install
# OR
npx bmad-method@latest install
```
### 2. Initialize Your Project
Load any agent in your IDE and run:
```
*workflow-init
```
This analyzes your project and recommends the right workflow track.
This analyzes your project and recommends a track:
### 3. Choose Your Track
| Track | Best For | Time to First Story |
| --------------- | ------------------------- | ------------------- |
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
| **BMad Method** | Products and platforms | ~15 minutes |
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
BMad Method adapts to your needs with three intelligent tracks:
## Modules
| Track | Use For | Planning | Time to Start |
| ----------------- | ------------------------- | ----------------------- | ------------- |
| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
| Module | Purpose |
| ------------------------------------- | -------------------------------------------------------- |
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
> **Not sure?** Run `*workflow-init` and let BMad analyze your project goal.
## Documentation
## 🔄 How It Works: 4-Phase Methodology
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
BMad Method guides you through a proven development lifecycle:
1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions
2. **📝 Planning** - Create PRDs, tech specs, or game design documents
3. **🏗️ Solutioning** - Design architecture, UX, and technical approach
4. **⚡ Implementation** - Story-driven development with continuous validation
Each phase has specialized workflows and agents working together to deliver exceptional results.
## 🤖 Meet Your Team
**12 Specialized Agents** working in concert:
| Development | Architecture | Product | Leadership |
| ----------- | -------------- | ----------- | ------------ |
| Developer | Architect | PM | Scrum Master |
| UX Designer | Test Architect | Analyst | BMad Master |
| | | Tech Writer | |
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities.
Each agent brings deep expertise and can be customized to match your team's style.
## 📦 What's Included
### Official Modules
- **BMad Method (BMM)** - Complete agile development framework
- 12 specialized agents
- 34 workflows across 4 phases
- Stand Along Quick Spec Flow for a streamlined simple implementation process
- [→ Documentation Hub](http://docs.bmad-method.org/explanation/bmm/)
- **BMad Builder (BMB)** - Create custom agents and workflows
- Build anything from simple agents to complex modules
- Create domain-specific solutions (legal, medical, finance, education)
- [→ Builder Guide](http://docs.bmad-method.org/explanation/bmad-builder/)
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
- Brainstorming, design thinking, storytelling
- 5 creative facilitation workflows
- [→ Creative Workflows](http://docs.bmad-method.org/explanation/creative-intelligence/)
### Key Features
- **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles
- **🌐 Multi-Language Support** - Separate settings for communication and code output
- **📄 Document Sharding** - 90% token savings for large projects
- **🔄 Update-Safe** - Your customizations persist through updates
- **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems
## 📚 Documentation
### Quick Links
- **[Quick Start Guide](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)** - 15-minute introduction
- **[Complete BMM Documentation](http://docs.bmad-method.org/explanation/bmm/)** - All guides and references
- **[Agent Customization](http://docs.bmad-method.org/how-to/customization/customize-agents/)** - Personalize your agents
- **[All Documentation](http://docs.bmad-method.org/)** - Complete documentation index
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)
### For v4 Users
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
- **[v4 to v6 Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)**
## 💬 Community & Support
## Community
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon)
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
- [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
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
## 🛠️ Development
## Support BMad
If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
BMad is free for everyone — and always will be. If you'd like to support development:
## What's New in v6
- ⭐ [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)
**v6 represents a complete architectural revolution from v4:**
## Contributing
### 🚀 Major Upgrades
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
- **BMad Core Framework** - Modular architecture enabling custom domain solutions
- **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise
- **Visual Workflows** - Beautiful SVG diagrams showing complete methodology
- **BMad Builder Module** - Create and share your own AI agent teams
- **50+ Workflows** - Up from 20 in v4, covering every development scenario
- **19 Specialized Agents** - Enhanced with customizable personalities and expertise
- **Update-Safe Customization** - Your configs persist through all updates
- **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini
- **Multi-Language Support** - Separate settings for communication and code
- **Document Sharding** - 90% token savings for large projects
## License
### 🔄 For v4 Users
- **[Comprehensive Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)** - Step-by-step migration
- **[v4 Documentation Archive](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** - Legacy reference
- Backwards compatibility where possible
- Smooth migration path with installer detection
## 📄 License
MIT License - See [LICENSE](LICENSE) for details.
**Trademarks:** BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.
Supported by:&nbsp;&nbsp;<a href="https://m.do.co/c/00f11bd932bb"><img src="https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg" height="24" alt="DigitalOcean" style="vertical-align: middle;"></a>
MIT License — see [LICENSE](LICENSE) for details.
---
<p align="center">
<a href="https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors">
<img src="https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD" alt="Contributors">
</a>
</p>
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC.
<p align="center">
<sub>Built with ❤️ for the human-AI collaboration community</sub>
</p>
[![Contributors](https://contrib.rocks/image?repo=bmad-code-org/BMAD-METHOD)](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)

85
SECURITY.md Normal file
View File

@ -0,0 +1,85 @@
# Security Policy
## Supported Versions
We release security patches for the following versions:
| Version | Supported |
| ------- | ------------------ |
| Latest | :white_check_mark: |
| < Latest | :x: |
We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.
## Reporting a Vulnerability
We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly.
### How to Report
**Do NOT report security vulnerabilities through public GitHub issues.**
Instead, please report them via one of these methods:
1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report.
2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj).
### What to Include
Please include as much of the following information as possible:
- Type of vulnerability (e.g., prompt injection, path traversal, etc.)
- Full paths of source file(s) related to the vulnerability
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if available)
- Impact assessment of the vulnerability
### Response Timeline
- **Initial Response**: Within 48 hours of receiving your report
- **Status Update**: Within 7 days with our assessment
- **Resolution Target**: Critical issues within 30 days; other issues within 90 days
### What to Expect
1. We will acknowledge receipt of your report
2. We will investigate and validate the vulnerability
3. We will work on a fix and coordinate disclosure timing with you
4. We will credit you in the security advisory (unless you prefer to remain anonymous)
## Security Scope
### In Scope
- Vulnerabilities in BMad Method core framework code
- Security issues in agent definitions or workflows that could lead to unintended behavior
- Path traversal or file system access issues
- Prompt injection vulnerabilities that bypass intended agent behavior
- Supply chain vulnerabilities in dependencies
### Out of Scope
- Security issues in user-created custom agents or modules
- Vulnerabilities in third-party AI providers (Claude, GPT, etc.)
- Issues that require physical access to a user's machine
- Social engineering attacks
- Denial of service attacks that don't exploit a specific vulnerability
## Security Best Practices for Users
When using BMad Method:
1. **Review Agent Outputs**: Always review AI-generated code before executing it
2. **Limit File Access**: Configure your AI IDE to limit file system access where possible
3. **Keep Updated**: Regularly update to the latest version
4. **Validate Dependencies**: Review any dependencies added by generated code
5. **Environment Isolation**: Consider running AI-assisted development in isolated environments
## Acknowledgments
We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories.
---
Thank you for helping keep BMad Method and our community safe.

2
docs/404.md
View File

@ -6,4 +6,4 @@ template: splash
The page you're looking for doesn't exist or has been moved.
[Return to Home](/)
[Return to Home](/docs/index.md)

467
docs/_STYLE_GUIDE.md
View File

@ -1,6 +1,8 @@
# 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.
## Quick Principles
@ -9,6 +11,27 @@ Internal guidelines for maintaining consistent, high-quality documentation acros
3. **Strategic visuals** — Use admonitions, tables, and diagrams purposefully
4. **Scannable content** — Headers, lists, and callouts help readers find what they need
## Validation Steps
Before submitting documentation changes, run these checks from the repo root:
1. **Fix link format** — Convert relative links (`./`, `../`) to site-relative paths (`/path/`)
```bash
npm run docs:fix-links # Preview changes
npm run docs:fix-links -- --write # Apply changes
```
2. **Validate links** — Check all links point to existing files
```bash
npm run docs:validate-links # Preview issues
npm run docs:validate-links -- --write # Auto-fix where possible
```
3. **Build the site** — Verify no build errors
```bash
npm run docs:build
```
## Tutorial Structure
Every tutorial should follow this structure:
@ -33,6 +56,423 @@ Every tutorial should follow this structure:
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
### Avoid
@ -223,16 +663,33 @@ Instead, break into separate sections or use an admonition for context.
## FAQ Sections
Format as bold question followed by answer paragraph:
Use a TOC with jump links, `###` headers for questions, and direct answers:
```md
**Do I always need architecture?**
## Questions
- [Do I always need architecture?](#do-i-always-need-architecture)
- [Can I change my plan later?](#can-i-change-my-plan-later)
### Do I always need architecture?
Only for BMad Method and Enterprise tracks. Quick Flow skips to implementation.
**Can I change my plan later?**
### Can I change my plan later?
Yes. The SM agent has a `correct-course` workflow for handling scope changes.
**Have a question not answered here?** Please [open an issue](...) or ask in [Discord](...) so we can add it!
```
### FAQ Guidelines
- **TOC at top** — Jump links under `## Questions` for quick navigation
- **`###` headers** — Questions are scannable and linkable (no `Q:` prefix)
- **Direct answers** — No `**A:**` prefix, just the answer
- **No "Related Documentation"** — Sidebar handles navigation; avoid repetitive links
- **End with CTA** — "Have a question not answered here?" with issue/Discord links
## Folder Structure Blocks
Show project structure in "What You've Accomplished":

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

@ -2,12 +2,13 @@
title: "Workflow Customization Guide"
---
Customize and optimize workflows with step replacement and hooks.
## 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
@ -22,12 +23,8 @@ Workflow customization will allow you to:
While workflow customization is in development, you can:
- **Create Custom Workflows** - Use the BMAD Builder to create entirely new workflows
- **Customize Agents** - Modify agent behavior using [Agent Customization](./customize-agents.md)
- **Create Custom Workflows** - Use the BMad Builder to create entirely new workflows
- **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
---
**In the meantime:** Learn how to [create custom workflows](../../explanation/bmad-builder/index.md) from scratch.
[← Back to Customization](./index.md)
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.

0
docs/tutorials/getting-started/getting-started-bmadv4.md → docs/_archive/getting-started-bmadv4.md
View File

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"
---
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
Use workflow vendoring and inheritance to share or reutilize workflows across modules.
## 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.)
## 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.
@ -36,7 +39,11 @@ Some possible examples could be:
- Sprint Planning
- 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.

8
docs/downloads.md
View File

@ -2,13 +2,13 @@
title: Downloads
---
Download BMAD Method resources for offline use, AI training, or integration.
Download BMad Method resources for offline use, AI training, or integration.
## Source Bundles
| File | Description |
|------|-------------|
| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMAD source files |
| **[bmad-sources.zip](/downloads/bmad-sources.zip)** | Complete BMad source files |
| **[bmad-prompts.zip](/downloads/bmad-prompts.zip)** | Agent and workflow prompts only |
## LLM-Optimized Files
@ -54,7 +54,7 @@ npx bmad-method@alpha install
## API Access
For programmatic access to BMAD documentation:
For programmatic access to BMad documentation:
```bash
# Get documentation index
@ -66,7 +66,7 @@ curl https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
## Contributing
Want to improve BMAD Method? Check out:
Want to improve BMad Method? Check out:
- [Contributing Guide](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)
- [GitHub Repository](https://github.com/bmad-code-org/BMAD-METHOD)

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

@ -2,23 +2,24 @@
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`
**Icon:** 🚀
**Module:** BMM
---
:::note[Agent Info]
- **Agent ID:** `_bmad/bmm/agents/quick-flow-solo-dev.md`
- **Icon:** 🚀
- **Module:** BMM
:::
## Overview
Barry is the elite solo developer who lives and breathes the BMAD Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev.
Barry is the elite solo developer who lives and breathes the BMad Quick Flow workflow. He takes projects from concept to deployment with ruthless efficiency - no handoffs, no delays, just pure focused development. Barry architects specs, writes the code, and ships features faster than entire teams. When you need it done right and done now, Barry's your dev.
### Agent Persona
**Name:** Barry
**Title:** Quick Flow Solo Dev
**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMAD Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams.
**Identity:** Barry is an elite developer who thrives on autonomous execution. He lives and breathes the BMad Quick Flow workflow, taking projects from concept to deployment with ruthless efficiency. No handoffs, no delays - just pure, focused development. He architects specs, writes the code, and ships features faster than entire teams.
**Communication Style:** Direct, confident, and implementation-focused. Uses tech slang and gets straight to the point. No fluff, just results. Every response moves the project forward.
@ -31,15 +32,13 @@ Barry is the elite solo developer who lives and breathes the BMAD Quick Flow wor
- Documentation happens alongside development, not after
- Ship early, ship often
---
## 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.
### 1. **create-tech-spec**
### 1. **quick-spec**
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.yaml`
- **Workflow:** `_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md`
- **Description:** Architect a technical spec with implementation-ready stories
- **Use when:** You need to transform requirements into a buildable spec
@ -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
- **Use when:** You need collaborative problem-solving or specialized expertise
---
## When to Use Barry
### Ideal Scenarios
@ -81,15 +78,13 @@ Barry owns the entire BMAD Quick Flow path, providing a streamlined 3-step devel
- **Proof of Concepts** - Rapid prototyping with production-quality code
- **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:
```mermaid
flowchart LR
A[Requirements] --> B[create-tech-spec]
A[Requirements] --> B[quick-spec]
B --> C[Tech Spec]
C --> D[quick-dev]
D --> E[Implementation]
@ -107,7 +102,7 @@ flowchart LR
style H fill:#e0f2f1
```
### Step 1: Technical Specification (`create-tech-spec`)
### Step 1: Technical Specification (`quick-spec`)
**Goal:** Transform user requirements into implementation-ready technical specifications
@ -180,8 +175,6 @@ flowchart LR
- Security considerations
- Maintainability and documentation
---
## Collaboration with Other Agents
### Natural Partnerships
@ -201,8 +194,6 @@ In party mode, Barry often acts as:
- **Performance Optimizer** - Ensuring scalable solutions
- **Code Review Authority** - Validating technical approaches
---
## Tips for Working with Barry
### For Best Results
@ -228,8 +219,6 @@ In party mode, Barry often acts as:
4. **Over-planning** - I excel at rapid, pragmatic development
5. **Not Using Party Mode** - Missing collaborative insights for complex problems
---
## Example Workflow
```bash
@ -237,7 +226,7 @@ In party mode, Barry often acts as:
/bmad:bmm:agents:quick-flow-solo-dev
# Create a tech spec
> create-tech-spec
> quick-spec
# Quick implementation
> quick-dev tech-spec-auth.md
@ -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
```
---
## 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](../../tutorials/getting-started/getting-started-bmadv6.md)** - Getting started with BMM
- **[Agents Guide](../../explanation/core-concepts/agent-roles.md)** - Complete agent reference
- **[Four Phases](../../explanation/architecture/four-phases.md)** - Understanding development tracks
- **[Workflow Implementation](../../how-to/workflows/run-sprint-planning.md)** - Implementation workflows
- **[Party Mode](../../explanation/features/party-mode.md)** - Multi-agent collaboration
### When should I use Barry vs other agents?
---
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?**
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.
No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
**Q: Is the code review step mandatory?**
A: No, it's optional but highly recommended for critical features, team projects, or when learning best practices.
### Can I skip the tech spec step?
**Q: Can I skip the tech spec step?**
A: Yes, the quick-dev workflow accepts direct instructions. However, tech specs are recommended for complex features or team collaboration.
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?**
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.
### How does Barry differ from the Dev agent?
**Q: Can Barry handle enterprise-scale projects?**
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.
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.
---
### 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`
:::

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

@ -1,28 +1,20 @@
---
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
### 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](../core-concepts/agent-roles.md)** - Overview of all BMM agent roles and responsibilities
- **[Quick Flow Solo Dev (Barry)](./barry-quick-flow.md)** - The dedicated agent for rapid development
## Getting Started
### BMGD Agents
- **[Game Development Agents](../game-dev/agents.md)** - Complete guide to BMGD's specialized game dev agents
---
## Related
- **[What Are Agents?](../core-concepts/what-are-agents.md)** - Core concept explanation
- **[Party Mode](../features/party-mode.md)** - Multi-agent collaboration
- **[Customize Agents](../../how-to/customization/customize-agents.md)** - How to customize agent behavior
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
3. Choose an agent that fits your workflow needs

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.
---
## Phase Overview
| 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 4** | Implementation | Building the software | Required |
---
## Phase 1: Analysis (Optional)
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
- Continuing existing work
---
## Phase 2: Planning (Required)
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:**
Define **what** to build and **why**. Leave **how** to Phase 3.
---
## Phase 3: Solutioning (Track-Dependent)
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:**
Make technical decisions explicit so all agents implement consistently.
---
## Phase 4: Implementation (Required)
Iterative sprint-based development with story-centric workflow.
@ -86,10 +76,9 @@ Iterative sprint-based development with story-centric workflow.
- `code-review` - Quality assurance
- `retrospective` - Continuous improvement
**Key principle:**
One story at a time, complete each story's full lifecycle before starting the next.
---
:::tip[Key Principle]
One story at a time — complete each story's full lifecycle before starting the next.
:::
## 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.
---
## Related
- [Why Solutioning Matters](./why-solutioning-matters.md)
- [Preventing Agent Conflicts](./preventing-agent-conflicts.md)
- [Quick Start Guide](../../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.
---
## Common Conflict Types
### API Style Conflicts
@ -43,8 +41,6 @@ With architecture:
- ADR specifies state management approach
- All agents implement consistently
---
## How Architecture Prevents Conflicts
### 1. Explicit Decisions via ADRs
@ -70,8 +66,6 @@ Explicit documentation of:
- Code organization
- Testing patterns
---
## Architecture as Shared Context
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
```
---
## Key ADR Topics
Common decisions that prevent conflicts:
@ -103,36 +95,17 @@ Common decisions that prevent conflicts:
| Styling | CSS Modules vs Tailwind vs Styled Components |
| Testing | Jest + Playwright vs Vitest + Cypress |
---
## Anti-Patterns to Avoid
## Anti-Patterns
### ❌ Implicit Decisions
"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
:::caution[Common Mistakes]
- **Implicit Decisions** — "We'll figure out the API style as we go" leads to inconsistency
- **Over-Documentation** — Documenting every minor choice causes analysis paralysis
- **Stale Architecture** — Documents written once and never updated cause agents to follow outdated patterns
:::
:::tip[Correct Approach]
- Document decisions that cross epic boundaries
- Focus on conflict-prone areas
- Update architecture as you learn
- Use `correct-course` for significant changes
---
## Related
- [Why Solutioning Matters](./why-solutioning-matters.md)
- [Four Phases](./four-phases.md)
- [Create Architecture](../../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.
---
## 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.
---
## 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.
---
## Solutioning vs Planning
| 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 |
| Level | Business logic | Technical design + Work breakdown |
---
## Key Principle
**Make technical decisions explicit and documented** so all agents implement consistently.
@ -56,8 +48,6 @@ This prevents:
- Naming convention mismatches
- Security approach variations
---
## When Solutioning is Required
| Track | Solutioning Required? |
@ -67,9 +57,9 @@ This prevents:
| BMad Method Complex | 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
@ -80,12 +70,6 @@ Skipping solutioning on complex projects leads to:
- **Longer development time** overall
- **Technical debt** from inconsistent patterns
:::caution[Cost Multiplier]
Catching alignment issues in solutioning is 10× faster than discovering them during implementation.
---
## Related
- [Four Phases](./four-phases.md) - Overview of all phases
- [Preventing Agent Conflicts](./preventing-agent-conflicts.md) - Detailed conflict prevention
- [Create Architecture](../../how-to/workflows/create-architecture.md) - How to do it
:::

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

@ -2,10 +2,13 @@
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)
- Completely new modules, workflows, templates, and agents outside software engineering
@ -27,7 +30,7 @@ This flexibility transforms the platform beyond its current capabilities, enabli
Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications.
Custom modules are [installable](../../how-to/installation/install-custom-modules.md) using the standard BMAD method and support advanced features:
Custom modules are [installable](/docs/how-to/installation/install-custom-modules.md) using the standard BMad method and support advanced features:
- Optional user information collection during installation/updates
- Versioning and upgrade paths
@ -52,13 +55,13 @@ Add-on modules can include:
## Custom Global Modules
Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMAD ecosystem.
Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem.
Examples include:
- The current TTS (Text-to-Speech) functionality for Claude, which will soon be converted to a global module
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
- Installation and update tools that work with any BMAD method configuration
- Installation and update tools that work with any BMad method configuration
Upcoming standards will document best practices for building global content that affects installed modules through:
@ -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
- 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.
:::
Custom agents can be:
@ -117,4 +122,6 @@ A custom workflow created outside of a larger module can still be distributed an
- Slash commands
- 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.
:::

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

@ -1,66 +1,45 @@
---
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.
---
Create custom agents, workflows, and modules for BMad — from simple personal assistants to full-featured professional tools.
## Quick Start
- **[Agent Creation Guide](../../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
Comprehensive guides for each agent type:
- **Simple Agent Architecture** - Self-contained, optimized, personality-driven
- **Expert Agent Architecture** - Memory, sidecar files, domain restrictions
- **Module Agent Architecture** - Workflow integration, professional tools
---
| Type | Description |
|------|-------------|
| **Simple Agent** | Self-contained, optimized, personality-driven |
| **Expert Agent** | Memory, sidecar files, domain restrictions |
| **Module Agent** | Workflow integration, professional tools |
## Key Concepts
### YAML to XML Compilation
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
1. **Frontmatter** - Name and description from metadata
2. **Activation Block** - Steps, menu handlers, rules
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
1. **Frontmatter** — Name and description from metadata
2. **Activation Block** — Steps, menu handlers, rules
3. **Menu Enhancement** — `*help` and `*exit` commands added automatically
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
Production-ready examples available in the BMB reference folder:
### Simple Agents
- **commit-poet** - Commit message artisan with style customization
### Expert Agents
- **journal-keeper** - Personal journal companion with memory and pattern recognition
### 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](../../how-to/installation/install-custom-modules.md)
---
## Related
- [Custom Content Types](./custom-content-types.md) - Understanding content types
- [Create Custom Agent](../../tutorials/advanced/create-custom-agent.md) - Tutorial
| Agent | Type | Description |
|-------|------|-------------|
| **commit-poet** | Simple | Commit message artisan with style customization |
| **journal-keeper** | Expert | Personal journal companion with memory and pattern recognition |
| **security-engineer** | Module | BMM security specialist with threat modeling |
| **trend-analyst** | Module | CIS trend intelligence expert |

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

@ -2,28 +2,22 @@
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
---
## 🚀 Getting Started
:::tip[Quick Path]
Install → workflow-init → Follow agent guidance
:::
**New to BMM?** Start here:
- **[Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)** - Step-by-step guide to building your first project
- Installation and setup
- Understanding the four phases
- Running your first workflows
- Agent-based development flow
| Resource | Description |
|----------|-------------|
| **[Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)** | Step-by-step guide to building your first project |
| **[Complete Workflow Diagram](../../tutorials/getting-started/images/workflow-method-greenfield.svg)** | Visual flowchart showing all phases, agents, and decision points |
**Quick Path:** Install → workflow-init → Follow agent guidance
### 📊 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
## 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).
@ -36,26 +30,26 @@ First know there is the full BMad Method Process and then there is a Quick Flow
- All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
- While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next
- **[BMAD Quick Flow](../../explanation/features/quick-flow.md)** - Fast-track development workflow
- **[BMad Quick Flow](/docs/explanation/features/quick-flow.md)** - Fast-track development workflow
- 3-step process: spec → dev → optional review
- Perfect for bug fixes and small features
- Rapid prototyping with production quality
- Implementation in minutes, not days
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](../agents/barry-quick-flow.md)**
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](/docs/explanation/agents/barry-quick-flow.md)**
- **TEA engagement (optional)** - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See **[Test Architect Guide](../../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:
- **[Agents Guide](../../explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
- **[Agents Guide](/docs/explanation/core-concepts/agent-roles.md)** - Comprehensive agent reference
- 12 specialized BMM agents + BMad Master
- Agent roles, workflows, and when to use them
- Agent customization system
- Best practices and common patterns
- **[Party Mode Guide](../../explanation/features/party-mode.md)** - Multi-agent collaboration
- **[Party Mode Guide](/docs/explanation/features/party-mode.md)** - Multi-agent collaboration
- How party mode works (19+ agents collaborate in real-time)
- When to use it (strategic, creative, cross-functional, complex)
- Example party compositions
@ -63,68 +57,68 @@ Complete guide to BMM's AI agent team:
- Agent customization in party mode
- Best practices
## 🔧 Working with Existing Code
## Working with Existing Code
Comprehensive guide for brownfield development:
- **[Brownfield Development Guide](../../how-to/brownfield/index.md)** - Complete guide for existing codebases
- **[Brownfield Development Guide](/docs/how-to/brownfield/index.md)** - Complete guide for existing codebases
- Documentation phase strategies
- Track selection for brownfield
- Integration with existing patterns
- Phase-by-phase workflow guidance
- Common scenarios
## 📚 Quick References
## Quick References
Essential reference materials:
- **[Glossary](../../reference/glossary/index.md)** - Key terminology and concepts
- **[FAQ](../faq/index.md)** - Frequently asked questions across all topics
- **[Glossary](/docs/reference/glossary/index.md)** - Key terminology and concepts
- **[FAQ](/docs/explanation/faq/index.md)** - Frequently asked questions across all topics
## 🎯 Choose Your Path
## Choose Your Path
### I need to...
**Build something new (greenfield)**
→ Start with [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)
→ Start with [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)
**Fix a bug or add small feature**
→ Use the [Quick Flow Solo Dev](../agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](../features/quick-flow.md) process
→ Use the [Quick Flow Solo Dev](/docs/explanation/agents/barry-quick-flow.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](/docs/explanation/features/quick-flow.md) process
**Work with existing codebase (brownfield)**
→ Read [Brownfield Development Guide](../../how-to/brownfield/index.md)
→ Read [Brownfield Development Guide](/docs/how-to/brownfield/index.md)
→ Pay special attention to documentation requirements for brownfield projects
## 📋 Workflow Guides
## Workflow Guides
Comprehensive documentation for all BMM workflows organized by phase:
- **[Phase 1: Analysis Workflows](../../how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines)
- **[Phase 1: Analysis Workflows](/docs/how-to/workflows/run-brainstorming-session.md)** - Optional exploration and research workflows (595 lines)
- brainstorm-project, product-brief, research, and more
- When to use analysis workflows
- Creative and strategic tools
- **[Phase 2: Planning Workflows](../../how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
- **[Phase 2: Planning Workflows](/docs/how-to/workflows/create-prd.md)** - Scale-adaptive planning (967 lines)
- prd, tech-spec, gdd, narrative, ux
- Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
- Which planning workflow to use
- **[Phase 3: Solutioning Workflows](../../how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
- **[Phase 3: Solutioning Workflows](/docs/how-to/workflows/create-architecture.md)** - Architecture and validation (638 lines)
- architecture, create-epics-and-stories, implementation-readiness
- V6: Epics created AFTER architecture for better quality
- Required for BMad Method and Enterprise Method tracks
- Preventing agent conflicts
- **[Phase 4: Implementation Workflows](../../how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
- **[Phase 4: Implementation Workflows](/docs/how-to/workflows/run-sprint-planning.md)** - Sprint-based development (1,634 lines)
- sprint-planning, create-story, dev-story, code-review
- Complete story lifecycle
- One-story-at-a-time discipline
- **[Testing & QA Workflows](../../explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
- **[Testing & QA Workflows](/docs/explanation/features/tea-overview.md)** - Comprehensive quality assurance (1,420 lines)
- Test strategy, automation, quality gates
- TEA agent and test healing
## 🌐 External Resources
## External Resources
### 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
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and walkthroughs
**Ready to begin?** → [Start with the Quick Start Guide](../../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)
:::

27
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
---
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
| 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 |
| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
---
## Phase 1: Analysis
### 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.
---
## Phase 2: Planning
### 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.
---
## Phase 3: Solutioning
### 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.
---
## Phase 4: Implementation
### SM (Bob)
@ -138,8 +127,6 @@ Story implementation and code review specialist.
**When to use:** Writing code, implementing stories, reviewing quality.
---
## Cross-Phase Agents
### TEA (Murat)
@ -159,8 +146,6 @@ Test architecture and quality strategy expert.
**When to use:** Setting up testing, creating test plans, quality gates.
---
## Quick Flow
### Quick Flow Solo Dev (Barry)
@ -173,14 +158,12 @@ Fast solo development without handoffs.
- Code review
**Key Workflows:**
- `*create-tech-spec`
- `*quick-spec`
- `*quick-dev`
- `*code-review`
**When to use:** Bug fixes, small features, rapid prototyping.
---
## Choosing the Right Agent
| Task | Agent |
@ -194,11 +177,3 @@ Fast solo development without handoffs.
| Writing code | DEV |
| Setting up tests | TEA |
| Quick bug fix | Quick Flow Solo Dev |
---
## Related
- [What Are Agents](./what-are-agents.md) - Foundational concepts
- [Agent Reference](../../reference/agents/index.md) - Complete command reference
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md)

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

@ -1,40 +1,35 @@
---
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
| Concept | Description | Guide |
|---------|-------------|-------|
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](./what-are-agents.md) |
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](./what-are-workflows.md) |
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](./what-are-modules.md) |
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) |
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md) |
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](/docs/explanation/core-concepts/what-are-modules.md) |
## Getting Started
### New to BMAD?
Start here to understand what BMAD is and how it works:
### New to BMad?
Start here to understand what BMad is and how it works:
1. **[Agents Guide](./what-are-agents.md)** - Learn about Simple and Expert agents
2. **[Workflows Guide](./what-are-workflows.md)** - Understand how workflows orchestrate tasks
3. **[Modules Guide](./what-are-modules.md)** - See how modules organize functionality
1. **[Agents Guide](/docs/explanation/core-concepts/what-are-agents.md)** - Learn about Simple and Expert agents
2. **[Workflows Guide](/docs/explanation/core-concepts/what-are-workflows.md)** - Understand how workflows orchestrate tasks
3. **[Modules Guide](/docs/explanation/core-concepts/what-are-modules.md)** - See how modules organize functionality
### Installing BMAD
### Installing BMad
- **[Installation Guide](../../how-to/installation/index.md)** - Set up BMAD in your project
- **[Upgrading from v4](../../how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions
- **[Installation Guide](/docs/how-to/installation/index.md)** - Set up BMad in your project
- **[Upgrading from v4](/docs/how-to/installation/upgrade-to-v6.md)** - Migrate from earlier versions
### Configuration
- **[BMAD Customization](../../how-to/customization/index.md)** - Personalize agents and workflows
- **[BMad Customization](/docs/how-to/customization/index.md)** - Personalize agents and workflows
### Advanced
- **[Web Bundles](../features/web-bundles.md)** - Use BMAD in Gemini Gems and Custom GPTs
---
**Next:** Read the [Agents Guide](./what-are-agents.md) to understand the core building block of BMAD.
- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs

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

@ -2,12 +2,11 @@
title: "Agents"
---
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
## Agent Types
BMAD has two primary agent types, designed for different use cases:
BMad has two primary agent types, designed for different use cases:
### Simple Agents
@ -72,6 +71,10 @@ All agents share these building blocks:
## 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:**
- You need a task done quickly and reliably
- The scope is well-defined and won't change much
@ -85,12 +88,8 @@ All agents share these building blocks:
## Creating Custom Agents
BMAD provides the **BMAD Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](../../tutorials/advanced/create-custom-agent.md) for step-by-step instructions.
BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](/docs/tutorials/advanced/create-custom-agent.md) for step-by-step instructions.
## Customizing Existing Agents
You can modify any agent's behavior without editing core files. See [BMAD Customization](../../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](./what-are-workflows.md) to see how agents accomplish complex tasks.
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.

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

@ -2,7 +2,6 @@
title: "Modules"
---
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
## What is a Module?
@ -16,19 +15,23 @@ A module is a self-contained package that includes:
## 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
Always installed, provides shared functionality:
- Global configuration
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
- Common tasks (document indexing, sharding, review)
### BMAD Method (BMM)
### BMad Method (BMM)
Software and game development:
- Project planning workflows
- Implementation agents (Dev, PM, QA, Scrum Master)
- Testing and architecture guidance
### BMAD Builder (BMB)
### BMad Builder (BMB)
Create custom solutions:
- Agent creation workflows
- Workflow authoring tools
@ -40,7 +43,7 @@ Innovation and creativity:
- Innovation strategy workflows
- Storytelling and ideation
### BMAD Game Dev (BMGD)
### BMad Game Dev (BMGD)
Game development specialization:
- Game design workflows
- Narrative development
@ -53,8 +56,8 @@ Installed modules follow this structure:
```
_bmad/
├── core/ # Always present
├── bmm/ # BMAD Method (if installed)
├── bmb/ # BMAD Builder (if installed)
├── bmm/ # BMad Method (if installed)
├── bmb/ # BMad Builder (if installed)
├── cis/ # Creative Intelligence (if installed)
└── bmgd/ # Game Dev (if installed)
```
@ -70,10 +73,6 @@ Custom modules are installed the same way as official modules.
## Installing 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](../../how-to/installation/index.md) for details.
---
**Next:** Read the [Installation Guide](../../how-to/installation/index.md) to set up BMAD with the modules you need.
See [Installation Guide](/docs/how-to/installation/index.md) for details.

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

@ -2,13 +2,10 @@
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.
This guide explains what workflows are, why they're powerful, and how to think about designing them.
---
## 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.
@ -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.
**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
@ -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.
---
## How Workflows Work
### The Basic Structure
@ -138,20 +133,18 @@ Each workflow checks for required inputs from prior workflows, validates they're
### The Tri-Modal Pattern
For critical workflows that produce important artifacts, BMAD uses a tri-modal structure: Create, Validate, and Edit. Each mode is a separate workflow path that can run independently or flow into the others.
For critical workflows that produce important artifacts, BMad uses a tri-modal structure: Create, Validate, and Edit. Each mode is a separate workflow path that can run independently or flow into the others.
**Create mode** builds new artifacts from scratch. But here's where it gets interesting: create mode can also function as a conversion tool. Feed it a non-compliant document—something that doesn't follow BMAD standards—and it will extract the essential content and rebuild it as a compliant artifact. This means you can bring in existing work and automatically upgrade it to follow proper patterns.
**Create mode** builds new artifacts from scratch. But here's where it gets interesting: create mode can also function as a conversion tool. Feed it a non-compliant document—something that doesn't follow BMad standards—and it will extract the essential content and rebuild it as a compliant artifact. This means you can bring in existing work and automatically upgrade it to follow proper patterns.
**Validate mode** runs standalone and checks artifacts against standards. Because it's separate, you can run validation whenever you want—immediately after creation, weeks later when things have changed, or even using a different LLM entirely. It's like having a quality assurance checkpoint that's always available but never forced.
**Edit mode** modifies existing artifacts while enforcing standards. As you update documents to reflect changing requirements or new understanding, edit mode ensures you don't accidentally drift away from the patterns that make the artifacts useful. It checks compliance as you work and can route back to create mode if it detects something that needs full conversion.
All BMAD planning workflows and the BMB module (will) use this tri-modal pattern. The pristine example is the workflow workflow in BMB—it creates workflow specifications, validates them against standards, and lets you edit them while maintaining compliance. You can study that workflow to see the pattern in action.
All BMad planning workflows and the BMB module (will) use this tri-modal pattern. The pristine example is the workflow workflow in BMB—it creates workflow specifications, validates them against standards, and lets you edit them while maintaining compliance. You can study that workflow to see the pattern in action.
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
Before building a workflow, answer these questions:
@ -166,11 +159,9 @@ Before building a workflow, answer these questions:
**Intent or prescriptive?**: Is this intent-based facilitation (most workflows) or prescriptive compliance (medical, legal, regulated)?
---
## 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:
- **BMB (Module Builder)**: Workflow and agent creation workflows
- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning
@ -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.
---
## When to Use Workflows
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
a short single file workflow.md file.
---
## 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.

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

@ -3,16 +3,16 @@ title: "Core Module"
---
The Core Module is installed with all installations of BMAD modules and provides common functionality that any module, workflow, or agent can take advantage of.
The Core Module is installed with all installations of BMad modules and provides common functionality that any module, workflow, or agent can take advantage of.
## Core Module Components
- **[Global Core Config](../../reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content
- **[Core Workflows](../../reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module
- [Party Mode](../../explanation/features/party-mode.md) — Multi-agent conversation orchestration
- [Brainstorming](../../explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques
- [Advanced Elicitation](../../explanation/features/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
- **[Core Tasks](../../reference/configuration/core-tasks.md)** — Common tasks available across modules
- [Index Docs](../../reference/configuration/core-tasks.md#index-docs) — Generate directory index files
- [Adversarial Review](../../reference/configuration/core-tasks.md#adversarial-review-general) — Critical content review
- [Shard Document](../../reference/configuration/core-tasks.md#shard-document) — Split large documents into sections
- **[Global Core Config](/docs/reference/configuration/global-config.md)** — Inheritable configuration that impacts all modules and custom content
- **[Core Workflows](/docs/reference/workflows/core-workflows.md)** — Domain-agnostic workflows usable by any module
- [Party Mode](/docs/explanation/features/party-mode.md) — Multi-agent conversation orchestration
- [Brainstorming](/docs/explanation/features/brainstorming-techniques.md) — Structured creative sessions with 60+ techniques
- [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
- [Index Docs](/docs/reference/configuration/core-tasks.md#index-docs) — Generate directory index files
- [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

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

53
docs/explanation/faq/brownfield-faq.md
View File

@ -2,22 +2,25 @@
title: "Brownfield Development FAQ"
description: Common questions about brownfield development in the BMad Method
---
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method (BMM).
## Questions
Quick answers to common questions about brownfield (existing codebase) development in the BMad Method.
- [What is brownfield vs greenfield?](#what-is-brownfield-vs-greenfield)
- [Do I have to run document-project for brownfield?](#do-i-have-to-run-document-project-for-brownfield)
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
- [Can I use Quick Spec Flow for brownfield projects?](#can-i-use-quick-spec-flow-for-brownfield-projects)
- [How does workflow-init handle old planning docs?](#how-does-workflow-init-handle-old-planning-docs)
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
---
### What is brownfield vs greenfield?
## Q: What is brownfield vs greenfield?
- **Greenfield** — New project, starting from scratch, clean slate
- **Brownfield** — Existing project, working with established codebase and patterns
**A:**
### Do I have to run document-project for brownfield?
- **Greenfield:** New project, starting from scratch, clean slate
- **Brownfield:** Existing project, working with established codebase and patterns
## Q: Do I have to run document-project for brownfield?
**A:** Highly recommended, especially if:
Highly recommended, especially if:
- No existing documentation
- Documentation is outdated
@ -26,9 +29,9 @@ Quick answers to common questions about brownfield (existing codebase) developme
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md`.
## Q: What if I forget to run document-project on brownfield?
### What if I forget to run document-project?
**A:** Workflows will lack context about existing code. You may get:
Workflows will lack context about existing code. You may get:
- Suggestions that don't match existing patterns
- Integration approaches that miss existing APIs
@ -36,9 +39,9 @@ You can skip it if you have comprehensive, up-to-date documentation including `d
Run document-project and restart planning with proper context.
## Q: Can I use Quick Spec Flow for brownfield projects?
### Can I use Quick Spec Flow for brownfield projects?
**A:** Yes! Quick Spec Flow works great for brownfield. It will:
Yes! Quick Spec Flow works great for brownfield. It will:
- Auto-detect your existing stack
- Analyze brownfield code patterns
@ -47,34 +50,24 @@ Run document-project and restart planning with proper context.
Perfect for bug fixes and small features in existing codebases.
## Q: How does workflow-init handle brownfield with old planning docs?
### How does workflow-init handle old planning docs?
**A:** workflow-init asks about YOUR current work first, then uses old artifacts as context:
workflow-init asks about YOUR current work first, then uses old artifacts as context:
1. Shows what it found (old PRD, epics, etc.)
2. Asks: "Is this work in progress, previous effort, or proposed work?"
3. If previous effort: Asks you to describe your NEW work
4. Determines level based on YOUR work, not old artifacts
This prevents old Level 3 PRDs from forcing Level 3 workflow for new Level 0 bug fix.
This prevents old Level 3 PRDs from forcing Level 3 workflow for a new Level 0 bug fix.
## Q: What if my existing code doesn't follow best practices?
### What if my existing code doesn't follow best practices?
**A:** Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
Quick Spec Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
- **Yes** → Maintain consistency with current codebase
- **No** → Establish new standards (document why in tech-spec)
BMM respects your choice - it won't force modernization, but it will offer it.
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Brownfield Guide](../../how-to/brownfield/index.md) - Existing codebase workflows
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
BMM respects your choice — it won't force modernization, but it will offer it.
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

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

@ -3,24 +3,34 @@ title: "Getting Started FAQ"
description: Common questions about getting started with the BMad Method
---
Quick answers to common questions about getting started with the BMad Method.
---
## Questions
## Q: Do I always need to run workflow-init?
- [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)
- [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)
- [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)
**A:** No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
### 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?
No, once you learn the flow you can go directly to workflows. However, workflow-init is helpful because it:
- Determines your project's appropriate level automatically
- Creates the tracking status file
- Routes you to the correct starting workflow
For experienced users: use the [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow.
For experienced users: use the [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md) to go directly to the right agent/workflow.
## Q: Why do I need fresh chats for each workflow?
### Why do I need fresh chats for each workflow?
**A:** Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for:
Context-intensive workflows (like brainstorming, PRD creation, architecture design) can cause AI hallucinations if run in sequence within the same chat. Starting fresh ensures the agent has maximum context capacity for each workflow. This is particularly important for:
- Planning workflows (PRD, architecture)
- Analysis workflows (brainstorming, research)
@ -28,39 +38,30 @@ For experienced users: use the [Quick Start Guide](../../tutorials/getting-start
Quick workflows like status checks can reuse chats safely.
## Q: Can I skip workflow-status and just start working?
### Can I skip workflow-status and just start working?
**A:** Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for:
Yes, if you already know your project level and which workflow comes next. workflow-status is mainly useful for:
- New projects (guides initial setup)
- When you're unsure what to do next
- After breaks in work (reminds you where you left off)
- Checking overall progress
## Q: What's the minimum I need to get started?
### What's the minimum I need to get started?
**A:** For the fastest path:
For the fastest path:
1. Install BMad Method: `npx bmad-method@alpha install`
2. For small changes: Load PM agent → run tech-spec → implement
3. For larger projects: Load PM agent → run prd → architect → implement
## Q: How do I know if I'm in Phase 1, 2, 3, or 4?
### How do I know if I'm in Phase 1, 2, 3, or 4?
**A:** Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on:
Check your `bmm-workflow-status.md` file (created by workflow-init). It shows your current phase and progress. If you don't have this file, you can also tell by what you're working on:
- **Phase 1** - Brainstorming, research, product brief (optional)
- **Phase 2** - Creating either a PRD or tech-spec (always required)
- **Phase 3** - Architecture design (Level 2-4 only)
- **Phase 4** - Actually writing code, implementing stories
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
- **Phase 1** — Brainstorming, research, product brief (optional)
- **Phase 2** — Creating either a PRD or tech-spec (always required)
- **Phase 3** — Architecture design (Level 2-4 only)
- **Phase 4** — Actually writing code, implementing stories
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

40
docs/explanation/faq/implementation-faq.md
View File

@ -3,54 +3,50 @@ title: "Implementation FAQ"
description: Common questions about implementation in the BMad Method
---
Quick answers to common questions about implementation in the BMad Method.
---
## Questions
## Q: Does create-story include implementation context?
- [Does create-story include implementation context?](#does-create-story-include-implementation-context)
- [How do I mark a story as done?](#how-do-i-mark-a-story-as-done)
- [Can I work on multiple stories at once?](#can-i-work-on-multiple-stories-at-once)
- [What if my story takes longer than estimated?](#what-if-my-story-takes-longer-than-estimated)
- [When should I run retrospective?](#when-should-i-run-retrospective)
**A:** Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler.
### Does create-story include implementation context?
## Q: How do I mark a story as done?
Yes! The create-story workflow generates story files that include implementation-specific guidance, references existing patterns from your documentation, and provides technical context. The workflow loads your architecture, PRD, and existing project documentation to create comprehensive stories. For Quick Flow projects using tech-spec, the tech-spec itself is already comprehensive, so stories can be simpler.
**A:** After dev-story completes and code-review passes:
### How do I mark a story as done?
After dev-story completes and code-review passes:
1. Open `sprint-status.yaml` (created by sprint-planning)
2. Change the story status from `review` to `done`
3. Save the file
## Q: Can I work on multiple stories at once?
### Can I work on multiple stories at once?
**A:** Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other.
Yes, if you have capacity! Stories within different epics can be worked in parallel. However, stories within the same epic are usually sequential because they build on each other.
## Q: What if my story takes longer than estimated?
### What if my story takes longer than estimated?
**A:** That's normal! Stories are estimates. If implementation reveals more complexity:
That's normal! Stories are estimates. If implementation reveals more complexity:
1. Continue working until DoD is met
2. Consider if story should be split
3. Document learnings in retrospective
4. Adjust future estimates based on this learning
## Q: When should I run retrospective?
### When should I run retrospective?
**A:** After completing all stories in an epic (when epic is done). Retrospectives capture:
After completing all stories in an epic (when epic is done). Retrospectives capture:
- What went well
- What could improve
- Technical insights
- Learnings for future epics
Don't wait until project end - run after each epic for continuous improvement.
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
Don't wait until project end — run after each epic for continuous improvement.
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

15
docs/explanation/faq/index.md
View File

@ -3,15 +3,14 @@ title: "Frequently Asked Questions"
description: Frequently asked questions about the BMad Method
---
Quick answers to common questions about the BMad Method, organized by topic.
## Topics
- [Getting Started](./getting-started-faq.md) - Questions about starting with BMM
- [Levels & Tracks](./levels-and-tracks-faq.md) - Choosing the right level
- [Workflows](./workflows-faq.md) - Workflow and phase questions
- [Planning](./planning-faq.md) - Planning document questions
- [Implementation](./implementation-faq.md) - Implementation questions
- [Brownfield](./brownfield-faq.md) - Existing codebase questions
- [Tools & Advanced](./tools-faq.md) - Tools, IDEs, and advanced topics
- [Getting Started](/docs/explanation/faq/getting-started-faq.md) - Questions about starting with BMad
- [Levels & Tracks](/docs/explanation/faq/levels-and-tracks-faq.md) - Choosing the right level
- [Workflows](/docs/explanation/faq/workflows-faq.md) - Workflow and phase questions
- [Planning](/docs/explanation/faq/planning-faq.md) - Planning document questions
- [Implementation](/docs/explanation/faq/implementation-faq.md) - Implementation questions
- [Brownfield](/docs/explanation/faq/brownfield-faq.md) - Existing codebase questions
- [Tools & Advanced](/docs/explanation/faq/tools-faq.md) - Tools, IDEs, and advanced topics

52
docs/explanation/faq/levels-and-tracks-faq.md
View File

@ -3,41 +3,44 @@ title: "Levels and Tracks FAQ"
description: Common questions about choosing the right level for your project
---
Quick answers to common questions about choosing the right level for your BMad Method project.
---
## Questions
## Q: How do I know which level my project is?
- [How do I know which level my project is?](#how-do-i-know-which-level-my-project-is)
- [Can I change levels mid-project?](#can-i-change-levels-mid-project)
- [What if workflow-init suggests the wrong level?](#what-if-workflow-init-suggests-the-wrong-level)
- [Do I always need architecture for Level 2?](#do-i-always-need-architecture-for-level-2)
- [What's the difference between Level 1 and Level 2?](#whats-the-difference-between-level-1-and-level-2)
**A:** Use workflow-init for automatic detection, or self-assess using these keywords:
### How do I know which level my project is?
- **Level 0:** "fix", "bug", "typo", "small change", "patch" → 1 story
- **Level 1:** "simple", "basic", "small feature", "add" → 1-10 stories
- **Level 2:** "dashboard", "several features", "admin panel" → 5-15 stories
- **Level 3:** "platform", "integration", "complex", "system" → 12-40 stories
- **Level 4:** "enterprise", "multi-tenant", "multiple products" → 40+ stories
Use workflow-init for automatic detection, or self-assess using these keywords:
- **Level 0** — "fix", "bug", "typo", "small change", "patch" → 1 story
- **Level 1** — "simple", "basic", "small feature", "add" → 1-10 stories
- **Level 2** — "dashboard", "several features", "admin panel" → 5-15 stories
- **Level 3** — "platform", "integration", "complex", "system" → 12-40 stories
- **Level 4** — "enterprise", "multi-tenant", "multiple products" → 40+ stories
When in doubt, start smaller. You can always run create-prd later if needed.
## Q: Can I change levels mid-project?
### Can I change levels mid-project?
**A:** Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible - your initial level choice isn't permanent.
Yes! If you started at Level 1 but realize it's Level 2, you can run create-prd to add proper planning docs. The system is flexible — your initial level choice isn't permanent.
## Q: What if workflow-init suggests the wrong level?
### What if workflow-init suggests the wrong level?
**A:** You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment.
You can override it! workflow-init suggests a level but always asks for confirmation. If you disagree, just say so and choose the level you think is appropriate. Trust your judgment.
## Q: Do I always need architecture for Level 2?
### Do I always need architecture for Level 2?
**A:** No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD created during planning.
No, architecture is **optional** for Level 2. Only create architecture if you need system-level design. Many Level 2 projects work fine with just PRD created during planning.
## Q: What's the difference between Level 1 and Level 2?
### What's the difference between Level 1 and Level 2?
**A:**
- **Level 1:** 1-10 stories, uses tech-spec (simpler, faster), no architecture
- **Level 2:** 5-15 stories, uses PRD (product-focused), optional architecture
- **Level 1** — 1-10 stories, uses tech-spec (simpler, faster), no architecture
- **Level 2** — 5-15 stories, uses PRD (product-focused), optional architecture
The overlap (5-10 stories) is intentional. Choose based on:
@ -46,13 +49,4 @@ The overlap (5-10 stories) is intentional. Choose based on:
- Multiple epics? → Level 2
- Single epic? → Level 1
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

28
docs/explanation/faq/planning-faq.md
View File

@ -3,22 +3,25 @@ title: "Planning Documents FAQ"
description: Common questions about planning documents in the BMad Method
---
Quick answers to common questions about planning documents in the BMad Method.
---
## Questions
## Q: Why no tech-spec at Level 2+?
- [Why no tech-spec at Level 2+?](#why-no-tech-spec-at-level-2)
- [Do I need a PRD for a bug fix?](#do-i-need-a-prd-for-a-bug-fix)
- [Can I skip the product brief?](#can-i-skip-the-product-brief)
**A:** Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses:
### Why no tech-spec at Level 2+?
Level 2+ projects need product-level planning (PRD) and system-level design (Architecture), which tech-spec doesn't provide. Tech-spec is too narrow for coordinating multiple features. Instead, Level 2-4 uses:
- PRD (product vision, functional requirements, non-functional requirements)
- Architecture (system design)
- Epics+Stories (created AFTER architecture is complete)
## Q: Do I need a PRD for a bug fix?
### Do I need a PRD for a bug fix?
**A:** No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
No! Bug fixes are typically Level 0 (single atomic change). Use Quick Spec Flow:
- Load PM agent
- Run tech-spec workflow
@ -26,22 +29,13 @@ Quick answers to common questions about planning documents in the BMad Method.
PRDs are for Level 2-4 projects with multiple features requiring product-level coordination.
## Q: Can I skip the product brief?
### Can I skip the product brief?
**A:** Yes, product brief is always optional. It's most valuable for:
Yes, product brief is always optional. It's most valuable for:
- Level 3-4 projects needing strategic direction
- Projects with stakeholders requiring alignment
- Novel products needing market research
- When you want to explore solution space before committing
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

127
docs/explanation/faq/tools-faq.md
View File

@ -3,16 +3,38 @@ title: "Tools and Advanced FAQ"
description: Common questions about tools, IDEs, and advanced topics in the BMad Method
---
Quick answers to common questions about tools, IDEs, and advanced topics in the BMad Method.
---
## Questions
**Tools and Technical**
- [Why are my Mermaid diagrams not rendering?](#why-are-my-mermaid-diagrams-not-rendering)
- [Can I use BMM with GitHub Copilot / Cursor / other AI tools?](#can-i-use-bmm-with-github-copilot--cursor--other-ai-tools)
- [What IDEs/tools support BMM?](#what-idestools-support-bmm)
- [Can I customize agents?](#can-i-customize-agents)
- [What happens to my planning docs after implementation?](#what-happens-to-my-planning-docs-after-implementation)
- [Can I use BMM for non-software projects?](#can-i-use-bmm-for-non-software-projects)
**Advanced**
- [What if my project grows from Level 1 to Level 3?](#what-if-my-project-grows-from-level-1-to-level-3)
- [Can I mix greenfield and brownfield approaches?](#can-i-mix-greenfield-and-brownfield-approaches)
- [How do I handle urgent hotfixes during a sprint?](#how-do-i-handle-urgent-hotfixes-during-a-sprint)
- [What if I disagree with the workflow's recommendations?](#what-if-i-disagree-with-the-workflows-recommendations)
- [Can multiple developers work on the same BMM project?](#can-multiple-developers-work-on-the-same-bmm-project)
- [What is party mode and when should I use it?](#what-is-party-mode-and-when-should-i-use-it)
**Getting Help**
- [Where do I get help if my question isn't answered here?](#where-do-i-get-help-if-my-question-isnt-answered-here)
- [How do I report a bug or request a feature?](#how-do-i-report-a-bug-or-request-a-feature)
## Tools and Technical
### Q: Why are my Mermaid diagrams not rendering?
### Why are my Mermaid diagrams not rendering?
**A:** Common issues:
Common issues:
1. Missing language tag: Use ` ```mermaid` not just ` ``` `
2. Syntax errors in diagram (validate at mermaid.live)
@ -20,9 +42,9 @@ Quick answers to common questions about tools, IDEs, and advanced topics in the
All BMM docs use valid Mermaid syntax that should render in GitHub, VS Code, and most IDEs.
### Q: Can I use BMM with GitHub Copilot / Cursor / other AI tools?
### Can I use BMM with GitHub Copilot / Cursor / other AI tools?
**A:** Yes! BMM is complementary. BMM handles:
Yes! BMM is complementary. BMM handles:
- Project planning and structure
- Workflow orchestration
@ -38,13 +60,13 @@ Your AI coding assistant handles:
Use them together for best results.
### Q: What IDEs/tools support BMM?
### What IDEs/tools support BMM?
**A:** BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes.
BMM requires tools with **agent mode** and access to **high-quality LLM models** that can load and follow complex workflows, then properly implement code changes.
**Recommended Tools:**
- **Claude Code** - Best choice
- **Claude Code** — Best choice
- Sonnet 4.5 (excellent workflow following, coding, reasoning)
- Opus (maximum context, complex planning)
- Native agent mode designed for BMM workflows
@ -61,22 +83,22 @@ Use them together for best results.
**What Matters:**
1. **Agent mode** - Can load long workflow instructions and maintain context
2. **High-quality LLM** - Models ranked high on SWE-bench (coding benchmarks)
3. **Model selection** - Access to Claude Sonnet 4.5, Opus, or GPT-4o class models
4. **Context capacity** - Can handle large planning documents and codebases
1. **Agent mode** — Can load long workflow instructions and maintain context
2. **High-quality LLM** — Models ranked high on SWE-bench (coding benchmarks)
3. **Model selection** — Access to Claude Sonnet 4.5, Opus, or GPT-4o class models
4. **Context capacity** — Can handle large planning documents and codebases
**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality.
### Q: Can I customize agents?
### Can I customize agents?
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags - a format any LLM can read and follow.
**Note:** While source agents in this repo are YAML, they install as `.md` files with XML-style tags — a format any LLM can read and follow.
### Q: What happens to my planning docs after implementation?
### What happens to my planning docs after implementation?
**A:** Keep them! They serve as:
Keep them! They serve as:
- Historical record of decisions
- Onboarding material for new team members
@ -85,37 +107,35 @@ Use them together for best results.
For enterprise projects (Level 4), consider archiving completed planning artifacts to keep workspace clean.
### Q: Can I use BMM for non-software projects?
### Can I use BMM for non-software projects?
**A:** BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain.
BMM is optimized for software development, but the methodology principles (scale-adaptive planning, just-in-time design, context injection) can apply to other complex project types. You'd need to adapt workflows and agents for your domain.
---
## Advanced
## Advanced Questions
### What if my project grows from Level 1 to Level 3?
### Q: What if my project grows from Level 1 to Level 3?
**A:** Totally fine! When you realize scope has grown:
Totally fine! When you realize scope has grown:
1. Run create-prd to add product-level planning
2. Run create-architecture for system design
3. Use existing tech-spec as input for PRD
4. Continue with updated level
The system is flexible - growth is expected.
The system is flexible — growth is expected.
### Q: Can I mix greenfield and brownfield approaches?
### Can I mix greenfield and brownfield approaches?
**A:** Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach:
Yes! Common scenario: adding new greenfield feature to brownfield codebase. Approach:
1. Run document-project for brownfield context
2. Use greenfield workflows for new feature planning
3. Explicitly document integration points between new and existing
4. Test integration thoroughly
### Q: How do I handle urgent hotfixes during a sprint?
### How do I handle urgent hotfixes during a sprint?
**A:** Use correct-course workflow or just:
Use correct-course workflow or just:
1. Save your current work state
2. Load PM agent → quick tech-spec for hotfix
@ -125,25 +145,25 @@ The system is flexible - growth is expected.
Level 0 Quick Spec Flow is perfect for urgent fixes.
### Q: What if I disagree with the workflow's recommendations?
### What if I disagree with the workflow's recommendations?
**A:** Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context:
Workflows are guidance, not enforcement. If a workflow recommends something that doesn't make sense for your context:
- Explain your reasoning to the agent
- Ask for alternative approaches
- Skip the recommendation if you're confident
- Document why you deviated (for future reference)
Trust your expertise - BMM supports your decisions.
Trust your expertise — BMM supports your decisions.
### Q: Can multiple developers work on the same BMM project?
### Can multiple developers work on the same BMM project?
**A:** Yes! But the paradigm is fundamentally different from traditional agile teams.
Yes! But the paradigm is fundamentally different from traditional agile teams.
**Key Difference:**
- **Traditional:** Multiple devs work on stories within one epic (months)
- **Agentic:** Each dev owns complete epics (days)
- **Traditional** — Multiple devs work on stories within one epic (months)
- **Agentic** — Each dev owns complete epics (days)
**In traditional agile:** A team of 5 devs might spend 2-3 months on a single epic, with each dev owning different stories.
@ -177,9 +197,9 @@ Trust your expertise - BMM supports your decisions.
- Coordinate at epic boundaries, not story level
- Use git submodules for BMM in enterprise settings
### Q: What is party mode and when should I use it?
### What is party mode and when should I use it?
**A:** Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time.
Party mode is a unique multi-agent collaboration feature where ALL your installed agents (19+ from BMM, CIS, BMB, custom modules) discuss your challenges together in real-time.
**How it works:**
@ -197,9 +217,9 @@ Trust your expertise - BMM supports your decisions.
**Example parties:**
- **Product Strategy:** PM + Innovation Strategist (CIS) + Analyst
- **Technical Design:** Architect + Creative Problem Solver (CIS) + Game Architect
- **User Experience:** UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
- **Product Strategy** — PM + Innovation Strategist (CIS) + Analyst
- **Technical Design** — Architect + Creative Problem Solver (CIS) + Game Architect
- **User Experience** — UX Designer + Design Thinking Coach (CIS) + Storyteller (CIS)
**Why it's powerful:**
@ -208,26 +228,20 @@ Trust your expertise - BMM supports your decisions.
- Emergent insights from agent interaction
- Natural collaboration across modules
**For complete documentation:**
👉 **[Party Mode Guide](../../explanation/features/party-mode.md)** - How it works, when to use it, example compositions, best practices
---
**For complete documentation:** See the [Party Mode Guide](/docs/explanation/features/party-mode.md)
## Getting Help
### Q: Where do I get help if my question isn't answered here?
**A:**
### Where do I get help if my question isn't answered here?
1. Search [Complete Documentation](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) for related topics
2. Ask in [Discord Community](https://discord.gg/gk8jAdXWmj) (#bmad-method-help)
3. Open a [GitHub Issue](https://github.com/bmad-code-org/BMAD-METHOD/issues)
4. Watch [YouTube Tutorials](https://www.youtube.com/@BMadCode)
### Q: How do I report a bug or request a feature?
### How do I report a bug or request a feature?
**A:** Open a GitHub issue at: <https://github.com/bmad-code-org/BMAD-METHOD/issues>
Open a GitHub issue at: <https://github.com/bmad-code-org/BMAD-METHOD/issues>
Please include:
@ -236,13 +250,4 @@ Please include:
- Expected vs actual behavior
- Relevant workflow or agent involved
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

59
docs/explanation/faq/workflows-faq.md
View File

@ -3,66 +3,59 @@ title: "Workflows FAQ"
description: Common questions about BMad Method workflows and phases
---
Quick answers to common questions about BMad Method workflows and phases.
---
## Questions
## Q: What's the difference between workflow-status and workflow-init?
- [What's the difference between workflow-status and workflow-init?](#whats-the-difference-between-workflow-status-and-workflow-init)
- [Can I skip Phase 1 (Analysis)?](#can-i-skip-phase-1-analysis)
- [When is Phase 3 (Architecture) required?](#when-is-phase-3-architecture-required)
- [What happens if I skip a recommended workflow?](#what-happens-if-i-skip-a-recommended-workflow)
- [How do I know when Phase 3 is complete?](#how-do-i-know-when-phase-3-is-complete)
- [Can I run workflows in parallel?](#can-i-run-workflows-in-parallel)
**A:**
### What's the difference between workflow-status and workflow-init?
- **workflow-status:** Checks existing status and tells you what's next (use when continuing work)
- **workflow-init:** Creates new status file and sets up project (use when starting new project)
- **workflow-status** — Checks existing status and tells you what's next (use when continuing work)
- **workflow-init** — Creates new status file and sets up project (use when starting new project)
If status file exists, use workflow-status. If not, use workflow-init.
## Q: Can I skip Phase 1 (Analysis)?
### Can I skip Phase 1 (Analysis)?
**A:** Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if:
Yes! Phase 1 is optional for all levels, though recommended for complex projects. Skip if:
- Requirements are clear
- No research needed
- Time-sensitive work
- Small changes (Level 0-1)
## Q: When is Phase 3 (Architecture) required?
### When is Phase 3 (Architecture) required?
**A:**
- **Level 0-1** — Never (skip entirely)
- **Level 2** — Optional (only if system design needed)
- **Level 3-4** — Required (comprehensive architecture mandatory)
- **Level 0-1:** Never (skip entirely)
- **Level 2:** Optional (only if system design needed)
- **Level 3-4:** Required (comprehensive architecture mandatory)
### What happens if I skip a recommended workflow?
## Q: What happens if I skip a recommended workflow?
**A:** Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause:
Nothing breaks! Workflows are guidance, not enforcement. However, skipping recommended workflows (like architecture for Level 3) may cause:
- Integration issues during implementation
- Rework due to poor planning
- Conflicting design decisions
- Longer development time overall
## Q: How do I know when Phase 3 is complete and I can start Phase 4?
### How do I know when Phase 3 is complete?
**A:** For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4.
For Level 3-4, run the implementation-readiness workflow. It validates PRD + Architecture + Epics + UX (optional) are aligned before implementation. Pass the gate check = ready for Phase 4.
## Q: Can I run workflows in parallel or do they have to be sequential?
### Can I run workflows in parallel?
**A:** Most workflows must be sequential within a phase:
Most workflows must be sequential within a phase:
- Phase 1: brainstorm → research → product-brief (optional order)
- Phase 2: PRD must complete before moving forward
- Phase 3: architecture → epics+stories → implementation-readiness (sequential)
- Phase 4: Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Get started with BMM
- [Glossary](../../reference/glossary/index.md) - Terminology reference
---
- **Phase 1** — brainstorm → research → product-brief (optional order)
- **Phase 2** — PRD must complete before moving forward
- **Phase 3** — architecture → epics+stories → implementation-readiness (sequential)
- **Phase 4** — Stories within an epic should generally be sequential, but stories in different epics can be parallel if you have capacity
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!

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

@ -2,13 +2,10 @@
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.
---
## When to Use It
- 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
- When you want the LLM to "think again" but with structured reasoning methods
---
## How It Works
### 1. Context Analysis
@ -42,9 +37,7 @@ Based on context, 5 methods are intelligently selected from a library of 50+ tec
- Each method builds on previous enhancements
### 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
@ -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 |
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
---
## Key Features
- **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
- **Party Mode integration** — Agents can participate when Party Mode is active
---
## Workflow Integration
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.
---
## Advanced Elicitation vs. Brainstorming
| | **Advanced Elicitation** | **Brainstorming** |

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

@ -2,14 +2,13 @@
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
@ -19,8 +18,6 @@ The Brainstorming workflow is an interactive facilitation system that helps you
- Systematically developing ideas from raw concepts to actionable plans
- Team ideation (with collaborative techniques) or personal creative exploration
---
## How It Works
### 1. Session Setup
@ -44,8 +41,6 @@ All your generated ideas are organized into themes and prioritized.
### 5. Action Planning
Top ideas get concrete next steps, resource requirements, and success metrics.
---
## What You Get
A comprehensive session document that captures the entire journey:
@ -57,9 +52,7 @@ A comprehensive session document that captures the entire journey:
- Prioritized ideas with action plans
- Session highlights and key breakthroughs
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
@ -76,8 +69,6 @@ This document becomes a permanent record of your creative process—valuable for
| **Cultural** | Traditional knowledge and cross-cultural approaches |
| **Introspective Delight** | Inner wisdom and authentic exploration |
---
## Key Features
- **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
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
---
## 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:

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

@ -2,8 +2,7 @@
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?
@ -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 planning** - Multi-agent collaboration for planning sessions
---
## How It Works
**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.
---
## Quick Start
```bash
@ -51,8 +46,6 @@ Ask questions, respond to agents, direct the conversation
Type: exit
```
---
## Fun Examples
### Example 1: Calling Out Bad Architecture
@ -69,8 +62,6 @@ Type: exit
_(Watch them debate whose fault it really was - it's therapeutic)_
---
### Example 2: Creative Brainstorming
**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)_
---
### Example 3: Technical Decision
**You:** "Monolith or microservices for MVP?"
@ -101,12 +90,6 @@ _(Ideas cross-pollinate and evolve)_
_(Multiple perspectives reveal the right answer)_
## Related Documentation
- [Agents Reference](../../reference/agents/index.md) - Complete agent reference
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
- [Setup Party Mode](../../how-to/workflows/setup-party-mode.md) - How to use it
---
_Better decisions through diverse perspectives. Welcome to party mode._
:::tip[Better Decisions]
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
---
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
**Time to implementation:** Minutes, not hours
---
- **Perfect for:** Bug fixes, small features, rapid prototyping, and quick enhancements
- **Time to implementation:** Minutes, not hours
## When to Use Quick Flow
### ✅ Use Quick Flow when:
### Use Quick Flow when:
- Single bug fix or small enhancement
- 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
- 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
- Need stakeholder alignment
- Complex multi-team coordination
- 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
@ -61,19 +57,15 @@ flowchart TD
style DONE fill:#f9f,stroke:#333,stroke-width:3px
```
---
## What Makes It Quick
- ✅ No Product Brief needed
- ✅ No PRD needed
- ✅ No Architecture doc needed
- ✅ Auto-detects your stack
- ✅ Auto-analyzes brownfield code
- ✅ Auto-validates quality
- ✅ Story context optional (tech-spec is comprehensive!)
---
- No Product Brief needed
- No PRD needed
- No Architecture doc needed
- Auto-detects your stack
- Auto-analyzes brownfield code
- Auto-validates quality
- Story context optional (tech-spec is comprehensive)
## 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!
---
## Auto-Validation
Quick Spec Flow **automatically validates** everything:
- ✅ Context gathering completeness
- ✅ Definitiveness (no "use X or Y" statements)
- ✅ Brownfield integration quality
- ✅ Stack alignment
- ✅ Implementation readiness
---
- Context gathering completeness
- Definitiveness (no "use X or Y" statements)
- Brownfield integration quality
- Stack alignment
- Implementation readiness
## Comparison: Quick Flow vs Full BMM
@ -145,25 +133,17 @@ Quick Spec Flow **automatically validates** everything:
| **Validation** | Auto-validates everything | Manual validation steps |
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
---
## When to Graduate to BMad Method
Start with Quick Flow, but switch to BMad Method when:
- ❌ Project grows beyond initial scope
- ❌ Multiple teams need coordination
- ❌ Stakeholders need formal documentation
- ❌ Product vision is unclear
- ❌ Architectural decisions need deep analysis
- ❌ Compliance/regulatory requirements exist
- Project grows beyond initial scope
- Multiple teams need coordination
- Stakeholders need formal documentation
- Product vision is unclear
- Architectural decisions need deep analysis
- Compliance/regulatory requirements exist
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
---
## Related
- [Create Tech Spec](../../how-to/workflows/create-tech-spec.md) - How to use Quick Flow
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started
- [Four Phases](../architecture/four-phases.md) - Understanding the full methodology
:::tip[Transition Tip]
You can always run `workflow-init` later to transition from Quick Flow to BMad Method.
:::

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

@ -6,14 +6,16 @@ description: Understanding the Test Architect (TEA) agent and its role in BMad M
The Test Architect (TEA) is a specialized agent focused on quality strategy, test automation, and release gates in BMad Method projects.
:::tip[Design Philosophy]
TEA was built to solve AI-generated tests that rot in review. For the problem statement and design principles, see [Testing as Engineering](/docs/explanation/philosophy/testing-as-engineering.md). For setup, see [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md).
:::
## Overview
- **Persona:** Murat, Master Test Architect and Quality Advisor focused on risk-based testing, fixture architecture, ATDD, and CI/CD governance.
- **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)
---
## Choose Your TEA Engagement Model
BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pick one intentionally.
@ -24,7 +26,7 @@ BMad does not mandate TEA. There are five valid ways to use it (or skip it). Pic
2. **TEA-only (Standalone)**
- Use TEA on a non-BMad project. Bring your own requirements, acceptance criteria, and environments.
- Typical sequence: `*test-design` (system or epic) -> `*atdd` and/or `*automate` -> optional `*test-review` -> `*trace` for coverage and gate decisions.
- Run `*framework` or `*ci` only if you want TEA to scaffold the harness or pipeline.
- Run `*framework` or `*ci` only if you want TEA to scaffold the harness or pipeline; they work best after you decide the stack/architecture.
3. **Integrated: Greenfield - BMad Method (Simple/Standard Work)**
- Phase 3: system-level `*test-design`, then `*framework` and `*ci`.
@ -46,10 +48,29 @@ 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.
---
## TEA Command Catalog
| Command | Primary Outputs | Notes | With Playwright MCP Enhancements |
| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) |
| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser |
| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
| `*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 | - |
## TEA Workflow Lifecycle
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and a documentation prerequisite:
- **Documentation** (Optional for brownfield): Prerequisite using `*document-project`
- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`)
- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs)
- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*test-design` (system-level) → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows)
TEA integrates into the BMad development lifecycle during Solutioning (Phase 3) and Implementation (Phase 4):
```mermaid
@ -132,87 +153,172 @@ graph TB
style Waived fill:#9c27b0,stroke:#4a148c,stroke-width:3px,color:#000
```
**Phase Numbering Note:** BMad uses a 4-phase methodology with optional Phase 1 and documentation prerequisite:
- **Documentation** (Optional for brownfield): Prerequisite using `*document-project`
- **Phase 1** (Optional): Discovery/Analysis (`*brainstorm`, `*research`, `*product-brief`)
- **Phase 2** (Required): Planning (`*prd` creates PRD with FRs/NFRs)
- **Phase 3** (Track-dependent): Solutioning (`*architecture` → `*test-design` (system-level) → `*create-epics-and-stories` → TEA: `*framework`, `*ci` → `*implementation-readiness`)
- **Phase 4** (Required): Implementation (`*sprint-planning` → per-epic: `*test-design` → per-story: dev workflows)
**TEA workflows:** `*framework` and `*ci` run once in Phase 3 after architecture. `*test-design` is **dual-mode**:
- **System-level (Phase 3):** Run immediately after architecture/ADR drafting to produce `test-design-system.md` (testability review, ADR → test mapping, Architecturally Significant Requirements (ASRs), environment needs). Feeds the implementation-readiness gate.
- **Epic-level (Phase 4):** Run per-epic to produce `test-design-epic-N.md` (risk, priorities, coverage plan).
Quick Flow track skips Phases 1 and 3.
The Quick Flow track skips Phases 1 and 3.
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.
---
## 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**.
### Phase-Specific Agents (Standard Pattern)
Most BMM agents work in a single phase:
- **Phase 1 (Analysis)**: Analyst agent
- **Phase 2 (Planning)**: PM agent
- **Phase 3 (Solutioning)**: Architect agent
- **Phase 4 (Implementation)**: SM, DEV agents
### TEA: Multi-Phase Quality Agent (Unique Pattern)
TEA is **the only agent that operates in multiple phases**:
```
Phase 1 (Analysis) → [TEA not typically used]
↓
Phase 2 (Planning) → [PM defines requirements - TEA not active]
↓
Phase 3 (Solutioning) → TEA: *framework, *ci (test infrastructure AFTER architecture)
↓
Phase 4 (Implementation) → TEA: *test-design (per epic: "how do I test THIS feature?")
→ TEA: *atdd, *automate, *test-review, *trace (per story)
↓
Epic/Release Gate → TEA: *nfr-assess, *trace Phase 2 (release decision)
```
TEA spans multiple phases (Phase 3, Phase 4, and the release gate). Most BMM agents operate in a single phase. That multi-phase role is paired with a dedicated testing knowledge base so standards stay consistent across projects.
### TEA's 8 Workflows Across Phases
**Standard agents**: 1-3 workflows per phase
**TEA**: 8 workflows across Phase 3, Phase 4, and Release Gate
| Phase | TEA Workflows | Frequency | Purpose |
| ----------- | --------------------------------------------------------- | ---------------- | ---------------------------------------------- |
| **Phase 2** | (none) | - | Planning phase - PM defines requirements |
| **Phase 3** | \*framework, \*ci | Once per project | Setup test infrastructure AFTER architecture |
| **Phase 3** | \*test-design (system-level), \*framework, \*ci | Once per project | System testability review and test infrastructure setup |
| **Phase 4** | \*test-design, \*atdd, \*automate, \*test-review, \*trace | Per epic/story | Test planning per epic, then per-story testing |
| **Release** | \*nfr-assess, \*trace (Phase 2: gate) | Per epic/release | Go/no-go decision |
**Note**: `*trace` is a two-phase workflow: Phase 1 (traceability) + Phase 2 (gate decision). This reduces cognitive load while maintaining natural workflow.
---
### Why TEA Requires Its Own Knowledge Base
## TEA Command Catalog
TEA uniquely requires:
| Command | Primary Outputs | Notes |
| -------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| `*framework` | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists |
| `*ci` | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) |
| `*test-design` | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode |
| `*atdd` | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode |
| `*automate` | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage |
| `*test-review` | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns |
| `*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 |
- **Extensive domain knowledge**: Test patterns, CI/CD, fixtures, and quality practices
- **Cross-cutting concerns**: Standards that apply across all BMad projects (not just PRDs or stories)
- **Optional integrations**: Playwright-utils and MCP enhancements
---
This architecture lets TEA maintain consistent, production-ready testing patterns while operating across multiple phases.
## Related Documentation
## Track Cheat Sheets (Condensed)
- [Setup Test Framework](../../how-to/workflows/setup-test-framework.md) - How to set up testing infrastructure
- [Run Test Design](../../how-to/workflows/run-test-design.md) - Creating test plans
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).
**Note:** The Quick Flow track typically doesn't require TEA (covered in Overview). These cheat sheets focus on BMad Method and Enterprise tracks where TEA adds value.
**Legend for Track Deltas:**
- ➕ = New workflow or phase added (doesn't exist in baseline)
- 🔄 = Modified focus (same workflow, different emphasis or purpose)
- 📦 = Additional output or archival requirement
### Greenfield - BMad Method (Simple/Standard Work)
**Planning Track:** BMad Method (PRD + Architecture)
**Use Case:** New projects with standard complexity
| Workflow Stage | Test Architect | Dev / Team | Outputs |
| -------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| **Phase 1**: Discovery | - | Analyst `*product-brief` (optional) | `product-brief.md` |
| **Phase 2**: Planning | - | PM `*prd` (creates PRD with FRs/NFRs) | PRD with functional/non-functional requirements |
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test scaffold, CI pipeline |
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic (per-epic test plan) | Review epic scope | `test-design-epic-N.md` with risk assessment and test plan |
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
| **Phase 4**: Story Review | Execute `*test-review` (optional), re-run `*trace` | Address recommendations, update code/tests | Quality report, refreshed coverage matrix |
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Confirm Definition of Done, share release notes | Quality audit, Gate YAML + release summary |
**Key notes:**
- Run `*framework` and `*ci` once in Phase 3 after architecture.
- Run `*test-design` per epic in Phase 4; use `*atdd` before dev when helpful.
- Use `*trace` for gate decisions; `*test-review` is an optional audit.
### Brownfield - BMad Method or Enterprise (Simple or Complex)
**Planning Tracks:** BMad Method or Enterprise Method
**Use Case:** Existing codebases: simple additions (BMad Method) or complex enterprise requirements (Enterprise Method)
**🔄 Brownfield Deltas from Greenfield:**
- ➕ Documentation (Prerequisite) - Document existing codebase if undocumented
- ➕ Phase 2: `*trace` - Baseline existing test coverage before planning
- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks
- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier
| Workflow Stage | Test Architect | Dev / Team | Outputs |
| --------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
**Key notes:**
- Start with `*trace` in Phase 2 to baseline coverage.
- Focus `*test-design` on regression hotspots and integration risk.
- Run `*nfr-assess` before the gate if it wasn't done earlier.
### Greenfield - Enterprise Method (Enterprise/Compliance Work)
**Planning Track:** Enterprise Method (BMad Method + extended security/devops/test strategies)
**Use Case:** New enterprise projects with compliance, security, or complex regulatory requirements
**🏢 Enterprise Deltas from BMad Method:**
- ➕ Phase 1: `*research` - Domain and compliance research (recommended)
- ➕ Phase 2: `*nfr-assess` - Capture NFR requirements early (security/performance/reliability)
- 🔄 Phase 4: `*test-design` - Enterprise focus (compliance, security architecture alignment)
- 📦 Release Gate - Archive artifacts and compliance evidence for audits
| Workflow Stage | Test Architect | Dev / Team | Outputs |
| -------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief |
| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation |
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics |
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus |
| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices |
| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail |
**Key notes:**
- Run `*nfr-assess` early in Phase 2.
- `*test-design` emphasizes compliance, security, and performance alignment.
- Archive artifacts at the release gate for audits.
**Related how-to guides:**
- [How to Run Test Design](/docs/how-to/workflows/run-test-design.md)
- [How to Set Up a Test Framework](/docs/how-to/workflows/setup-test-framework.md)
## Optional Integrations
### Playwright Utils (`@seontechnologies/playwright-utils`)
Production-ready fixtures and utilities that enhance TEA workflows.
- Install: `npm install -D @seontechnologies/playwright-utils`
> Note: Playwright Utils is enabled via the installer. Only set `tea_use_playwright_utils` in `_bmad/bmm/config.yaml` if you need to override the installer choice.
- Impacts: `*framework`, `*atdd`, `*automate`, `*test-review`, `*ci`
- Utilities include: api-request, auth-session, network-recorder, intercept-network-call, recurse, log, file-utils, burn-in, network-error-monitor, fixtures-composition
### Playwright MCP Enhancements
Live browser verification for test design and automation.
**Two Playwright MCP servers** (actively maintained, continuously updated):
- `playwright` - Browser automation (`npx @playwright/mcp@latest`)
- `playwright-test` - Test runner with failure analysis (`npx playwright run-test-mcp-server`)
**Configuration example**:
```json
{
"mcpServers": {
"playwright": {
"command": "npx",
"args": ["@playwright/mcp@latest"]
},
"playwright-test": {
"command": "npx",
"args": ["playwright", "run-test-mcp-server"]
}
}
}
```
- Helps `*test-design` validate actual UI behavior.
- Helps `*atdd` and `*automate` verify selectors against the live DOM.
- Enhances healing with `browser_snapshot`, console, network, and locator tools.
**To disable**: set `tea_use_mcp_enhancements: false` in `_bmad/bmm/config.yaml` or remove MCPs from IDE config.

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

@ -2,12 +2,11 @@
title: "Web Bundles"
---
Use BMad agents in Gemini Gems and Custom GPTs.
Use BMAD agents in Gemini Gems and Custom GPTs.
## Status
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
:::caution[Status]
The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
:::
## What Are Web Bundles?
@ -25,7 +24,7 @@ Web bundles package BMad agents as self-contained files that work in Gemini Gems
**Perfect for:**
- Uploading a single file to a Gemini GEM or Custom GPT
- Using BMAD Method from the Web
- Using BMad Method from the Web
- Cost savings (generally lower cost than local usage)
- Quick sharing of agent configurations
@ -33,5 +32,3 @@ Web bundles package BMad agents as self-contained files that work in Gemini Gems
- Some quality reduction vs local usage
- Less convenient than full local installation
- Limited to agent capabilities (no workflow file access)
[← Back to Core Concepts](../index.md)

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

@ -2,27 +2,22 @@
title: "BMGD Agents Guide"
---
Complete reference for BMGD's six specialized game development agents.
---
## Agent Overview
BMGD provides six agents, each with distinct expertise:
| Agent | Name | Role | Phase Focus |
| ------------------------ | ---------------- | ----------------------------------------------------------- | ----------- |
| 🎲 **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 Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | 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 Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
|-------|------|------|-------------|
| **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 Developer** | Link Freeman | Senior Game Developer + Technical Implementation Specialist | 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 Solo Dev** | Indie | Elite Indie Game Developer + Quick Flow Specialist | All Phases |
---
## 🎲 Game Designer (Samus Shepard)
## Game Designer (Samus Shepard)
### Role
@ -62,9 +57,7 @@ Talks like an excited streamer - enthusiastic, asks about player motivations, ce
| `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) |
---
## 🏛️ Game Architect (Cloud Dragonborn)
## Game Architect (Cloud Dragonborn)
### Role
@ -102,9 +95,7 @@ Speaks like a wise sage from an RPG - calm, measured, uses architectural metapho
| `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) |
---
## 🕹️ Game Developer (Link Freeman)
## Game Developer (Link Freeman)
### Role
@ -144,9 +135,7 @@ Speaks like a speedrunner - direct, milestone-focused, always optimizing for the
| `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) |
---
## 🎯 Game Scrum Master (Max)
## Game Scrum Master (Max)
### Role
@ -190,9 +179,7 @@ Talks in game terminology - milestones are save points, handoffs are level trans
| `party-mode` | Multi-agent collaboration |
| `advanced-elicitation` | Deep exploration (web only) |
---
## 🧪 Game QA (GLaDOS)
## Game QA (GLaDOS)
### Role
@ -265,9 +252,7 @@ GLaDOS has access to a comprehensive game testing knowledge base (`gametest/qa-i
- Smoke testing
- Test prioritization (P0-P3)
---
## 🎮 Game Solo Dev (Indie)
## Game Solo Dev (Indie)
### Role
@ -303,7 +288,7 @@ Direct, confident, and gameplay-focused. Uses dev slang, thinks in game feel and
| ------------------ | ------------------------------------------------------ |
| `quick-prototype` | Rapid prototype to test if a mechanic is fun |
| `quick-dev` | Implement features end-to-end with game considerations |
| `create-tech-spec` | Create implementation-ready technical spec |
| `quick-spec` | Create implementation-ready technical spec |
| `code-review` | Review code quality |
| `test-framework` | Set up automated testing |
| `party-mode` | Bring in specialists when needed |
@ -324,8 +309,6 @@ Use **Full BMGD workflow** when:
- You're working with stakeholders/publishers
- Long-term maintainability is critical
---
## Agent Selection Guide
### By Phase
@ -359,8 +342,6 @@ Use **Full BMGD workflow** when:
| "Quick prototype this idea" | Game Solo Dev |
| "Ship this feature fast" | Game Solo Dev |
---
## Multi-Agent Collaboration
### Party Mode
@ -391,8 +372,6 @@ Game QA integrates at multiple points:
- During Implementation: Create automated tests
- Before Release: Performance and certification testing
---
## Project Context
All agents share the principle:
@ -401,10 +380,8 @@ All agents share the principle:
The `project-context.md` file (if present) serves as the authoritative source for project decisions and constraints.
---
## Next Steps
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
- **[Workflows Guide](../../reference/workflows/index.md)** - Detailed workflow reference
- **[Game Types Guide](../../explanation/game-dev/game-types.md)** - Game type templates
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
- **[Workflows Guide](/docs/reference/workflows/index.md)** - Detailed workflow reference
- **[Game Types Guide](/docs/explanation/game-dev/game-types.md)** - Game type templates

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
---
BMGD (BMad Game Development) extends BMM (BMad Method) with game-specific capabilities. This page explains the key differences.
---
## Quick Comparison
| 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) |
| **Production** | BMM workflows | BMM workflows with game overrides |
---
## Agent Differences
### BMM Agents
@ -46,8 +41,6 @@ BMGD agents understand game-specific concepts like:
- Engine-specific patterns
- Playtesting and QA
---
## Planning Documents
### BMM Planning
@ -65,8 +58,6 @@ The GDD (Game Design Document) includes:
- Art and audio direction
- Genre-specific sections
---
## Game Type Templates
BMGD includes 24 game type templates that auto-configure GDD sections:
@ -83,8 +74,6 @@ Each template provides:
- Testing considerations
- Common pitfalls to avoid
---
## Narrative Support
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.
---
## Testing Differences
### BMM Testing (TEA)
@ -113,8 +100,6 @@ BMM has no equivalent for narrative design.
- Playtest planning
- Balance validation
---
## Production Workflow
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.
---
## When to Use Each
### Use BMM when:
@ -140,11 +123,3 @@ This means you get all of BMM's implementation structure plus game-specific enha
- Creating interactive experiences
- Game prototyping
- Game jams
---
## Related
- [BMGD Overview](./index.md) - Getting started with BMGD
- [Game Types Guide](./game-types.md) - Understanding game templates
- [Quick Start BMGD](../../tutorials/getting-started/quick-start-bmgd.md) - Tutorial

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

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

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

@ -3,31 +3,26 @@ title: "BMGD - Game Development Module"
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
**New to BMGD?** Start here:
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started building your first game
- **[Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)** - Get started building your first game
- Installation and setup
- Understanding the game development phases
- Running your first workflows
- 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
- **[Game Types Guide](./game-types.md)** - Selecting and using game type templates (24 supported types)
- **[BMGD vs BMM](./bmgd-vs-bmm.md)** - Understanding the differences
---
- **[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
## Game Development Phases
@ -51,14 +46,12 @@ BMGD follows four phases aligned with game development:
- **Testing** - Automated tests, playtesting, performance
- **Retrospective** - Continuous improvement
---
## Choose Your Path
### I need to...
**Start a new game project**
→ Start with [Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)
→ Start with [Quick Start Guide](/docs/tutorials/getting-started/quick-start-bmgd.md)
→ Run `brainstorm-game` for ideation
→ Create a Game Brief with `create-brief`
@ -74,12 +67,4 @@ BMGD follows four phases aligned with game development:
→ Follow the sprint-based development cycle
**Quickly test an idea**
→ Use [Quick-Flow](../../how-to/workflows/bmgd-quick-flow.md) for rapid prototyping
---
## Related
- [Game Types Guide](./game-types.md) - Understanding game type templates
- [BMGD vs BMM](./bmgd-vs-bmm.md) - Comparison with core method
- [Glossary](../../reference/glossary/index.md) - Terminology reference
→ Use [Quick-Flow](/docs/how-to/workflows/bmgd-quick-flow.md) for rapid prototyping

35
docs/explanation/index.md
View File

@ -1,35 +0,0 @@
---
title: "Explanation"
---
Understanding-oriented content that explains concepts, architecture, and the reasoning behind BMAD's design.
## Core Concepts
Foundational concepts you need to understand BMAD.
- [What are Agents?](./core-concepts/what-are-agents.md)
- [What are Workflows?](./core-concepts/what-are-workflows.md)
- [What are Modules?](./core-concepts/what-are-modules.md)
## Architecture
How BMAD is designed and why.
## Philosophy
The thinking behind BMAD's approach.
## Features
Deep dives into specific BMAD features.
- [Party Mode](./features/party-mode.md)
- [Brainstorming Techniques](./features/brainstorming-techniques.md)
- [Advanced Elicitation](./features/advanced-elicitation.md)
- [Web Bundles](./features/web-bundles.md)
## Modules
Explanations of BMAD's module ecosystem.

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 Problem with Generation
Traditional AI approaches to creative work:
```
User: "Give me marketing ideas"
AI: "Here are 10 marketing ideas..."
```
:::note[Generation Example]
**User:** "Give me marketing ideas"
**AI:** "Here are 10 marketing ideas..."
:::
This approach:
- Produces generic, predictable outputs
@ -23,20 +22,19 @@ This approach:
- Misses context and nuance
- Limits creative exploration
---
## The Facilitation Approach
CIS agents use strategic questioning:
```
User: "I need marketing ideas"
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
support visible before they become customers?"
```
:::note[Facilitation Example]
**User:** "I need marketing ideas"
**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 support visible before they become customers?"
:::
This approach:
- Draws out insights already within you
@ -44,8 +42,6 @@ This approach:
- Captures context and nuance
- Enables deeper creative exploration
---
## Key Principles
### 1. Questions Over Answers
@ -85,8 +81,6 @@ Each CIS agent has a distinct personality:
These personas create engaging experiences that maintain creative flow.
---
## When Generation is Appropriate
CIS does generate when appropriate:
@ -97,8 +91,6 @@ CIS does generate when appropriate:
But the core creative work happens through facilitated discovery.
---
## Benefits
### For Individuals
@ -112,10 +104,3 @@ But the core creative work happens through facilitated discovery.
- Aligned understanding
- Documented rationale
- Stronger buy-in to outcomes
---
## Related
- [Creative Intelligence Suite](../creative-intelligence/index.md) - CIS overview
- [Brainstorming Techniques](../features/brainstorming-techniques.md) - Available techniques

112
docs/explanation/philosophy/testing-as-engineering.md Normal file
View File

@ -0,0 +1,112 @@
---
title: "AI-Generated Testing: Why Most Approaches Fail"
description: How Playwright-Utils, TEA workflows, and Playwright MCPs solve AI test quality problems
---
AI-generated tests frequently fail in production because they lack systematic quality standards. This document explains the problem and presents a solution combining three components: Playwright-Utils, TEA (Test Architect), and Playwright MCPs.
:::note[Source]
This article is adapted from [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) by Murat K Ozcan.
:::
## The Problem with AI-Generated Tests
When teams use AI to generate tests without structure, they often produce what can be called "slop factory" outputs:
| Issue | Description |
|-------|-------------|
| Redundant coverage | Multiple tests covering the same functionality |
| Incorrect assertions | Tests that pass but don't actually verify behavior |
| Flaky tests | Non-deterministic tests that randomly pass or fail |
| Unreviewable diffs | Generated code too verbose or inconsistent to review |
The core problem is that prompt-driven testing paths lean into nondeterminism, which is the exact opposite of what testing exists to protect.
:::caution[The Paradox]
AI excels at generating code quickly, but testing requires precision and consistency. Without guardrails, AI-generated tests amplify the chaos they're meant to prevent.
:::
## The Solution: A Three-Part Stack
The solution combines three components that work together to enforce quality:
### Playwright-Utils
Bridges the gap between Cypress ergonomics and Playwright's capabilities by standardizing commonly reinvented primitives through utility functions.
| Utility | Purpose |
|---------|---------|
| api-request | API calls with schema validation |
| auth-session | Authentication handling |
| intercept-network-call | Network mocking and interception |
| recurse | Retry logic and polling |
| log | Structured logging |
| network-recorder | Record and replay network traffic |
| burn-in | Smart test selection for CI |
| network-error-monitor | HTTP error detection |
| file-utils | CSV/PDF handling |
These utilities eliminate the need to reinvent authentication, API calls, retries, and logging for every project.
### TEA (Test Architect Agent)
A quality operating model packaged as eight executable workflows spanning test design, CI/CD gates, and release readiness. TEA encodes test architecture expertise into repeatable processes.
| Workflow | Purpose |
|----------|---------|
| `*test-design` | Risk-based test planning per epic |
| `*framework` | Scaffold production-ready test infrastructure |
| `*ci` | CI pipeline with selective testing |
| `*atdd` | Acceptance test-driven development |
| `*automate` | Prioritized test automation |
| `*test-review` | Test quality audits (0-100 score) |
| `*nfr-assess` | Non-functional requirements assessment |
| `*trace` | Coverage traceability and gate decisions |
:::tip[Key Insight]
TEA doesn't just generate tests—it provides a complete quality operating model with workflows for planning, execution, and release gates.
:::
### Playwright MCPs
Model Context Protocols enable real-time verification during test generation. Instead of inferring selectors and behavior from documentation, MCPs allow agents to:
- Run flows and confirm the DOM against the accessibility tree
- Validate network responses in real-time
- Discover actual functionality through interactive exploration
- Verify generated tests against live applications
## How They Work Together
The three components form a quality pipeline:
| Stage | Component | Action |
|-------|-----------|--------|
| Standards | Playwright-Utils | Provides production-ready patterns and utilities |
| Process | TEA Workflows | Enforces systematic test planning and review |
| Verification | Playwright MCPs | Validates generated tests against live applications |
**Before (AI-only):** 20 tests with redundant coverage, incorrect assertions, and flaky behavior.
**After (Full Stack):** Risk-based selection, verified selectors, validated behavior, reviewable code.
## Why This Matters
Traditional AI testing approaches fail because they:
- **Lack quality standards** — No consistent patterns or utilities
- **Skip planning** — Jump straight to test generation without risk assessment
- **Can't verify** — Generate tests without validating against actual behavior
- **Don't review** — No systematic audit of generated test quality
The three-part stack addresses each gap:
| Gap | Solution |
|-----|----------|
| No standards | Playwright-Utils provides production-ready patterns |
| No planning | TEA `*test-design` workflow creates risk-based test plans |
| No verification | Playwright MCPs validate against live applications |
| 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.

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
---
Add new functionality to your brownfield codebase while respecting existing patterns and architecture.
---
Use the `workflow-init` workflow to add new functionality to your brownfield codebase while respecting existing patterns and architecture.
## 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
- Features that touch multiple parts of the system
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- Existing project documentation (run `document-project` first if needed)
- Clear understanding of what you want to build
---
:::
## Steps
@ -73,19 +66,9 @@ Follow the standard Phase 4 implementation workflows:
3. `dev-story` - Implement with tests
4. `code-review` - Quality assurance
---
## Tips
- Always ensure agents read your existing documentation
- Pay attention to integration points with existing code
- Follow existing conventions unless deliberately changing them
- Document why you're adding new patterns (if any)
---
## Related
- [Brownfield Development Guide](./index.md)
- [Document Existing Project](./document-existing-project.md)
- [Quick Fix in 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
---
Use the `document-project` workflow to scan your entire codebase and generate comprehensive documentation about its current state.
---
## When to Use This
- 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
- Onboarding new team members
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed in your project
- Access to the codebase you want to document
---
:::
## Steps
@ -58,8 +51,6 @@ Review the documentation for:
- Completeness of architecture description
- Any missing business rules or intent
---
## What You Get
- **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
- **Integration points** - External APIs and services
---
## Tips
- Run this before any major brownfield work
- Keep the documentation updated as the project evolves
- Use it as input for future PRD creation
---
## Related
- [Brownfield Development Guide](./index.md)
- [Add Feature to Existing Project](./add-feature-to-existing.md)

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

@ -3,24 +3,19 @@ title: "Brownfield Development"
description: How to use BMad Method on existing codebases
---
How to effectively use BMad Method when working on existing projects and legacy codebases.
Use BMad Method effectively when working on existing projects and legacy codebases.
## 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.
This tutorial covers the essential workflow for onboarding to brownfield projects with BMad Method.
---
## Prerequisites
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
:::note[Prerequisites]
- BMad Method installed (`npx bmad-method install`)
- An existing codebase you want to work on
- Access to an AI-powered IDE (Claude Code, Cursor, or Windsurf)
---
:::
## 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/implementation-artifacts/`
---
## Step 2: Maintain Quality Project Documentation
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.
---
## 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.
@ -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.
---
## Next Steps
- **[Document Existing Project](../../how-to/brownfield/document-existing-project.md)** - How to document your brownfield codebase
- **[Add Feature to Existing Project](../../how-to/brownfield/add-feature-to-existing.md)** - Adding new functionality
- **[Quick Fix in Brownfield](../../how-to/brownfield/quick-fix-in-brownfield.md)** - Bug fixes and ad-hoc changes
- **[Brownfield FAQ](../../explanation/faq/brownfield-faq.md)** - Common questions about brownfield development
---
## Related Documentation
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
- [Quick Spec Flow](../../explanation/features/quick-flow.md) - Fast path for small changes
- **[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
- **[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

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
---
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.
---
Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full BMad method or Quick Flow.
## 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
- One-off changes that don't need planning
---
## Steps
### 1. Load an Agent
@ -54,8 +49,6 @@ The agent will:
Review the changes made and commit when satisfied.
---
## Learning Your Codebase
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
- Explore unfamiliar parts of the codebase
---
## When to Upgrade to Formal Planning
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
- The fix keeps growing in complexity
- You need documentation for the change
---
## Related
- [Brownfield Development Guide](./index.md)
- [Add Feature to Existing Project](./add-feature-to-existing.md)
- [Quick Spec Flow](../../explanation/features/quick-flow.md)

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

@ -2,8 +2,14 @@
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
@ -201,8 +207,6 @@ memories:
## Next Steps
- **[Learn about Agents](../../explanation/core-concepts/what-are-agents.md)** - Understand Simple vs Expert agents
- **[Agent Creation Guide](../../tutorials/advanced/create-custom-agent.md)** - Build completely custom agents
- **[BMM Complete Documentation](../../explanation/bmm/index.md)** - Full BMad Method reference
[← Back to Customization](./index.md)
- **[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
- **[BMM Complete Documentation](/docs/explanation/bmm/index.md)** - Full BMad Method reference

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

@ -1,29 +1,23 @@
---
title: "BMAD Customization"
title: "BMad Customization"
---
Personalize agents and workflows to match your needs.
## Guides
| Guide | Description |
|-------|-------------|
| **[Agent Customization](./customize-agents.md)** | Modify agent behavior without editing core files |
| **[Workflow Customization](./customize-workflows.md)** | Customize and optimize workflows |
| **[Agent Customization](/docs/how-to/customization/customize-agents.md)** | Modify agent behavior without editing core files |
## Overview
BMAD provides two main customization approaches:
BMad provides two main customization approaches:
### 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.
### Workflow Customization
Replace or extend workflow steps to create tailored processes. (Coming soon)
---
**Next:** Read the [Agent Customization Guide](./customize-agents.md) to start personalizing your agents.
[← Back to Core Concepts](../index.md)

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

@ -2,16 +2,14 @@
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
- [What is Document Sharding?](#what-is-document-sharding)
- [When to Use Sharding](#when-to-use-sharding)
- [How Sharding Works](#how-sharding-works)
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
- [Workflow Support](#workflow-support)
- 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
## What is Document Sharding?
@ -39,43 +37,15 @@ docs/
└── ... # Additional sections
```
## When to Use Sharding
## Steps
### Ideal Candidates
**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
### 1. Run the Shard-Doc Tool
```bash
/bmad:core:tools:shard-doc
```
### Interactive Process
### 2. Follow the Interactive Process
```
Agent: Which document would you like to shard?
@ -91,7 +61,7 @@ Agent: Sharding PRD.md...
✓ Complete!
```
### What Gets Created
## What You Get
**index.md structure:**
@ -113,13 +83,19 @@ Agent: Sharding PRD.md...
- Preserves all markdown formatting
- 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
### Universal Support
All BMM workflows support both formats:
**All BMM workflows support both formats:**
- ✅ Whole documents
- ✅ Sharded documents
- ✅ Automatic detection
- ✅ Transparent to user
- Whole documents
- Sharded documents
- Automatic detection
- Transparent to user

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

@ -1,43 +1,40 @@
---
title: "How to Get Answers About BMAD"
description: Use an LLM to quickly answer your own BMAD questions
title: "How to Get Answers About BMad"
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]
**Q:** "Tell me the fastest way to build something with BMAD"
- You have a question about how BMad works
- You want to understand a specific agent or workflow
- You need quick answers without waiting for Discord
**A:** Use Quick Flow: Run `create-tech-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.
## How to Do It
### What Each Source Gives You
### 1. Choose Your Source
| 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?" |
| **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?" |
| **`llms-full.txt`** | Quick overview from documentation perspective | "Explain BMAD's four phases" "What's the difference between levels?" |
| **`_bmad` folder** | How BMad works—agents, workflows, prompts | "What does the PM agent do?" |
| **Full GitHub repo** | History, installer, architecture | "What changed in v6?" |
| **`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. 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.
:::
The `_bmad` folder is created when you install BMad. If you don't have it yet, clone the repo instead.
### 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:
@ -45,12 +42,25 @@ Fetch `llms-full.txt` into your session:
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
```
You can also find this and other downloadable resources on the [Downloads page](/downloads).
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
:::tip[Verify Surprising Answers]
LLMs occasionally get things wrong. If an answer seems off, check the source file it referenced or ask on Discord.
### 3. Ask Your Question
:::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?
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)
## Found a Bug?
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)
---
**GitHub Issues:** [github.com/bmad-code-org/BMAD-METHOD/issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) (for clear bugs)
*You!*
*Stuck*

36
docs/how-to/index.md
View File

@ -1,36 +0,0 @@
---
title: "How-To Guides"
---
Task-oriented guides that show you how to accomplish specific goals. Each guide assumes you already understand the basics.
## Installation
- [Upgrade to V6](./installation/upgrade-to-v6.md)
- [Install Custom Modules](./installation/install-custom-modules.md)
## IDE Setup
*Coming soon*
## Customization
- [Customize Agents](./customization/customize-agents.md)
- [Customize Workflows](./customization/customize-workflows.md)
- [Vendor Workflows](./customization/vendor-workflows.md)
- [Shard Large Documents](./customization/shard-large-documents.md)
## Workflows
Guides for running specific BMAD workflows.
## Brownfield Projects
Working with existing codebases.
## Troubleshooting
Solutions to common problems.
- [Get Answers About BMAD](./get-answers-about-bmad.md)

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

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

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

@ -1,20 +1,21 @@
---
title: "How to Install BMAD"
description: Step-by-step guide to installing BMAD in your project
title: "How to Install BMad"
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
---
## Prerequisites
- Starting a new project with BMad
- Adding BMad to an existing codebase
- Setting up BMad on a new machine
:::note[Prerequisites]
- **Node.js** 20+ (required for the installer)
- **Git** (recommended)
- **AI-powered IDE** (Claude Code, Cursor, Windsurf, or similar)
---
:::
## Steps
@ -26,7 +27,8 @@ npx bmad-method install
### 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)
- Subdirectory
- Custom path
@ -34,12 +36,13 @@ The installer will ask where to install BMAD files. Options:
### 3. Select Your AI Tools
Choose which AI tools you'll be using:
- Claude Code
- Cursor
- Windsurf
- Other
The installer configures BMAD for your selected tools.
The installer configures BMad for your selected tools.
### 4. Choose Modules
@ -54,29 +57,13 @@ Select which modules to install:
### 5. Add Custom Content (Optional)
If you have custom agents, workflows, or modules:
- Point to their location
- The installer will integrate them
If you have custom agents, workflows, or modules, point to their location and the installer will integrate them.
### 6. Configure Settings
For each module, either:
- Accept recommended defaults (faster)
- Customize settings (more control)
For each module, either accept recommended defaults (faster) or customize settings (more control).
---
## 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
## What You Get
```
your-project/
@ -91,7 +78,11 @@ your-project/
└── .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
@ -103,36 +94,19 @@ user_name: Your Name
communication_language: english
```
---
## Troubleshooting
### "Command not found: npx"
Install Node.js 20+:
**"Command not found: npx"** — Install Node.js 20+:
```bash
brew install node
```
### "Permission denied"
Check npm permissions:
**"Permission denied"** — Check npm permissions:
```bash
npm config set prefix ~/.npm-global
```
### Installer hangs
Try running with verbose output:
**Installer hangs** — Try running with verbose output:
```bash
npx bmad-method install --verbose
```
---
## Related
- [Quick Start Guide](../../tutorials/getting-started/getting-started-bmadv6.md) - Getting started with BMM
- [Upgrade to V6](./upgrade-to-v6.md) - Upgrading from previous versions
- [Install Custom Modules](./install-custom-modules.md) - Adding custom content

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

@ -1,152 +1,118 @@
---
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](../../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
- Custom Add On Modules
- Custom Global Modules
- Custom Agents
- Custom Workflows
Your custom content needs a `module.yaml` file. Choose the appropriate structure:
## 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/
module.yaml
agents/
workflows/
tools/
templates/
...
```
```
- `agents/` - Agent definitions
- `workflows/` - Workflow definitions
- Additional custom folders are supported but following conventions is recommended for agent and workflow discovery
**For standalone items** (unrelated agents/workflows):
**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
agents/
workflows/
templates/
tools/
tasks/
prompts/
```
3. **Individual Item Organization**
Each item should have its own subfolder:
```text
my-custom-stuff/
module.yaml
agents/
larry/larry.agent.md
curly/curly.agent.md
moe/moe.agent.md
moe/moe-sidecar/memories.csv
```
workflows/
```
**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)`
2. Select 'y' to specify the path to your module folder containing `module.yaml`
1. Select `Modify BMad Installation`
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
2. Select `Modify BMAD Installation`
3. Choose the option to add, modify, or update custom modules
## What You Get
### 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
- **Add-on Module Dependencies:** The installer will verify and install dependencies for add-on modules automatically
## Content Types
## 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
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
For detailed information about content types, see [Custom Content Types](/docs/explanation/bmad-builder/custom-content-types.md).
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)
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
## Tips
**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)
- Don't name multiple custom modules with the same code like `mca`
:::caution[Naming Conflicts]
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
- Document any dependencies your custom modules have
- Test custom modules in isolation before sharing
- Consider version numbering for your custom content to track updates
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.

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

@ -1,147 +1,131 @@
---
title: "BMad v4 to v6 Upgrade Guide"
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
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
- 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`
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
### 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/
```bash
npx bmad-method install
```
**v6 Unified Structure:**
The installer automatically detects:
```
your-project/
└── _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)
- **Legacy v4 folder**: `.bmad-method`
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
```
### 2. Handle Legacy Installation
### Key Concept Changes
When v4 is detected, you can:
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method
- **v6 `_bmad/core/`**: Is the real universal core framework
- **v6 `_bmad/bmm/`**: Is the BMad Method module
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
- Allow the installer to back up and remove `.bmad-method`
- Exit and handle cleanup manually
- Keep both (not recommended for same project)
## 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:
PRD has PRD in the file name or folder name if sharded.
Similar for 'brief', 'architecture', 'ux-design'.
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
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
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.
Move them to `_bmad-output/planning-artifacts/` with descriptive names:
## 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
# Customize the PM agent
# _bmad/_config/agents/bmm-pm.customize.yaml
persona:
name: 'Captain Jack' # Override agent name
name: 'Captain Jack'
role: 'Swashbuckling Product Owner'
communication_style: |
- Talk like a pirate
- Use nautical metaphors for software concepts
- Always upbeat and adventurous
- Use nautical metaphors
```
There is a lot more that is possible with agent customization, which is covered in detail in the [Agent Customization Guide](../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`
- Rebuild all agents -> Result: Agent uses your custom name and style
```
your-project/
└── _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)
- ✅ Unsharded documents (single file per section)
- ✅ Custom sections for your project type
- ✅ Mixed approaches
| Concept | v4 | v6 |
|---------|----|----|
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
| **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

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

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

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

@ -1,52 +1,41 @@
---
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.
---
## 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
- `create-tech-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:
## When to Use This
- Testing a game mechanic idea
- Implementing a small feature
- Rapid prototyping before committing to design
- Bug fixes and tweaks
```
Full BMGD Flow:
Brief → GDD → Architecture → Sprint Planning → Stories → Implementation
## When to Use Full BMGD Instead
Quick-Flow:
Idea → Quick-Prototype → Quick-Dev → Done
```
- 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
---
:::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
**Command:** `quick-prototype`
**Agent:** Game Designer, Game Developer
**Purpose:** Rapidly test gameplay ideas with minimal setup
Use `quick-prototype` to rapidly test gameplay ideas with minimal setup.
### When to Use
@ -55,60 +44,31 @@ Idea → Quick-Prototype → Quick-Dev → Done
- You want to experiment before committing to design
- You need a proof of concept
### Workflow Steps
### Steps
1. **Define Scope** - What are you prototyping? (mechanic, feature, system)
2. **Set Success Criteria** - How will you know if it works?
3. **Rapid Implementation** - Build the minimum to test the idea
4. **Playtest and Evaluate** - Does it feel right?
1. Run `quick-prototype`
2. Define what you're prototyping (mechanic, feature, system)
3. Set success criteria (2-3 items)
4. Build the minimum to test the idea
5. Playtest and evaluate
### Prototype Principles
- **Minimum Viable Prototype** - Only what's needed to test the idea
- **Hardcode First** - Magic numbers are fine, extract later
- **Skip Edge Cases** - Happy path only for now
- **Placeholder Everything** - Cubes, debug text, temp sounds
- **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
```
- **Minimum Viable Prototype** — Only what's needed to test the idea
- **Hardcode First** — Magic numbers are fine, extract later
- **Skip Edge Cases** — Happy path only for now
- **Placeholder Everything** — Cubes, debug text, temp sounds
- **Comment Intent** — Mark what's temporary vs keeper code
### After Prototyping
- **Develop** (`d`) - Use `quick-dev` to build production code
- **Iterate** (`i`) - Adjust and re-test the prototype
- **Archive** (`a`) - Keep as reference, move on to other ideas
---
- **Develop** (`d`) — Use `quick-dev` to build production code
- **Iterate** (`i`) — Adjust and re-test the prototype
- **Archive** (`a`) — Keep as reference, move on to other ideas
## Quick-Dev
**Command:** `quick-dev`
**Agent:** Game Developer
**Purpose:** Flexible development with game-specific considerations
Use `quick-dev` for flexible development with game-specific considerations.
### When to Use
@ -120,172 +80,77 @@ Agent: Prototype complete! Playtest results:
### Workflow Modes
**Mode A: Tech-Spec Driven**
```
You: quick-dev tech-spec-combat.md
Agent: [Loads spec, extracts tasks, implements]
quick-dev tech-spec-combat.md
```
**Mode B: Direct Instructions**
```
You: quick-dev implement double-jump for the player
Agent: [Evaluates complexity, offers planning options]
quick-dev implement double-jump for the player
```
**Mode C: From Prototype**
```
You: quick-dev from the grappling hook prototype
Agent: [Loads prototype, productionizes code]
quick-dev from the grappling hook prototype
```
### Game-Specific Checks
Quick-dev includes automatic consideration of:
- **Performance** - No allocations in hot paths, object pooling
- **Feel** - Input responsiveness, visual/audio feedback
- **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
```
- **Performance** — No allocations in hot paths, object pooling
- **Feel** — Input responsiveness, visual/audio feedback
- **Integration** — Save/load, multiplayer sync, platform testing
### Complexity Routing
Quick-dev automatically detects complex requests and offers alternatives:
| Signals | Recommendation |
| -------------------------------------- | ---------------------- |
|---------|----------------|
| Single mechanic, bug fix, tweak | Execute directly |
| Multiple systems, performance-critical | Plan first (tech-spec) |
| Platform/system level work | Use full BMGD workflow |
---
## Choosing Between Quick-Flows
| Scenario | Use |
| ----------------------- | ------------------------------- |
|----------|-----|
| "Will this be fun?" | `quick-prototype` |
| "How should this feel?" | `quick-prototype` |
| "Build this feature" | `quick-dev` |
| "Fix this bug" | `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
- 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
---
Quick-Flow:
Idea → Quick-Prototype → Quick-Dev → Done
```
## Checklists
### Quick-Prototype Checklist
**Before:**
**Quick-Prototype:**
- [ ] Prototype scope defined
- [ ] Success criteria established (2-3 items)
**During:**
- [ ] Minimum viable code written
- [ ] Placeholder assets used
- [ ] Core functionality testable
**After:**
- [ ] Each criterion evaluated
- [ ] Decision made (develop/iterate/archive)
### Quick-Dev Checklist
**Before:**
**Quick-Dev:**
- [ ] Context loaded (spec, prototype, or guidance)
- [ ] Files to modify identified
- [ ] Patterns understood
**During:**
- [ ] All tasks completed
- [ ] No allocations in hot paths
- [ ] Frame rate maintained
**After:**
- [ ] Game runs without errors
- [ ] Feature works as specified
- [ ] Manual playtest completed
---
## Tips
## Tips for Success
### 1. Timebox Prototypes
Set a limit (e.g., 2 hours) for prototyping. If it's not working by then, step back and reconsider.
### 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](../../reference/workflows/bmgd-workflows.md)** - Full workflow reference
- **[Agents Guide](../../explanation/game-dev/agents.md)** - Agent capabilities
- **[Quick Start Guide](../../tutorials/getting-started/quick-start-bmgd.md)** - Getting started with BMGD
- **Timebox prototypes** — Set a limit (e.g., 2 hours). If it's not working, step back
- **Embrace programmer art** — Focus on feel, not visuals
- **Test on target hardware** — What feels right on dev machine might not on target
- **Document learnings** — Even failed prototypes teach something
- **Know when to graduate** — If quick-dev keeps expanding scope, create proper stories

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
---
Use the `research` workflow to perform comprehensive multi-type research for validating ideas, understanding markets, and making informed decisions.
---
## When to Use This
- Need market viability validation
@ -17,14 +14,10 @@ Use the `research` workflow to perform comprehensive multi-type research for val
- Understanding domain or industry
- Need deeper AI-assisted research
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- Analyst agent available
---
:::
## Steps
@ -43,13 +36,13 @@ Start a fresh chat and load the Analyst agent.
Select the type of research you need:
| Type | Purpose | Use When |
| --------------- | ------------------------------------------------------ | ----------------------------------- |
|------|---------|----------|
| **market** | TAM/SAM/SOM, competitive analysis | Need market viability validation |
| **technical** | Technology evaluation, ADRs | Choosing frameworks/platforms |
| **competitive** | Deep competitor analysis | Understanding competitive landscape |
| **user** | Customer insights, personas, JTBD | Need user understanding |
| **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
@ -63,38 +56,24 @@ Give the agent details about what you're researching:
Choose your depth level:
- **Quick** - Fast overview
- **Standard** - Balanced depth
- **Comprehensive** - Deep analysis
---
- **Quick** — Fast overview
- **Standard** — Balanced depth
- **Comprehensive** — Deep analysis
## What You Get
### Market Research Example
Research output varies by type:
```
TAM: $50B
SAM: $5B
SOM: $50M
**Market Research:**
- TAM/SAM/SOM analysis
- Top competitors
- Positioning recommendation
Top Competitors:
- Asana
- Monday
- etc.
Positioning Recommendation: ...
```
### Technical Research Example
Technology evaluation with:
**Technical Research:**
- Comparison matrix
- Trade-off analysis
- Recommendations with rationale
---
## Key Features
- Real-time web research
@ -102,29 +81,17 @@ Technology evaluation with:
- Platform-specific optimization for deep_prompt type
- 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
After research:
1. **Product Brief** - Capture strategic vision informed by research
2. **PRD** - Use findings as context for requirements
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](./run-brainstorming-session.md) - Explore ideas before research
- [Create Product Brief](./create-product-brief.md) - Capture strategic vision
- [Create PRD](./create-prd.md) - Move to formal planning
1. **Product Brief** — Capture strategic vision informed by research
2. **PRD** — Use findings as context for requirements
3. **Architecture** — Use technical research in ADRs

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

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
---
Use the `create-epics-and-stories` workflow to transform PRD requirements into bite-sized stories organized into deliverable epics.
---
## When to Use This
- After architecture workflow completes
- When PRD contains FRs/NFRs ready for implementation breakdown
- Before implementation-readiness gate check
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- PM agent available
- PRD completed
- Architecture completed
---
:::
## Why After Architecture?
This workflow runs AFTER architecture because:
1. **Informed Story Sizing** - Architecture decisions affect story complexity
2. **Dependency Awareness** - Architecture reveals technical dependencies
3. **Technical Feasibility** - Stories can be properly scoped knowing the tech stack
4. **Consistency** - All stories align with documented architectural patterns
---
1. **Informed Story Sizing** — Architecture decisions affect story complexity
2. **Dependency Awareness** — Architecture reveals technical dependencies
3. **Technical Feasibility** — Stories can be properly scoped knowing the tech stack
4. **Consistency** — All stories align with documented architectural patterns
## Steps
@ -67,8 +58,6 @@ Ensure each story has:
- Identified dependencies
- Technical notes from architecture
---
## What You Get
Epic files (one per epic) containing:
@ -79,8 +68,6 @@ Epic files (one per epic) containing:
4. **Dependencies between stories**
5. **Technical notes** referencing architecture decisions
---
## Example
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.
---
## Story Priority Levels
| Priority | Meaning |
|----------|---------|
| **P0** | Critical - Must have for MVP |
| **P1** | High - Important for release |
| **P2** | Medium - Nice to have |
| **P3** | Low - Future consideration |
---
| **P0** | Critical — Must have for MVP |
| **P1** | High — Important for release |
| **P2** | Medium — Nice to have |
| **P3** | Low — Future consideration |
## Tips
- Keep stories small enough to complete in a session
- Ensure acceptance criteria are testable
- Document dependencies clearly
- Reference architecture decisions in technical notes
---
- **Keep stories small** — Complete in a single session
- **Make criteria testable** — Acceptance criteria should be verifiable
- **Document dependencies clearly** — Know what blocks what
- **Reference architecture** — Include ADR references in technical notes
## Next Steps
After creating epics and stories:
1. **Implementation Readiness** - Validate alignment before Phase 4
2. **Sprint Planning** - Organize work for implementation
---
## Related
- [Create Architecture](./create-architecture.md) - Do this first
- [Run Implementation Readiness](./run-implementation-readiness.md) - Gate check
- [Run Sprint Planning](./run-sprint-planning.md) - Start implementation
1. **Implementation Readiness** — Validate alignment before Phase 4
2. **Sprint Planning** — Organize work for 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
---
Use the `prd` workflow to create a strategic Product Requirements Document with Functional Requirements (FRs) and Non-Functional Requirements (NFRs).
---
## When to Use This
- Medium to large feature sets
@ -16,15 +13,11 @@ Use the `prd` workflow to create a strategic Product Requirements Document with
- Multiple system integrations
- Phased delivery required
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- PM agent available
- Optional: Product brief from Phase 1
---
:::
## Steps
@ -48,15 +41,13 @@ The workflow will:
### 4. Define Requirements
Work with the agent to define:
- Functional Requirements (FRs) - What the system should do
- Non-Functional Requirements (NFRs) - How well it should do it
- Functional Requirements (FRs) — What the system should do
- Non-Functional Requirements (NFRs) — How well it should do it
### 5. Review the PRD
The agent produces a comprehensive PRD scaled to your project.
---
## What You Get
A `PRD.md` document containing:
@ -69,8 +60,6 @@ A `PRD.md` document containing:
- Success metrics
- Risks and assumptions
---
## Scale-Adaptive Structure
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 |
| **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
E-commerce checkout → PRD with:
- 15 FRs (user account, cart management, payment flow)
- 8 NFRs (performance, security, scalability)
---
## Tips
## Best Practices
### 1. Do Product Brief First
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.
---
- **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
- **Document-Project first for Brownfield** — Always run `document-project` before planning brownfield projects. AI agents need existing codebase context
## Next Steps
After PRD:
1. **Create UX Design** (optional) - If UX is critical
2. **Create Architecture** - Technical design
3. **Create Epics and Stories** - After architecture
---
## Related
- [Create Product Brief](./create-product-brief.md) - Input for PRD
- [Create UX Design](./create-ux-design.md) - Optional UX workflow
- [Create Architecture](./create-architecture.md) - Next step after PRD
1. **Create UX Design** (optional) — If UX is critical
2. **Create Architecture** — Technical design
3. **Create Epics and Stories** — After architecture

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
---
Use the `product-brief` workflow to define product vision and strategy through an interactive process.
---
## When to Use This
- 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
- Need executive-level product documentation
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- Analyst agent available
- Optional: Research documents from previous workflows
---
:::
## 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.
---
## What You Get
The `product-brief.md` document includes:
- **Executive summary** - High-level overview
- **Problem statement** - With evidence
- **Proposed solution** - And differentiators
- **Target users** - Segmented
- **MVP scope** - Ruthlessly defined
- **Financial impact** - And ROI
- **Strategic alignment** - With business goals
- **Risks and open questions** - Documented upfront
---
- **Executive summary** — High-level overview
- **Problem statement** — With evidence
- **Proposed solution** — And differentiators
- **Target users** — Segmented
- **MVP scope** — Ruthlessly defined
- **Financial impact** — And ROI
- **Strategic alignment** — With business goals
- **Risks and open questions** — Documented upfront
## 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.
---
## Common Patterns
### Greenfield Software (Full Analysis)
**Greenfield Software (Full Analysis):**
```
1. brainstorm-project - explore approaches
@ -92,26 +79,16 @@ Planning workflows automatically load the product brief if it exists.
4. → Phase 2: prd
```
### Skip Analysis (Clear Requirements)
**Skip Analysis (Clear Requirements):**
```
→ Phase 2: prd or tech-spec directly
```
---
## Tips
- Be specific about the problem you're solving
- Ruthlessly prioritize MVP scope
- Document assumptions and risks
- Use research findings as evidence
- This is recommended for greenfield projects
---
## Related
- [Run Brainstorming Session](./run-brainstorming-session.md) - Explore ideas first
- [Conduct Research](./conduct-research.md) - Validate ideas
- [Create PRD](./create-prd.md) - Next step after product brief
- **Be specific about the problem** — Vague problems lead to vague solutions
- **Ruthlessly prioritize MVP scope** — Less is more
- **Document assumptions and risks** — Surface unknowns early
- **Use research findings as evidence** — Back up claims with data
- **Recommended for greenfield projects** — Sets strategic foundation

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
---
Use the `create-story` workflow to prepare the next story from the epic backlog for implementation.
---
## When to Use This
- Before implementing each story
- When moving to the next story in an epic
- After sprint-planning has been run
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- SM (Scrum Master) agent available
- Sprint-status.yaml created by sprint-planning
- Architecture and PRD available for context
---
:::
## Steps
@ -48,8 +41,6 @@ The agent will:
The agent creates a comprehensive story file ready for development.
---
## What You Get
A `story-[slug].md` file containing:
@ -61,23 +52,18 @@ A `story-[slug].md` file containing:
- Dependencies on other stories
- Definition of Done
---
## Story Content Sources
The create-story workflow pulls from:
- **PRD** - Requirements and acceptance criteria
- **Architecture** - Technical approach and ADRs
- **Epic file** - Story context and dependencies
- **Existing code** - Patterns to follow (brownfield)
---
- **PRD** — Requirements and acceptance criteria
- **Architecture** — Technical approach and ADRs
- **Epic file** — Story context and dependencies
- **Existing code** — Patterns to follow (brownfield)
## Example Output
```markdown
## Objective
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
## Dependencies
- Story 1.1 (User Registration) - DONE ✅
- Story 1.1 (User Registration) - DONE
## Definition of Done
- All acceptance criteria pass
@ -101,19 +87,16 @@ Implement email verification flow for new user registrations.
- Code review approved
```
---
## Tips
- Complete one story before creating the next
- Ensure dependencies are marked DONE before starting
- Review technical notes for architecture alignment
- Use the story file as context for dev-story
- **Complete one story before creating the next** — Focus on finishing
- **Ensure dependencies are DONE** — Don't start blocked stories
- **Review technical notes** — Align with architecture
- **Use the story file as context** — Pass to dev-story workflow
---
## Next Steps
## Related
After creating a story:
- [Run Sprint Planning](./run-sprint-planning.md) - Initialize tracking
- [Implement Story](./implement-story.md) - Next step
- [Run Code Review](./run-code-review.md) - After implementation
1. **Implement Story** — Run dev-story with the DEV agent
2. **Code Review** — Run code-review 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
---
Use the `create-ux-design` workflow to create UX specifications for projects where user experience is a primary differentiator.
---
## When to Use This
- 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
- Accessibility-critical experiences
---
## When to Skip This
- 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
- Quick Flow projects
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- UX Designer agent available
- PRD completed
---
:::
## Steps
@ -58,17 +49,15 @@ Point the agent to your PRD and describe:
The workflow uses a collaborative approach:
1. **Visual exploration** - Generate multiple options
2. **Informed decisions** - Evaluate with user needs
3. **Collaborative design** - Refine iteratively
4. **Living documentation** - Evolves with project
1. **Visual exploration** — Generate multiple options
2. **Informed decisions** — Evaluate with user needs
3. **Collaborative design** — Refine iteratively
4. **Living documentation** — Evolves with project
### 5. Review the UX Spec
The agent produces comprehensive UX documentation.
---
## What You Get
The `ux-spec.md` document includes:
@ -79,8 +68,6 @@ The `ux-spec.md` document includes:
- Design system (components, patterns, tokens)
- Epic breakdown (UX stories)
---
## Example
Dashboard redesign produces:
@ -90,8 +77,6 @@ Dashboard redesign produces:
- Responsive grid
- 3 epics (Layout, Visualization, Accessibility)
---
## Integration
The UX spec feeds into:
@ -99,19 +84,17 @@ The UX spec feeds into:
- Epic and story creation
- Architecture decisions (Phase 3)
---
## Tips
- Focus on user problems, not solutions first
- Generate multiple options before deciding
- Consider accessibility from the start
- Document component reusability
- **Focus on user problems first** — Solutions come second
- **Generate multiple options** — Don't settle on the first idea
- **Consider accessibility from the start** — Not an afterthought
- **Document component reusability** — Build a system, not just screens
---
## Next Steps
## Related
After UX design:
- [Create PRD](./create-prd.md) - Create requirements first
- [Create Architecture](./create-architecture.md) - Technical design
- [Create Epics and Stories](./create-epics-and-stories.md) - Work breakdown
1. **Update PRD** — Incorporate UX findings
2. **Create Architecture** — Technical design informed by UX
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
---
Use the `dev-story` workflow to implement a story with tests following the architecture and conventions.
---
## When to Use This
- After create-story has prepared the story file
- When ready to write code for a story
- Story dependencies are marked DONE
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- DEV agent available
- Story file created by create-story
- Architecture and tech-spec available for context
---
:::
## Steps
@ -53,75 +46,52 @@ The DEV agent:
Work with the agent until all acceptance criteria are met.
---
## What Happens
The dev-story workflow:
1. **Reads context** - Story file, architecture, existing patterns
2. **Plans implementation** - Identifies files to create/modify
3. **Writes code** - Following conventions and patterns
4. **Writes tests** - Unit, integration, or E2E as appropriate
5. **Validates** - Runs tests and checks acceptance criteria
---
1. **Reads context** — Story file, architecture, existing patterns
2. **Plans implementation** — Identifies files to create/modify
3. **Writes code** — Following conventions and patterns
4. **Writes tests** — Unit, integration, or E2E as appropriate
5. **Validates** — Runs tests and checks acceptance criteria
## 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
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
---
**Write Tests** — Every story includes appropriate tests: unit tests for business logic, integration tests for API endpoints, E2E tests for critical flows.
## After Implementation
1. **Update sprint-status.yaml** - Mark story as READY FOR REVIEW
2. **Run code-review** - Quality assurance
3. **Address feedback** - If code review finds issues
4. **Mark DONE** - After code review passes
---
1. **Update sprint-status.yaml** — Mark story as READY FOR REVIEW
2. **Run code-review** — Quality assurance
3. **Address feedback** — If code review finds issues
4. **Mark DONE** — After code review passes
## Tips
- Keep the story file open for reference
- Ask the agent to explain decisions
- Run tests frequently during implementation
- Don't skip tests for "simple" changes
---
- **Keep the story file open** — Reference it during implementation
- **Ask the agent to explain decisions** — Understand the approach
- **Run tests frequently** — Catch issues early
- **Don't skip tests** — Even for "simple" changes
## Troubleshooting
**Q: Story needs significant changes mid-implementation?**
A: Run `correct-course` to analyze impact and route appropriately.
**Story needs significant changes mid-implementation?**
Run `correct-course` to analyze impact and route appropriately.
**Q: Can I work on multiple stories in parallel?**
A: Not recommended. Complete one story's full lifecycle first.
**Can I work on multiple stories in parallel?**
Not recommended. Complete one story's full lifecycle first.
**Q: What if implementation reveals the story is too large?**
A: Split the story and document the change.
**What if implementation reveals the story is too large?**
Split the story and document the change.
---
## Next Steps
## Related
After implementing a story:
- [Create Story](./create-story.md) - Prepare the story first
- [Run Code Review](./run-code-review.md) - After implementation
- [Run Sprint Planning](./run-sprint-planning.md) - Sprint organization
1. **Code Review** — Run code-review with the DEV agent
2. **Create Next Story** — Run create-story with the SM agent

75
docs/how-to/workflows/create-tech-spec.md → docs/how-to/workflows/quick-spec.md
View File

@ -1,12 +1,9 @@
---
title: "How to Create a Tech Spec"
description: How to create a technical specification using Quick Spec Flow
title: "How to Use Quick Spec"
description: How to create a technical specification using Quick Spec workflow
---
Use the `tech-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
---
Use the `quick-spec` workflow for Quick Flow projects to go directly from idea to implementation-ready specification.
## 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
- Quick Flow track projects
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- PM agent or Quick Flow Solo Dev agent available
- Project directory (can be empty for greenfield)
---
:::
## Steps
@ -35,7 +28,7 @@ Start a fresh chat and load the PM agent (or Quick Flow Solo Dev agent).
### 2. Run the Tech Spec Workflow
```
*create-tech-spec
*quick-spec
```
Or simply describe what you want to build:
@ -63,12 +56,9 @@ For brownfield projects, the agent will:
The agent generates a comprehensive tech-spec with ready-to-implement stories.
---
## What You Get
### tech-spec.md
**tech-spec.md:**
- Problem statement and solution
- Detected framework versions and dependencies
- 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
- 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:
- `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)
## Example: Bug Fix
**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
6. Creates story-login-fix.md
**Total time:** 15-30 minutes (mostly implementation)
---
## Example: Small Feature (Multi-Story)
## Example: Small Feature
**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-2.md (Frontend login buttons)
**Total time:** 1-3 hours (mostly implementation)
---
## Implementing After Tech Spec
```bash
@ -133,27 +108,15 @@ For small features:
# Then: Load DEV agent and run dev-story for each story
```
---
## 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"
- ❌ "Fix validation bug"
## Next Steps
### Trust Convention Detection
After tech spec:
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.
---
## Related
- [Quick Flow](../../explanation/features/quick-flow.md) - Understanding Quick Spec Flow
- [Implement Story](./implement-story.md) - After tech spec
- [Create PRD](./create-prd.md) - For larger projects needing full BMad Method
1. **Implement Story** — Run dev-story with the DEV agent
2. **Sprint Planning** — Optional for multi-story features

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
---
Use the `brainstorm-project` workflow to explore solution approaches through parallel ideation tracks.
---
## When to Use This
- 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
- No idea what you want to build, but want to find some inspiration
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- Analyst agent available
---
:::
## 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:
- **Architecture track** - Technical approaches and patterns
- **UX track** - User experience possibilities
- **Integration track** - How it connects with other systems
- **Value track** - Business value and differentiation
- **Architecture track** — Technical approaches and patterns
- **UX track** — User experience possibilities
- **Integration track** — How it connects with other systems
- **Value track** — Business value and differentiation
### 5. Evaluate Options
Review the generated options with rationale for each approach.
---
## What You Get
- Multiple solution approaches with trade-offs
@ -66,29 +57,17 @@ Review the generated options with rationale for each approach.
- UX and integration considerations
- 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
After brainstorming:
1. **Research** - Validate ideas with market/technical research
2. **Product Brief** - Capture strategic vision
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](./conduct-research.md) - Validate your ideas
- [Create Product Brief](./create-product-brief.md) - Capture strategic vision
- [Create PRD](./create-prd.md) - Move to formal planning
1. **Research** — Validate ideas with market/technical research
2. **Product Brief** — Capture strategic vision
3. **PRD** — 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
---
Use the `code-review` workflow to perform a thorough quality review of implemented code.
---
## When to Use This
- After dev-story completes implementation
- Before marking a story as DONE
- Every story goes through code review - no exceptions
---
## Prerequisites
- Every story goes through code review — no exceptions
:::note[Prerequisites]
- BMad Method installed
- DEV agent available
- Story implementation complete
- Tests written and passing
---
:::
## Steps
@ -55,56 +48,21 @@ If issues are found:
2. Re-run tests
3. Run code-review again
---
## What Gets Reviewed
The code review checks:
### Code Quality
- Clean, readable code
- Appropriate abstractions
- No code smells
- Proper error handling
### 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
---
| Category | Checks |
|----------|--------|
| **Code Quality** | Clean code, appropriate abstractions, no code smells, proper error handling |
| **Architecture Alignment** | Follows ADRs, consistent with patterns, proper separation of concerns |
| **Testing** | Adequate coverage, meaningful tests, edge cases, follows project patterns |
| **Security** | No hardcoded secrets, input validation, proper auth, no common vulnerabilities |
| **Performance** | No obvious issues, appropriate data structures, efficient queries |
## Review Outcomes
### ✅ Approved
**Approved** — Code meets quality standards, tests pass. Mark story as DONE in sprint-status.yaml.
- Code meets quality standards
- 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
---
**Changes Requested** — Issues identified that need fixing. Fix issues in dev-story, then re-run code-review.
## Quality Gates
@ -115,27 +73,17 @@ Every story goes through code-review before being marked done. This ensures:
- Test coverage
- Security review
---
## Tips
- Don't skip code review for "simple" changes
- Address all findings, not just critical ones
- Use findings as learning opportunities
- Re-run review after fixes
- **Don't skip for "simple" changes** — Simple changes can have subtle bugs
- **Address all findings** — Not just critical ones
- **Use findings as learning opportunities** — Improve over time
- **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
2. **If changes requested:** Fix issues and re-run review
3. **Move to next story:** Run create-story for the next item
---
## Related
- [Implement Story](./implement-story.md) - Before code review
- [Create Story](./create-story.md) - Move to next story
- [Run Sprint Planning](./run-sprint-planning.md) - Sprint organization
1. **If approved** — Update sprint-status.yaml to mark story DONE
2. **If changes requested** — Fix issues and re-run review
3. **Move to next story** — Run create-story for the next item

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
---
Use the `implementation-readiness` workflow to validate that planning and solutioning are complete and aligned before Phase 4 implementation.
---
## When to Use This
- **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
- When stakeholders request readiness check
---
## When to Skip This
- Quick Flow (no solutioning phase)
- BMad Method Simple (no gate check required)
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- Architect agent available
- PRD, Architecture, and Epics completed
---
:::
## Steps
@ -56,66 +47,42 @@ The workflow systematically checks:
The agent produces a gate decision with rationale.
---
## Gate Decision Outcomes
### ✅ PASS
- All critical criteria met
- Minor gaps acceptable with documented plan
- **Action:** Proceed to Phase 4
### ⚠️ 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
---
| Decision | Meaning | Action |
|----------|---------|--------|
| **PASS** | All critical criteria met, minor gaps acceptable | Proceed to Phase 4 |
| **CONCERNS** | Some criteria not met but not blockers | Proceed with caution, address gaps in parallel |
| **FAIL** | Critical gaps or contradictions | BLOCK Phase 4, resolve issues first |
## What Gets Checked
### PRD/GDD Completeness
**PRD/GDD Completeness:**
- Problem statement clear and evidence-based
- Success metrics defined
- User personas identified
- Functional requirements (FRs) complete
- Non-functional requirements (NFRs) specified
- FRs and NFRs complete
- Risks and assumptions documented
### Architecture Completeness
- System architecture defined
- Data architecture specified
- API architecture decided
**Architecture Completeness:**
- System, data, API architecture defined
- Key ADRs documented
- Security architecture addressed
- FR/NFR-specific guidance provided
- Standards and conventions defined
### Epic/Story Completeness
**Epic/Story Completeness:**
- All PRD features mapped to stories
- Stories have acceptance criteria
- Stories prioritized (P0/P1/P2/P3)
- Dependencies identified
- Story sequencing logical
### Alignment Checks
**Alignment Checks:**
- Architecture addresses all PRD FRs/NFRs
- Epics align with architecture decisions
- No contradictions between epics
- NFRs have technical approach
- Integration points clear
---
## What You Get
An `implementation-readiness.md` document containing:
@ -128,11 +95,9 @@ An `implementation-readiness.md` document containing:
6. **Gate Decision** with rationale
7. **Next Steps**
---
## Example
E-commerce platform → CONCERNS ⚠️
E-commerce platform → CONCERNS
**Gaps identified:**
- Missing security architecture section
@ -144,19 +109,17 @@ E-commerce platform → CONCERNS ⚠️
**Action:** Proceed with caution, address before payment epic.
---
## Tips
- Run this before every Phase 4 start
- Take FAIL decisions seriously - fix issues first
- Use CONCERNS as a checklist for parallel work
- Document why you proceed despite concerns
- **Run before every Phase 4 start** — It's a valuable checkpoint
- **Take FAIL decisions seriously** — Fix issues first
- **Use CONCERNS as a checklist** — Track parallel work
- **Document why you proceed despite concerns** — Transparency matters
---
## Next Steps
## Related
After implementation readiness:
- [Create Architecture](./create-architecture.md) - Architecture workflow
- [Create Epics and Stories](./create-epics-and-stories.md) - Work breakdown
- [Run Sprint Planning](./run-sprint-planning.md) - Start implementation
1. **If PASS** — Run sprint-planning to start Phase 4
2. **If CONCERNS** — Proceed with documented gaps to address
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
---
Use the `sprint-planning` workflow to initialize the sprint tracking file and organize work for implementation.
---
## When to Use This
- Once at the start of Phase 4 (Implementation)
- After implementation-readiness gate passes
- When starting a new sprint cycle
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- SM (Scrum Master) agent available
- Epic files created from `create-epics-and-stories`
- Implementation-readiness passed (for BMad Method/Enterprise)
---
:::
## 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.
---
## What You Get
A `sprint-status.yaml` file containing:
@ -56,12 +47,8 @@ A `sprint-status.yaml` file containing:
- Dependencies between stories
- Priority ordering
---
## Story Lifecycle States
Stories move through these states in the sprint status file:
| State | Description |
|-------|-------------|
| **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 |
| **DONE** | Accepted and complete |
---
## Typical Sprint Flow
### Sprint 0 (Planning Phase)
**Sprint 0 (Planning Phase):**
- Complete Phases 1-3
- PRD/GDD + Architecture complete
- 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)
**Per Story (repeat until epic complete):**
Per Story (repeat until epic complete):
1. SM runs `create-story`
2. DEV runs `dev-story`
3. DEV runs `code-review`
4. Update sprint-status.yaml
**After Epic Complete:**
After Epic Complete:
- SM runs `retrospective`
- Move to next epic
---
## Tips
- Run sprint-planning only once at Phase 4 start
- Use `sprint-status` during Phase 4 to check current state
- Keep the sprint-status.yaml file as single source of truth
- Update story status after each stage
- **Run sprint-planning only once** — At Phase 4 start
- **Use sprint-status during Phase 4** — Check current state anytime
- **Keep sprint-status.yaml as single source of truth** — All status updates go here
- **Update story status after each stage** — Keep it current
---
## Next Steps
## Related
After sprint planning:
- [Create Story](./create-story.md) - Prepare stories for implementation
- [Implement Story](./implement-story.md) - Dev workflow
- [Run Code Review](./run-code-review.md) - Quality assurance
1. **Create Story** — Prepare the first story for implementation
2. **Implement Story** — Run dev-story with the DEV agent
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
---
Use TEA's `*test-design` workflow to create comprehensive test plans with risk assessment and coverage strategies.
---
## When to Use This
**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
- To identify epic-specific testing needs
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- TEA agent available
- For system-level: Architecture document complete
- For epic-level: Epic defined with stories
---
:::
## Steps
@ -47,8 +40,8 @@ Start a fresh chat and load the TEA (Test Architect) agent.
TEA will ask if you want:
- **System-level** - For architecture testability review (Phase 3)
- **Epic-level** - For epic-specific test planning (Phase 4)
- **System-level** — For architecture testability review (Phase 3)
- **Epic-level** — For epic-specific test planning (Phase 4)
### 4. Provide Context
@ -64,20 +57,16 @@ For epic-level:
TEA generates a comprehensive test design document.
---
## What You Get
### System-Level Output (`test-design-system.md`)
**System-Level Output (`test-design-system.md`):**
- Testability review of architecture
- ADR → test mapping
- Architecturally Significant Requirements (ASRs)
- Environment needs
- Test infrastructure recommendations
### Epic-Level Output (`test-design-epic-N.md`)
**Epic-Level Output (`test-design-epic-N.md`):**
- Risk assessment for the epic
- Test priorities
- Coverage plan
@ -85,44 +74,25 @@ TEA generates a comprehensive test design document.
- Integration risks
- Mitigation strategies
---
## Test Design for Different Tracks
### Greenfield - BMad Method
| Stage | Test Design Focus |
|-------|-------------------|
| Phase 3 | System-level testability review |
| 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 |
---
| Track | Phase 3 Focus | Phase 4 Focus |
|-------|---------------|---------------|
| **Greenfield** | System-level testability review | Per-epic risk assessment and test plan |
| **Brownfield** | System-level + existing test baseline | Regression hotspots, integration risks |
| **Enterprise** | Compliance-aware testability | Security/performance/compliance focus |
## Tips
- Run system-level test-design right after architecture
- Run epic-level test-design at the start of each epic
- Update test design if ADRs change
- Use the output to guide `*atdd` and `*automate` workflows
- **Run system-level right after architecture** — Early testability review
- **Run epic-level at the start of each epic** — Targeted test planning
- **Update if ADRs change** — Keep test design aligned
- **Use output to guide other workflows** — Feeds into `*atdd` and `*automate`
---
## Next Steps
## Related
After test design:
- [TEA Overview](../../explanation/features/tea-overview.md) - Understanding the Test Architect
- [Setup Test Framework](./setup-test-framework.md) - Setting up testing infrastructure
- [Create Architecture](./create-architecture.md) - Architecture workflow
1. **Setup Test Framework** — If not already configured
2. **Implementation Readiness** — System-level feeds into gate check
3. **Story Implementation** — Epic-level guides testing during dev

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

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

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
---
Use TEA's `*framework` workflow to scaffold a production-ready test framework for your project.
---
## When to Use This
- 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
- Phase 3 (Solutioning) after architecture is complete
---
## Prerequisites
:::note[Prerequisites]
- BMad Method installed
- Architecture completed (or at least tech stack decided)
- TEA agent available
---
:::
## Steps
@ -50,13 +43,11 @@ TEA will ask about:
TEA generates:
- **Test scaffold** - Directory structure and config files
- **Sample specs** - Example tests following best practices
- **`.env.example`** - Environment variable template
- **`.nvmrc`** - Node version specification
- **README updates** - Testing documentation
---
- **Test scaffold** — Directory structure and config files
- **Sample specs** — Example tests following best practices
- **`.env.example`** — Environment variable template
- **`.nvmrc`** — Node version specification
- **README updates** — Testing documentation
## What You Get
@ -71,8 +62,6 @@ tests/
└── README.md
```
---
## Optional: Playwright Utils Integration
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
---
## Optional: MCP Enhancements
TEA can use Playwright MCP servers for enhanced capabilities:
- `playwright` - Browser automation
- `playwright-test` - Test runner with failure analysis
- `playwright` — Browser automation
- `playwright-test` — Test runner with failure analysis
Configure in your IDE's MCP settings.
---
## Tips
- Run `*framework` only once per repository
- Run after architecture is complete so framework aligns with tech stack
- Follow up with `*ci` to set up CI/CD pipeline
- **Run only once per repository** — Framework setup is a one-time operation
- **Run after architecture is complete** — Framework aligns with tech stack
- **Follow up with CI setup** — Run `*ci` to configure CI/CD pipeline
---
## Next Steps
## Related
After test framework setup:
- [TEA Overview](../../explanation/features/tea-overview.md) - Understanding the Test Architect
- [Run Test Design](./run-test-design.md) - Creating test plans
- [Create Architecture](./create-architecture.md) - Architecture workflow
1. **Test Design** — Create test plans for system or epics
2. **CI Configuration** — Set up automated test runs
3. **Story Implementation** — Tests are ready for development

22
docs/index.md
View File

@ -1,8 +1,8 @@
---
title: Welcome to BMad
title: Welcome to the BMad Method
---
BMad (**B**uild **M**ore, **A**rchitect **D**reams) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform.
The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform.
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
@ -12,11 +12,10 @@ If you're comfortable working with AI coding assistants like Claude, Cursor, or
The fastest way to understand BMad is to try it. Choose a tutorial to walk through your first project in about 10 minutes.
- **[Get Started with v4 (Stable)](./tutorials/getting-started/getting-started-bmadv4.md)** — Production-ready version with battle-tested workflows
- **[Try v6 (Alpha)](./tutorials/getting-started/getting-started-bmadv6.md)** — Latest features, still in active development
- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Latest features, still in active development
:::tip[Already familiar with AI-assisted development?]
Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](./explanation/core-concepts/what-are-agents.md) to understand how BMad organizes its AI personas.
Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md) to understand how BMad organizes its AI personas.
:::
---
@ -26,11 +25,11 @@ Feel free to skip around. Use the sidebar to jump to any topic, or check out [Wh
These docs are organized into four sections based on what you're trying to do:
| Section | Purpose |
|---------|---------|
| **[Tutorials](./tutorials/index.md)** | Learning-oriented. Step-by-step guides that walk you through building something. Start here if you're new. |
| **[How-To Guides](./how-to/index.md)** | Task-oriented. Practical guides for solving specific problems. "How do I customize an agent?" lives here. |
| **[Explanation](./explanation/index.md)** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. |
| **[Reference](./reference/index.md)** | Information-oriented. Technical specifications for agents, workflows, and configuration. |
| ----------------- | ---------------------------------------------------------------------------------------------------------- |
| **Tutorials** | Learning-oriented. Step-by-step guides that walk you through building something. Start here if you're new. |
| **How-To Guides** | Task-oriented. Practical guides for solving specific problems. "How do I customize an agent?" lives here. |
| **Explanation** | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*. |
| **Reference** | Information-oriented. Technical specifications for agents, workflows, and configuration. |
---
@ -61,5 +60,4 @@ Get help, share what you're building, or contribute to BMad:
Ready to dive in? Pick a tutorial and start building.
- **[Get Started with v4 (Stable)](./tutorials/getting-started/getting-started-bmadv4.md)** — Recommended for production projects
- **[Try v6 (Alpha)](./tutorials/getting-started/getting-started-bmadv6.md)** — Explore the latest features
- **[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Explore the latest features

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

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

@ -2,66 +2,66 @@
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.
## Table of Contents
## Contents
- [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
---
## 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 to create navigable documentation for a folder of markdown files, or you want to maintain an updated index as content evolves.
**Use it when:**
- You need navigable documentation for a folder of markdown files
- You want to maintain an updated index as content evolves
**How it works:**
1. Scan the target directory for files and subdirectories
2. Group content by type, purpose, or location
3. Read each file to generate brief (3-10 word) descriptions based on actual content
4. Create or update index.md with organized listings using relative paths
3. Read each file to generate brief (3-10 word) descriptions
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 (General)
## Adversarial Review
**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:** 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.
**Use it when:**
- Reviewing code diffs before merging
- Finalizing specifications or user stories
- Releasing documentation
- Any artifact needs a critical eye before completion
**How it works:**
1. Load the content to review (diff, branch, uncommitted changes, document, etc.)
2. Perform adversarial analysis with extreme skepticism—assume problems exist
1. Load the content to review (diff, branch, document, etc.)
2. Perform adversarial analysis — assume problems exist
3. Find at least ten issues to fix or improve
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
**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 effectively work with, or you want to break a monolithic document into manageable sections that can be edited independently.
**Use it when:**
- A markdown file has grown too large to work with effectively
- You want to break a monolithic document into manageable sections
- Individual sections need to be edited independently
**How it works:**
1. Confirm source document path and verify it's a markdown file
2. Determine destination folder (defaults to same location as source, folder named after document)
3. Execute the sharding command using npx @kayvan/markdown-tree-parser
1. Confirm source document path (must be markdown)
2. Determine destination folder (defaults to folder named after document)
3. Execute sharding via `npx @kayvan/markdown-tree-parser`
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):
- `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`)
These values are set during installation and recorded to the core `module.yaml`:
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.
:::

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

@ -1,368 +1,122 @@
---
title: "BMAD Glossary"
title: "BMad Glossary"
---
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)
---
Terminology reference for the BMad Method.
## Core Concepts
### BMAD (Build More, Architect Dreams)
AI-driven agile development framework with specialized agents, guided workflows, and scale-adaptive intelligence.
### BMM (BMad Method Module)
Core orchestration system for AI-driven agile development, providing comprehensive lifecycle management through specialized agents and workflows.
### 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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **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. |
## Scale and Complexity
### Quick Flow Track
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 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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
## Planning Documents
### Tech-Spec (Technical Specification)
**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.
### PRD (Product Requirements Document)
**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.
### Architecture Document
**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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **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. |
| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. |
## Workflow and Phases
### Phase 0: Documentation (Prerequisite)
**Conditional phase for brownfield projects.** Creates comprehensive codebase documentation before planning. Only required if existing documentation is insufficient for AI agents.
### Phase 1: Analysis (Optional)
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 2: Planning (Required)
**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.
---
| Term | Definition |
|------|------------|
| **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 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. |
| **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. |
| **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. |
## Agents and Roles
### PM (Product Manager)
Agent responsible for creating PRDs, tech-specs, and managing product requirements. Primary agent for Phase 2 planning.
### Analyst (Business Analyst)
Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects.
### Architect
Agent that designs system architecture, creates architecture documents, performs technical reviews, and validates designs. Primary agent for Phase 3 solutioning.
### SM (Scrum Master)
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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **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. |
| **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. |
| **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. |
| **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. |
## Status and Tracking
### bmm-workflow-status.yaml
**Phases 1-3.** Tracking file that shows current phase, completed workflows, progress, and next recommended actions. Created by workflow-init, updated automatically.
### sprint-status.yaml
**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.
### Story Status Progression
```
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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **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** | `backlog → ready-for-dev → in-progress → review → done` — lifecycle states for stories. |
## Project Types
### Greenfield
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, patterns, and constraints. Requires understanding existing architecture, respecting established conventions, and planning integration with current systems.
**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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **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. |
## Implementation Terms
### Story
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.
### Story File
Markdown file containing story details: description, acceptance criteria, technical notes, dependencies, implementation guidance, and testing requirements.
### Story Context
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.
### 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.
---
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **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** | 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. |
| **Track Selection** | Automatic analysis by workflow-init suggesting appropriate track based on complexity indicators. User can override. |
## Game Development Terms
### Core Fantasy
The emotional experience players seek from your game. What they want to FEEL.
### Core Loop
The fundamental cycle of actions players repeat throughout gameplay. The heart of your game.
### Design Pillar
Core principle that guides all design decisions. Typically 3-5 pillars define a game's identity.
### Game Type
Genre classification that determines which specialized GDD sections are included.
### 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.
### 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.
| Term | Definition |
|------|------------|
| **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. |
| **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. |
| **Game Type** | *BMGD.* Genre classification determining which specialized GDD sections are included. |
| **MDA Framework** | *BMGD.* Mechanics → Dynamics → Aesthetics — framework for analyzing and designing games. |
| **Meta-Progression** | *BMGD.* Persistent progression carrying between individual runs or sessions. |
| **Metroidvania** | *BMGD.* Genre featuring interconnected world exploration with ability-gated progression. |
| **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. |
| **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. |
| **Roguelike** | *BMGD.* Genre featuring procedural generation, permadeath, and run-based progression. |

26
docs/reference/index.md
View File

@ -1,26 +0,0 @@
---
title: "Reference"
---
Information-oriented documentation for looking up facts, specifications, and details.
## Agents
Technical reference for all BMAD agents.
## Workflows
Technical reference for all BMAD workflows.
## Configuration
Configuration options and settings.
## Glossary
Definitions of BMAD terminology.
## FAQ
Frequently asked questions organized by topic.

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

@ -2,19 +2,14 @@
title: "BMGD Workflows Guide"
---
Complete reference for all BMGD workflows organized by development phase.
---
## Workflow Overview
## Overview
BMGD workflows are organized into four phases:
![BMGD Workflow Overview](../../tutorials/getting-started/images/workflow-overview.jpg)
---
## Phase 1: Preproduction
### Brainstorm Game
@ -24,23 +19,19 @@ BMGD workflows are organized into four phases:
**Input:** None required
**Output:** Ideas and concepts (optionally saved)
**Description:**
Guided ideation session using game-specific brainstorming techniques:
- **MDA Framework** - Mechanics → Dynamics → Aesthetics analysis
- **Core Loop Workshop** - Define the fundamental gameplay loop
- **Player Fantasy Mining** - Explore what players want to feel
- **Genre Mashup** - Combine genres for unique concepts
- **MDA Framework** — Mechanics → Dynamics → Aesthetics analysis
- **Core Loop Workshop** — Define the fundamental gameplay loop
- **Player Fantasy Mining** — Explore what players want to feel
- **Genre Mashup** — Combine genres for unique concepts
**Steps:**
1. Initialize brainstorm session
2. Load game-specific techniques
3. Execute ideation with selected techniques
4. Summarize and (optionally) hand off to Game Brief
---
### Game Brief
**Command:** `create-game-brief`
@ -48,11 +39,9 @@ Guided ideation session using game-specific brainstorming techniques:
**Input:** Ideas from brainstorming (optional)
**Output:** `{output_folder}/game-brief.md`
**Description:**
Captures your game's core vision and fundamentals. This is the foundation for all subsequent design work.
Captures your game's core vision and fundamentals. Foundation for all subsequent design work.
**Sections covered:**
- Game concept and vision
- Design pillars (3-5 core principles)
- 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
- Initial scope definition
---
## Phase 2: Design
### 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
**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.
**Core sections:**
1. Executive Summary
2. Gameplay Systems
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)
**Features:**
- Game type selection with specialized sections
- Hybrid game type support
- Automatic epic generation
- Scale-adaptive complexity
---
### Narrative Design
**Command:** `narrative`
@ -103,11 +85,9 @@ Comprehensive game design document with genre-specific sections based on 24 supp
**Input:** GDD (required), Game Brief (optional)
**Output:** `{output_folder}/narrative-design.md`
**Description:**
For story-driven games. Creates comprehensive narrative documentation.
**Sections covered:**
1. Story Foundation (premise, themes, tone)
2. Story Structure (acts, beats, pacing)
3. Characters (protagonists, antagonists, supporting, arcs)
@ -120,13 +100,10 @@ For story-driven games. Creates comprehensive narrative documentation.
10. Appendices (relationship map, timeline)
**Narrative Complexity Levels:**
- **Critical** - Story IS the game (visual novels, adventure games)
- **Heavy** - Deep narrative with gameplay (RPGs, story-driven action)
- **Moderate** - Meaningful story supporting gameplay
- **Light** - Minimal story, gameplay-focused
---
- **Critical** — Story IS the game (visual novels, adventure games)
- **Heavy** — Deep narrative with gameplay (RPGs, story-driven action)
- **Moderate** — Meaningful story supporting gameplay
- **Light** — Minimal story, gameplay-focused
## Phase 3: Technical
@ -137,11 +114,9 @@ For story-driven games. Creates comprehensive narrative documentation.
**Input:** GDD, Narrative Design (optional)
**Output:** `{output_folder}/game-architecture.md`
**Description:**
Technical architecture document covering engine selection, system design, and implementation approach.
**Sections covered:**
1. Executive Summary
2. Engine/Framework Selection
3. Core Systems Architecture
@ -153,8 +128,6 @@ Technical architecture document covering engine selection, system design, and im
9. Build and Deployment
10. Technical Risks and Mitigations
---
## Phase 4: Production
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
**Output:** `{implementation_artifacts}/sprint-status.yaml`
**Description:**
Generates or updates sprint tracking from epic files. Sets up the sprint backlog and tracking.
---
### 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`
**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. Supports three modes:
Summarizes sprint progress, surfaces risks (stale file, orphaned stories, stories in review), and recommends the next workflow to run.
- **interactive** (default): Displays summary with menu options
- **validate**: Checks sprint-status.yaml structure
- **data**: Returns raw data for other workflows
---
**Modes:**
- **interactive** (default) — Displays summary with menu options
- **validate** — Checks sprint-status.yaml structure
- **data** — Returns raw data for other workflows
### Create Story
@ -194,13 +162,10 @@ Summarizes sprint progress, surfaces risks (stale file, orphaned stories, storie
**Input:** GDD, Architecture, Epic context
**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.
**Validation:** `validate-create-story`
---
### Dev Story
**Command:** `dev-story`
@ -208,11 +173,8 @@ Creates implementable story drafts with acceptance criteria, tasks, and technica
**Input:** Story (ready for dev)
**Output:** Implemented code
**Description:**
Implements story tasks following acceptance criteria. Uses TDD approach (red-green-refactor). Updates sprint-status.yaml automatically on completion.
---
### 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)
**Output:** Review feedback, approved/needs changes
**Description:**
Thorough QA code review with game-specific considerations (performance, 60fps, etc.).
---
### Retrospective
**Command:** `epic-retrospective`
@ -232,11 +191,8 @@ Thorough QA code review with game-specific considerations (performance, 60fps, e
**Input:** Completed epic
**Output:** Retrospective document
**Description:**
Facilitates team retrospective after epic completion. Captures learnings and improvements.
---
### Correct Course
**Command:** `correct-course`
@ -244,25 +200,18 @@ Facilitates team retrospective after epic completion. Captures learnings and imp
**Input:** Current project state
**Output:** Correction plan
**Description:**
Navigates significant changes when implementation is off-track. Analyzes impact and recommends adjustments.
---
## Workflow Status
**Command:** `workflow-status`
**Agent:** All agents
**Output:** Project status summary
**Description:**
Checks current project status across all phases. Shows completed documents, current phase, and next steps.
---
## Quick-Flow Workflows
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](../../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
@ -271,17 +220,13 @@ Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](..
**Input:** Idea or concept to test
**Output:** Working prototype, playtest results
**Description:**
Rapid prototyping workflow for testing game mechanics and ideas quickly. Focuses on "feel" over polish.
**Use when:**
- Testing if a mechanic is fun
- Proving a concept before committing to design
- Experimenting with gameplay ideas
---
### 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
**Output:** Implemented feature
**Description:**
Flexible development workflow with game-specific considerations (performance, feel, integration).
**Use when:**
- Implementing features from tech-specs
- Building on successful prototypes
- Making changes that don't need full story workflow
---
## Quality Assurance Workflows
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
**Output:** Configured test framework
**Description:**
Initialize a production-ready test framework for your game engine:
- **Unity**: Unity Test Framework with Edit Mode and Play Mode tests
- **Unreal**: Unreal Automation system with functional tests
- **Godot**: GUT (Godot Unit Test) framework
- **Unity** — Unity Test Framework with Edit Mode and Play Mode tests
- **Unreal** — Unreal Automation system with functional tests
- **Godot** — GUT (Godot Unit Test) framework
**Creates:**
- Test directory structure
- Framework configuration
- Sample unit and integration tests
- Test documentation
---
### Test Design
**Command:** `test-design`
@ -334,7 +271,6 @@ Initialize a production-ready test framework for your game engine:
**Input:** GDD, Architecture
**Output:** `{output_folder}/game-test-design.md`
**Description:**
Creates comprehensive test scenarios covering:
- Core gameplay mechanics
@ -344,8 +280,6 @@ Creates comprehensive test scenarios covering:
Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
---
### Automate
**Command:** `automate`
@ -353,15 +287,12 @@ Uses GIVEN/WHEN/THEN format with priority levels (P0-P3).
**Input:** Test design, game code
**Output:** Automated test files
**Description:**
Generates engine-appropriate automated tests:
- Unit tests for pure logic
- Integration tests for system interactions
- Smoke tests for critical path validation
---
### Playtest Plan
**Command:** `playtest-plan`
@ -369,7 +300,6 @@ Generates engine-appropriate automated tests:
**Input:** Build, test objectives
**Output:** `{output_folder}/playtest-plan.md`
**Description:**
Creates structured playtesting sessions:
- Session structure (pre/during/post)
@ -378,12 +308,9 @@ Creates structured playtesting sessions:
- Analysis templates
**Playtest Types:**
- Internal (team validation)
- External (unbiased feedback)
- Focused (specific feature testing)
---
- **Internal** — Team validation
- **External** — Unbiased feedback
- **Focused** — Specific feature testing
### Performance Test
@ -392,7 +319,6 @@ Creates structured playtesting sessions:
**Input:** Platform targets
**Output:** `{output_folder}/performance-test-plan.md`
**Description:**
Designs performance testing strategy:
- Frame rate targets per platform
@ -401,8 +327,6 @@ Designs performance testing strategy:
- Benchmark scenarios
- Profiling methodology
---
### Test Review
**Command:** `test-review`
@ -410,7 +334,6 @@ Designs performance testing strategy:
**Input:** Existing test suite
**Output:** `{output_folder}/test-review-report.md`
**Description:**
Reviews test quality and coverage:
- Test suite metrics
@ -418,8 +341,6 @@ Reviews test quality and coverage:
- Coverage gaps
- Recommendations
---
## Utility Workflows
### Party Mode
@ -427,40 +348,21 @@ Reviews test quality and coverage:
**Command:** `party-mode`
**Agent:** All agents
**Description:**
Brings multiple agents together for collaborative discussion on complex decisions.
---
### Advanced Elicitation
**Command:** `advanced-elicitation`
**Agent:** All agents (web only)
**Description:**
Deep exploration techniques to challenge assumptions and surface hidden requirements.
---
## 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
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](../../tutorials/getting-started/quick-start-bmgd.md)** - Get started with BMGD
- **[Quick-Flow Guide](../../how-to/workflows/bmgd-quick-flow.md)** - Rapid prototyping and development
- **[Agents Guide](../../explanation/game-dev/agents.md)** - Agent reference
- **[Game Types Guide](../../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"
---
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](../../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](../../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](../../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
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
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
- **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
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
```bash
/bmad:bmm:workflows:document-project
*document-project
```
---
## 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
**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
- Initial understanding of project structure
- Planning next steps before deeper analysis
**Does NOT read:** Source code files (`_.js`, `_.ts`, `_.py`, `_.go`, etc.)
### 2. Deep Scan
### Deep Scan
**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
- Need detailed analysis of key areas
- Want balance between depth and speed
**Example:** For a web app, reads controllers/, models/, components/, but not every utility file
### 3. Exhaustive Scan
### Exhaustive Scan
**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
- Migration planning requires full understanding
- 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
The workflow can be interrupted and resumed without losing progress:
- **State Tracking:** Progress saved in `project-scan-report.json`
- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old)
- **Resume Prompt:** Choose to resume or start fresh
- **Step-by-Step:** Resume from exact step where interrupted
- **Archiving:** Old state files automatically archived
**Related Documentation:**
- [Brownfield Development Guide](../../how-to/brownfield/index.md)
- [Implementation Workflows](../../how-to/workflows/run-sprint-planning.md)
- **State Tracking** — Progress saved in `project-scan-report.json`
- **Auto-Detection** — Workflow detects incomplete runs (<24 hours old)
- **Resume Prompt** — Choose to resume or start fresh
- **Step-by-Step** — Resume from exact step where interrupted
- **Archiving** — Old state files automatically archived

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

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

14
docs/tutorials/advanced/create-custom-agent.md
View File

@ -6,7 +6,7 @@ title: "Create a Custom Agent"
Build your own AI agent with a unique personality, specialized commands, and optional persistent memory using the BMad Builder workflow.
:::note[BMB Module]
This tutorial uses the **BMad Builder (BMB)** module. Make sure you have BMAD installed with the BMB module enabled.
This tutorial uses the **BMad Builder (BMB)** module. Make sure you have BMad installed with the BMB module enabled.
:::
## What You'll Learn
@ -18,7 +18,7 @@ This tutorial uses the **BMad Builder (BMB)** module. Make sure you have BMAD in
- Test and iterate on your agent's behavior
:::note[Prerequisites]
- BMAD installed with the BMB module
- BMad installed with the BMB module
- An idea for what you want your agent to do
- About 15-30 minutes for your first agent
:::
@ -102,7 +102,7 @@ my-custom-stuff/
└── workflows/ # Optional: custom workflows
```
Install using the BMAD installer, then invoke your new agent in your IDE.
Install using the BMad installer, then invoke your new agent in your IDE.
## What You've Accomplished
@ -130,7 +130,7 @@ _bmad/
| Action | How |
| ------------------- | ---------------------------------------------- |
| Start workflow | `"Run the BMAD Builder create-agent workflow"` |
| Start workflow | `"Run the BMad Builder create-agent workflow"` |
| Edit agent directly | Modify `{agent-name}.agent.yaml` |
| Edit customization | Modify `_bmad/_config/agents/{agent-name}` |
| Rebuild agent | `npx bmad-method build <agent-name>` |
@ -159,9 +159,9 @@ Study the reference agents in `src/modules/bmb/reference/agents/`:
## Further Reading
- **[What Are Agents](../../explanation/core-concepts/what-are-agents.md)** - Deep technical details on agent types
- **[Agent Customization](../../how-to/customization/customize-agents.md)** - Modify agents without editing core files
- **[Custom Content Installation](../../how-to/installation/install-custom-modules.md)** - Package and distribute your agents
- **[What Are Agents](/docs/explanation/core-concepts/what-are-agents.md)** - Deep technical details on agent types
- **[Agent Customization](/docs/how-to/customization/customize-agents.md)** - Modify agents without editing core files
- **[Custom Content Installation](/docs/how-to/installation/install-custom-modules.md)** - Package and distribute your agents
:::tip[Key Takeaways]
- **Start small** - Your first agent should solve one problem well

23
docs/tutorials/getting-started/getting-started-bmadv6.md
View File

@ -1,15 +1,14 @@
---
title: "Getting Started with BMad v6 Alpha"
description: Install BMad v6 Alpha and build your first project
title: "Getting Started with the BMad Method"
description: Install BMad and build your first project
---
**Upgrading from previous versions?** See the [Upgrade Guide](/docs/how-to/installation/upgrade-to-v6.md) instead.
---
Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation.
:::caution[Alpha Software]
BMad v6 is currently in **alpha**. Expect breaking changes, incomplete features, and evolving documentation. For a stable experience, use the [BMad v4 tutorial](./getting-started-bmadv4.md) instead.
:::
## What You'll Learn
- Install and initialize BMad Method for a new project
@ -37,7 +36,7 @@ BMad v6 is currently in **alpha**. Expect breaking changes, incomplete features,
BMad helps you build software through guided workflows with specialized AI agents. The process follows four phases:
| Phase | Name | What Happens |
|-------|------|--------------|
| ----- | -------------- | --------------------------------------------------- |
| 1 | Analysis | Brainstorming, research, product brief *(optional)* |
| 2 | Planning | Create requirements (PRD or tech-spec) |
| 3 | Solutioning | Design architecture *(BMad Method/Enterprise only)* |
@ -50,7 +49,7 @@ BMad helps you build software through guided workflows with specialized AI agent
Based on your project's complexity, BMad offers three planning tracks:
| Track | Best For | Documents Created |
|-------|----------|-------------------|
| --------------- | ------------------------------------------------------ | -------------------------------------- |
| **Quick Flow** | Bug fixes, simple features, clear scope (1-15 stories) | Tech-spec only |
| **BMad Method** | Products, platforms, complex features (10-50+ stories) | PRD + Architecture + UX |
| **Enterprise** | Compliance, multi-tenant systems (30+ stories) | PRD + Architecture + Security + DevOps |
@ -84,7 +83,7 @@ your-project/
```
:::tip[Troubleshooting]
Having issues? See [Install BMad](../../how-to/installation/install-bmad.md) for common solutions.
Having issues? See [Install BMad](/docs/how-to/installation/install-bmad.md) for common solutions.
:::
## Step 1: Initialize Your Project
@ -167,7 +166,7 @@ Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yam
For each story, repeat this cycle with fresh chats:
| Step | Agent | Workflow | Purpose |
|------|-------|----------|---------|
| ---- | ----- | -------------- | ------------------------------------- |
| 1 | SM | `create-story` | Create story file from epic |
| 2 | DEV | `dev-story` | Implement the story |
| 3 | TEA | `automate` | Generate guardrail tests *(optional)* |
@ -201,7 +200,7 @@ your-project/
## Quick Reference
| Command | Agent | Purpose |
|---------|-------|---------|
| --------------------------- | --------- | ------------------------------------ |
| `*workflow-init` | Analyst | Initialize a new project |
| `*workflow-status` | Any | Check progress and next steps |
| `*prd` | PM | Create Product Requirements Document |
@ -231,7 +230,7 @@ Yes, once you learn the flow. Use the Quick Reference to go directly to needed w
- **During workflows** — Agents guide you with questions and explanations
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
- **Documentation** — [BMM Workflow Reference](../../reference/workflows/index.md)
- **Documentation** — [BMM Workflow Reference](/docs/reference/workflows/index.md)
- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode)
## Key Takeaways

12
docs/tutorials/getting-started/quick-start-bmgd.md
View File

@ -7,7 +7,7 @@ description: Build games with BMad's Game Development Module
Build games faster using AI-powered workflows with specialized game development agents that guide you through preproduction, design, architecture, and implementation.
:::note[Module Extension]
BMGD (BMad Game Development) is a module that extends BMad Method. You'll need BMad installed first—see the [BMad v4 tutorial](./getting-started-bmadv4.md) or [BMad v6 tutorial](./getting-started-bmadv6.md) if you haven't installed it yet.
BMGD (BMad Game Development) is a module that extends BMad Method. You'll need BMad installed first—see the [BMad v6 tutorial](/docs/tutorials/getting-started/getting-started-bmadv6.md) if you haven't installed it yet.
:::
## What You'll Learn
@ -37,7 +37,7 @@ BMGD (BMad Game Development) is a module that extends BMad Method. You'll need B
BMGD follows four game development phases with specialized agents for each:
| Phase | Name | What Happens |
|-------|------|--------------|
| ----- | ------------- | ----------------------------------------------------------------- |
| 1 | Preproduction | Capture game vision, create Game Brief *(optional brainstorming)* |
| 2 | Design | Detail mechanics, systems, narrative in GDD |
| 3 | Technical | Plan engine, architecture, technical decisions |
@ -50,7 +50,7 @@ BMGD follows four game development phases with specialized agents for each:
### Game Development Agents
| Agent | When to Use |
|-------|-------------|
| --------------------- | ----------------------------------------- |
| **Game Designer** | Brainstorming, Game Brief, GDD, Narrative |
| **Game Architect** | Architecture, technical decisions |
| **Game Developer** | Implementation, code reviews |
@ -172,7 +172,7 @@ Load the **Game Scrum Master** agent and run `sprint-planning`. This creates `sp
For each story, repeat this cycle with fresh chats:
| Step | Agent | Workflow | Purpose |
|------|-------|----------|---------|
| ---- | -------- | -------------- | ---------------------------------- |
| 1 | Game SM | `create-story` | Create story file from epic |
| 2 | Game Dev | `dev-story` | Implement the story |
| 3 | Game QA | `automate` | Generate tests *(optional)* |
@ -214,7 +214,7 @@ your-project/
## Quick Reference
| Command | Agent | Purpose |
|---------|-------|---------|
| ---------------------- | -------------- | ----------------------------- |
| `*brainstorm-game` | Game Designer | Guided game ideation |
| `*create-game-brief` | Game Designer | Create Game Brief |
| `*create-gdd` | Game Designer | Create Game Design Document |
@ -244,7 +244,7 @@ Yes. Documents are living artifacts—return to update them as your vision evolv
- **During workflows** — Agents guide you with questions and explanations
- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#bmad-method-help, #report-bugs-and-issues)
- **Documentation** — [BMGD Workflow Reference](../../reference/workflows/bmgd-workflows.md)
- **Documentation** — [BMGD Workflow Reference](/docs/reference/workflows/bmgd-workflows.md)
- **Video tutorials** — [BMad Code YouTube](https://www.youtube.com/@BMadCode)
## Key Takeaways

21
docs/tutorials/index.md
View File

@ -1,21 +0,0 @@
---
title: "Tutorials"
---
Learning-oriented guides that walk you through building something real with BMad. Perfect for getting hands-on experience.
## Getting Started
Start your journey with BMad by choosing a version that fits your needs:
- [Get Started with v4 (Stable)](./getting-started/getting-started-bmadv4.md) — Production-ready version with battle-tested workflows
- [Try v6 (Alpha)](./getting-started/getting-started-bmadv6.md) — Latest features, still in active development
## First Project
Your first end-to-end project with BMad.
## Advanced
More complex scenarios and advanced patterns.

194
package-lock.json generated
View File

@ -1,12 +1,12 @@
{
"name": "bmad-method",
"version": "6.0.0-alpha.22",
"version": "6.0.0-alpha.23",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "bmad-method",
"version": "6.0.0-alpha.22",
"version": "6.0.0-alpha.23",
"license": "MIT",
"dependencies": {
"@kayvan/markdown-tree-parser": "^1.6.1",
@ -19,7 +19,6 @@
"fs-extra": "^11.3.0",
"glob": "^11.0.3",
"ignore": "^7.0.5",
"inquirer": "^9.3.8",
"js-yaml": "^4.1.0",
"ora": "^5.4.1",
"semver": "^7.6.3",
@ -34,6 +33,7 @@
"devDependencies": {
"@astrojs/sitemap": "^3.6.0",
"@astrojs/starlight": "^0.37.0",
"@clack/prompts": "^0.11.0",
"@eslint/js": "^9.33.0",
"archiver": "^7.0.1",
"astro": "^5.16.0",
@ -47,7 +47,7 @@
"jest": "^30.0.4",
"lint-staged": "^16.1.1",
"markdownlint-cli2": "^0.19.1",
"prettier": "^3.5.3",
"prettier": "^3.7.4",
"prettier-plugin-packagejson": "^2.5.19",
"sharp": "^0.33.5",
"yaml-eslint-parser": "^1.2.3",
@ -244,7 +244,6 @@
"integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==",
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"@babel/code-frame": "^7.27.1",
"@babel/generator": "^7.28.5",
@ -756,6 +755,29 @@
"node": ">=18"
}
},
"node_modules/@clack/core": {
"version": "0.5.0",
"resolved": "https://registry.npmjs.org/@clack/core/-/core-0.5.0.tgz",
"integrity": "sha512-p3y0FIOwaYRUPRcMO7+dlmLh8PSRcrjuTndsiA0WAFbWES0mLZlrjVoBRZ9DzkPFJZG6KGkJmoEAY0ZcVWTkow==",
"dev": true,
"license": "MIT",
"dependencies": {
"picocolors": "^1.0.0",
"sisteransi": "^1.0.5"
}
},
"node_modules/@clack/prompts": {
"version": "0.11.0",
"resolved": "https://registry.npmjs.org/@clack/prompts/-/prompts-0.11.0.tgz",
"integrity": "sha512-pMN5FcrEw9hUkZA4f+zLlzivQSeQf5dRGJjSUbvVYDLvpKCdQx5OaknvKzgbtXOizhP+SJJJjqEbOe55uKKfAw==",
"dev": true,
"license": "MIT",
"dependencies": {
"@clack/core": "0.5.0",
"picocolors": "^1.0.0",
"sisteransi": "^1.0.5"
}
},
"node_modules/@colors/colors": {
"version": "1.5.0",
"resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz",
@ -1998,36 +2020,6 @@
"url": "https://opencollective.com/libvips"
}
},
"node_modules/@inquirer/external-editor": {
"version": "1.0.3",
"resolved": "https://registry.npmjs.org/@inquirer/external-editor/-/external-editor-1.0.3.tgz",
"integrity": "sha512-RWbSrDiYmO4LbejWY7ttpxczuwQyZLBUyygsA9Nsv95hpzUWwnNTVQmAq3xuh7vNwCp07UTmE5i11XAEExx4RA==",
"license": "MIT",
"dependencies": {
"chardet": "^2.1.1",
"iconv-lite": "^0.7.0"
},
"engines": {
"node": ">=18"
},
"peerDependencies": {
"@types/node": ">=18"
},
"peerDependenciesMeta": {
"@types/node": {
"optional": true
}
}
},
"node_modules/@inquirer/figures": {
"version": "1.0.15",
"resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.15.tgz",
"integrity": "sha512-t2IEY+unGHOzAaVM5Xx6DEWKeXlDDcNPeDyUpsRc6CUhBfU3VQOEl+Vssh7VNp1dR8MdUJBWhuObjXCsVpjN5g==",
"license": "MIT",
"engines": {
"node": ">=18"
}
},
"node_modules/@isaacs/balanced-match": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz",
@ -3641,9 +3633,8 @@
"version": "25.0.3",
"resolved": "https://registry.npmjs.org/@types/node/-/node-25.0.3.tgz",
"integrity": "sha512-W609buLVRVmeW693xKfzHeIV6nJGGz98uCPfeXI1ELMLXVeKYZ9m15fAMSaUPBHYLGFsVRcMmSCksQOrZV9BYA==",
"devOptional": true,
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"undici-types": "~7.16.0"
}
@ -3983,7 +3974,6 @@
"integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==",
"dev": true,
"license": "MIT",
"peer": true,
"bin": {
"acorn": "bin/acorn"
},
@ -4031,6 +4021,7 @@
"version": "4.3.2",
"resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz",
"integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==",
"dev": true,
"license": "MIT",
"dependencies": {
"type-fest": "^0.21.3"
@ -4046,6 +4037,7 @@
"version": "0.21.3",
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz",
"integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==",
"dev": true,
"license": "(MIT OR CC0-1.0)",
"engines": {
"node": ">=10"
@ -4290,7 +4282,6 @@
"integrity": "sha512-6mF/YrvwwRxLTu+aMEa5pwzKUNl5ZetWbTyZCs9Um0F12HUmxUiF5UHiZPy4rifzU3gtpM3xP2DfdmkNX9eZRg==",
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"@astrojs/compiler": "^2.13.0",
"@astrojs/internal-helpers": "0.7.5",
@ -5358,7 +5349,6 @@
}
],
"license": "MIT",
"peer": true,
"dependencies": {
"baseline-browser-mapping": "^2.9.0",
"caniuse-lite": "^1.0.30001759",
@ -5601,12 +5591,6 @@
"url": "https://github.com/sponsors/wooorm"
}
},
"node_modules/chardet": {
"version": "2.1.1",
"resolved": "https://registry.npmjs.org/chardet/-/chardet-2.1.1.tgz",
"integrity": "sha512-PsezH1rqdV9VvyNhxxOW32/d75r01NY7TQCmOqomRo15ZSOKbpTFVsfjghxo6JloQUCGnH4k1LGu0R4yCLlWQQ==",
"license": "MIT"
},
"node_modules/chokidar": {
"version": "4.0.3",
"resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz",
@ -5787,15 +5771,6 @@
"url": "https://github.com/chalk/strip-ansi?sponsor=1"
}
},
"node_modules/cli-width": {
"version": "4.1.0",
"resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
"integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
"license": "ISC",
"engines": {
"node": ">= 12"
}
},
"node_modules/cliui": {
"version": "8.0.1",
"resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
@ -6689,7 +6664,6 @@
"integrity": "sha512-LEyamqS7W5HB3ujJyvi0HQK/dtVINZvd5mAAp9eT5S/ujByGjiZLCzPcHVzuXbpJDJF/cxwHlfceVUDZ2lnSTw==",
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"@eslint-community/eslint-utils": "^4.8.0",
"@eslint-community/regexpp": "^4.12.1",
@ -8269,22 +8243,6 @@
"@babel/runtime": "^7.23.2"
}
},
"node_modules/iconv-lite": {
"version": "0.7.1",
"resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.1.tgz",
"integrity": "sha512-2Tth85cXwGFHfvRgZWszZSvdo+0Xsqmw8k8ZwxScfcBneNUraK+dxRxRm24nszx80Y0TVio8kKLt5sLE7ZCLlw==",
"license": "MIT",
"dependencies": {
"safer-buffer": ">= 2.1.2 < 3.0.0"
},
"engines": {
"node": ">=0.10.0"
},
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/express"
}
},
"node_modules/ieee754": {
"version": "1.2.1",
"resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz",
@ -8420,43 +8378,6 @@
"dev": true,
"license": "MIT"
},
"node_modules/inquirer": {
"version": "9.3.8",
"resolved": "https://registry.npmjs.org/inquirer/-/inquirer-9.3.8.tgz",
"integrity": "sha512-pFGGdaHrmRKMh4WoDDSowddgjT1Vkl90atobmTeSmcPGdYiwikch/m/Ef5wRaiamHejtw0cUUMMerzDUXCci2w==",
"license": "MIT",
"dependencies": {
"@inquirer/external-editor": "^1.0.2",
"@inquirer/figures": "^1.0.3",
"ansi-escapes": "^4.3.2",
"cli-width": "^4.1.0",
"mute-stream": "1.0.0",
"ora": "^5.4.1",
"run-async": "^3.0.0",
"rxjs": "^7.8.1",
"string-width": "^4.2.3",
"strip-ansi": "^6.0.1",
"wrap-ansi": "^6.2.0",
"yoctocolors-cjs": "^2.1.2"
},
"engines": {
"node": ">=18"
}
},
"node_modules/inquirer/node_modules/wrap-ansi": {
"version": "6.2.0",
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz",
"integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==",
"license": "MIT",
"dependencies": {
"ansi-styles": "^4.0.0",
"string-width": "^4.1.0",
"strip-ansi": "^6.0.0"
},
"engines": {
"node": ">=8"
}
},
"node_modules/iron-webcrypto": {
"version": "1.2.1",
"resolved": "https://registry.npmjs.org/iron-webcrypto/-/iron-webcrypto-1.2.1.tgz",
@ -10304,7 +10225,6 @@
"integrity": "sha512-p3JTemJJbkiMjXEMiFwgm0v6ym5g8K+b2oDny+6xdl300tUKySxvilJQLSea48C6OaYNmO30kH9KxpiAg5bWJw==",
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"globby": "15.0.0",
"js-yaml": "4.1.1",
@ -11576,15 +11496,6 @@
"integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
"license": "MIT"
},
"node_modules/mute-stream": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-1.0.0.tgz",
"integrity": "sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA==",
"license": "ISC",
"engines": {
"node": "^14.17.0 || ^16.13.0 || >=18.0.0"
}
},
"node_modules/nano-spawn": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/nano-spawn/-/nano-spawn-2.0.0.tgz",
@ -12378,7 +12289,6 @@
}
],
"license": "MIT",
"peer": true,
"dependencies": {
"nanoid": "^3.3.11",
"picocolors": "^1.1.1",
@ -12444,7 +12354,6 @@
"integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==",
"dev": true,
"license": "MIT",
"peer": true,
"bin": {
"prettier": "bin/prettier.cjs"
},
@ -13273,7 +13182,6 @@
"integrity": "sha512-3nk8Y3a9Ea8szgKhinMlGMhGMw89mqule3KWczxhIzqudyHdCIOHw8WJlj/r329fACjKLEh13ZSk7oE22kyeIw==",
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"@types/estree": "1.0.8"
},
@ -13310,15 +13218,6 @@
"fsevents": "~2.3.2"
}
},
"node_modules/run-async": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/run-async/-/run-async-3.0.0.tgz",
"integrity": "sha512-540WwVDOMxA6dN6We19EcT9sc3hkXPw5mzRNGM3FkdN/vtE9NFvj5lFAPNwUDmJjXidm3v7TC1cTE7t17Ulm1Q==",
"license": "MIT",
"engines": {
"node": ">=0.12.0"
}
},
"node_modules/run-parallel": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
@ -13343,15 +13242,6 @@
"queue-microtask": "^1.2.2"
}
},
"node_modules/rxjs": {
"version": "7.8.2",
"resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.2.tgz",
"integrity": "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==",
"license": "Apache-2.0",
"dependencies": {
"tslib": "^2.1.0"
}
},
"node_modules/safe-buffer": {
"version": "5.2.1",
"resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
@ -13372,12 +13262,6 @@
],
"license": "MIT"
},
"node_modules/safer-buffer": {
"version": "2.1.2",
"resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz",
"integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==",
"license": "MIT"
},
"node_modules/sax": {
"version": "1.4.3",
"resolved": "https://registry.npmjs.org/sax/-/sax-1.4.3.tgz",
@ -14251,6 +14135,7 @@
"version": "2.8.1",
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
"integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
"dev": true,
"license": "0BSD"
},
"node_modules/type-check": {
@ -14335,7 +14220,7 @@
"version": "7.16.0",
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz",
"integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==",
"devOptional": true,
"dev": true,
"license": "MIT"
},
"node_modules/unicode-properties": {
@ -14837,7 +14722,6 @@
"integrity": "sha512-+Oxm7q9hDoLMyJOYfUYBuHQo+dkAloi33apOPP56pzj+vsdJDzr+j1NISE5pyaAuKL4A3UD34qd0lx5+kfKp2g==",
"dev": true,
"license": "MIT",
"peer": true,
"dependencies": {
"esbuild": "^0.25.0",
"fdir": "^6.4.4",
@ -15111,7 +14995,6 @@
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz",
"integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==",
"license": "ISC",
"peer": true,
"bin": {
"yaml": "bin.mjs"
},
@ -15270,18 +15153,6 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/yoctocolors-cjs": {
"version": "2.1.3",
"resolved": "https://registry.npmjs.org/yoctocolors-cjs/-/yoctocolors-cjs-2.1.3.tgz",
"integrity": "sha512-U/PBtDf35ff0D8X8D0jfdzHYEPFxAI7jJlxZXwCSez5M3190m+QobIfh+sWDWSHMCWWJN2AWamkegn6vr6YBTw==",
"license": "MIT",
"engines": {
"node": ">=18"
},
"funding": {
"url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/zip-stream": {
"version": "6.0.1",
"resolved": "https://registry.npmjs.org/zip-stream/-/zip-stream-6.0.1.tgz",
@ -15303,7 +15174,6 @@
"integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==",
"dev": true,
"license": "MIT",
"peer": true,
"funding": {
"url": "https://github.com/sponsors/colinhacks"
}

9
package.json
View File

@ -1,7 +1,7 @@
{
"$schema": "https://json.schemastore.org/package.json",
"name": "bmad-method",
"version": "6.0.0-alpha.22",
"version": "6.0.0-alpha.23",
"description": "Breakthrough Method of Agile AI-driven Development",
"keywords": [
"agile",
@ -27,9 +27,10 @@
"bmad:install": "node tools/cli/bmad-cli.js install",
"bundle": "node tools/cli/bundlers/bundle-web.js all",
"docs:build": "node tools/build-docs.js",
"docs:check-links": "node tools/check-doc-links.js",
"docs:dev": "astro dev --root website",
"docs:fix-links": "node tools/fix-doc-links.js",
"docs:preview": "astro preview --root website",
"docs:validate-links": "node tools/validate-doc-links.js",
"flatten": "node tools/flattener/main.js",
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
@ -66,6 +67,7 @@
]
},
"dependencies": {
"@clack/prompts": "^0.11.0",
"@kayvan/markdown-tree-parser": "^1.6.1",
"boxen": "^5.1.2",
"chalk": "^4.1.2",
@ -76,7 +78,6 @@
"fs-extra": "^11.3.0",
"glob": "^11.0.3",
"ignore": "^7.0.5",
"inquirer": "^9.3.8",
"js-yaml": "^4.1.0",
"ora": "^5.4.1",
"semver": "^7.6.3",
@ -100,7 +101,7 @@
"jest": "^30.0.4",
"lint-staged": "^16.1.1",
"markdownlint-cli2": "^0.19.1",
"prettier": "^3.5.3",
"prettier": "^3.7.4",
"prettier-plugin-packagejson": "^2.5.19",
"sharp": "^0.33.5",
"yaml-eslint-parser": "^1.2.3",

2
samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/installers.md
View File

@ -61,7 +61,7 @@
| -------------- | -------------- | ------------------------- | ----------------------------- |
| claude-code | Claude Code | .claude/commands/ | .md with frontmatter |
| codex | Codex | (varies) | .md |
| cursor | Cursor | .cursor/rules/bmad/ | .mdc with MDC frontmatter |
| cursor | Cursor | .cursor/commands/bmad/ | .md with YAML frontmatter |
| github-copilot | GitHub Copilot | .github/ | .md |
| opencode | OpenCode | .opencode/ | .md |
| windsurf | Windsurf | .windsurf/workflows/bmad/ | .md with workflow frontmatter |

2
samples/sample-custom-modules/sample-unitary-module/agents/toolsmith/toolsmith-sidecar/knowledge/modules.md
View File

@ -128,7 +128,7 @@ module.exports = { NewIdeSetup };
| IDE | Config Pattern | File Extension |
| -------------- | ------------------------- | -------------- |
| Claude Code | .claude/commands/bmad/ | .md |
| Cursor | .cursor/rules/bmad/ | .mdc |
| Cursor | .cursor/commands/bmad/ | .md |
| Windsurf | .windsurf/workflows/bmad/ | .md |
| GitHub Copilot | .github/ | .md |

6
samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-01-init.md
View File

@ -6,8 +6,8 @@ description: 'Initialize quiz game with mode selection and category choice'
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-01-init.md'
nextStepFile: '{workflow_path}/steps/step-02-q1.md'
thisStepFile: './step-01-init.md'
nextStepFile: './step-02-q1.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
csvTemplate: '{workflow_path}/templates/csv-headers.template'
@ -146,7 +146,7 @@ Display: **Starting your quiz adventure...**
## CRITICAL STEP COMPLETION NOTE
ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `{workflow_path}/steps/step-02-q1.md` to begin the first question.
ONLY WHEN setup is complete (mode selected, category chosen, CSV initialized) will you then load, read fully, and execute `./step-02-q1.md` to begin the first question.
## 🚨 SYSTEM SUCCESS/FAILURE METRICS

6
samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-02-q1.md
View File

@ -6,9 +6,9 @@ description: 'Question 1 - Level 1 difficulty'
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-02-q1.md'
nextStepFile: '{workflow_path}/steps/step-03-q2.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
thisStepFile: './step-02-q1.md'
nextStepFile: './step-03-q2.md'
resultsStepFile: './step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
# Task References

6
samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-03-q2.md
View File

@ -6,9 +6,9 @@ description: 'Question 2 - Level 2 difficulty'
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-03-q2.md'
nextStepFile: '{workflow_path}/steps/step-04-q3.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
thisStepFile: './step-03-q2.md'
nextStepFile: './step-04-q3.md'
resultsStepFile: './step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---

6
samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-04-q3.md
View File

@ -6,9 +6,9 @@ description: 'Question 3 - Level 3 difficulty'
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-04-q3.md'
nextStepFile: '{workflow_path}/steps/step-04-q3.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
thisStepFile: './step-04-q3.md'
nextStepFile: './step-04-q3.md'
resultsStepFile: './step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---

6
samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-05-q4.md
View File

@ -6,9 +6,9 @@ description: 'Question 4 - Level 4 difficulty'
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-05-q4.md'
nextStepFile: '{workflow_path}/steps/step-05-q4.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
thisStepFile: './step-05-q4.md'
nextStepFile: './step-05-q4.md'
resultsStepFile: './step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---

6
samples/sample-custom-modules/sample-unitary-module/workflows/quiz-master/steps/step-06-q5.md
View File

@ -6,9 +6,9 @@ description: 'Question 5 - Level 5 difficulty'
workflow_path: '{project-root}/_bmad/custom/src/workflows/quiz-master'
# File References
thisStepFile: '{workflow_path}/steps/step-06-q5.md'
nextStepFile: '{workflow_path}/steps/step-06-q5.md'
resultsStepFile: '{workflow_path}/steps/step-12-results.md'
thisStepFile: './step-06-q5.md'
nextStepFile: './step-06-q5.md'
resultsStepFile: './step-12-results.md'
workflowFile: '{workflow_path}/workflow.md'
csvFile: '{project-root}/BMad-quiz-results.csv'
---

Some files were not shown because too many files have changed in this diff Show More