bmad-method 6.0.0-alpha.21 → 6.0.0-alpha.23

package/docs/explanation/core-concepts/agent-roles.md

@@ -0,0 +1,204 @@
+---
+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 |
+|-------|------|---------------|
+| **Analyst** | Research and discovery | Phase 1 (Analysis) |
+| **PM** | Requirements and planning | Phase 2 (Planning) |
+| **Architect** | Technical design | Phase 3 (Solutioning) |
+| **SM** | Sprint orchestration | Phase 4 (Implementation) |
+| **DEV** | Code implementation | Phase 4 (Implementation) |
+| **TEA** | Test architecture | Phases 3-4 (Cross-phase) |
+| **UX Designer** | User experience | Phase 2-3 |
+| **Quick Flow Solo Dev** | Fast solo development | All phases (Quick Flow) |
+
+---
+
+## Phase 1: Analysis
+
+### Analyst (Mary)
+
+Business analysis and research specialist.
+
+**Responsibilities:**
+- Brainstorming and ideation
+- Market, domain, and competitive research
+- Product brief creation
+- Brownfield project documentation
+
+**Key Workflows:**
+- `*brainstorm-project`
+- `*research`
+- `*product-brief`
+- `*document-project`
+
+**When to use:** Starting new projects, exploring ideas, validating market fit, documenting existing codebases.
+
+---
+
+## Phase 2: Planning
+
+### PM (John)
+
+Product requirements and planning expert.
+
+**Responsibilities:**
+- Creating Product Requirements Documents
+- Defining functional and non-functional requirements
+- Breaking requirements into epics and stories
+- Validating implementation readiness
+
+**Key Workflows:**
+- `*create-prd`
+- `*create-epics-and-stories`
+- `*implementation-readiness`
+
+**When to use:** Defining what to build, creating PRDs, organizing work into stories.
+
+### UX Designer (Sally)
+
+User experience and UI design specialist.
+
+**Responsibilities:**
+- UX specification creation
+- User journey mapping
+- Wireframe and mockup design
+- Design system documentation
+
+**Key Workflows:**
+- `*create-ux-design`
+- `*validate-design`
+
+**When to use:** When UX is a primary differentiator, complex user workflows, design system creation.
+
+---
+
+## Phase 3: Solutioning
+
+### Architect (Winston)
+
+System architecture and technical design expert.
+
+**Responsibilities:**
+- System architecture design
+- Architecture Decision Records (ADRs)
+- Technical standards definition
+- Implementation readiness validation
+
+**Key Workflows:**
+- `*create-architecture`
+- `*implementation-readiness`
+
+**When to use:** Multi-epic projects, cross-cutting technical decisions, preventing agent conflicts.
+
+---
+
+## Phase 4: Implementation
+
+### SM (Bob)
+
+Sprint planning and story preparation orchestrator.
+
+**Responsibilities:**
+- Sprint planning and tracking
+- Story preparation for development
+- Course correction handling
+- Epic retrospectives
+
+**Key Workflows:**
+- `*sprint-planning`
+- `*create-story`
+- `*correct-course`
+- `*epic-retrospective`
+
+**When to use:** Organizing work, preparing stories, tracking progress.
+
+### DEV (Amelia)
+
+Story implementation and code review specialist.
+
+**Responsibilities:**
+- Story implementation with tests
+- Code review
+- Following architecture patterns
+- Quality assurance
+
+**Key Workflows:**
+- `*dev-story`
+- `*code-review`
+
+**When to use:** Writing code, implementing stories, reviewing quality.
+
+---
+
+## Cross-Phase Agents
+
+### TEA (Murat)
+
+Test architecture and quality strategy expert.
+
+**Responsibilities:**
+- Test framework setup
+- Test design and planning
+- ATDD and automation
+- Quality gate decisions
+
+**Key Workflows:**
+- `*framework`, `*ci`
+- `*test-design`, `*atdd`, `*automate`
+- `*test-review`, `*trace`, `*nfr-assess`
+
+**When to use:** Setting up testing, creating test plans, quality gates.
+
+---
+
+## Quick Flow
+
+### Quick Flow Solo Dev (Barry)
+
+Fast solo development without handoffs.
+
+**Responsibilities:**
+- Technical specification
+- End-to-end implementation
+- Code review
+
+**Key Workflows:**
+- `*quick-spec`
+- `*quick-dev`
+- `*code-review`
+
+**When to use:** Bug fixes, small features, rapid prototyping.
+
+---
+
+## Choosing the Right Agent
+
+| Task | Agent |
+|------|-------|
+| Brainstorming ideas | Analyst |
+| Market research | Analyst |
+| Creating PRD | PM |
+| Designing UX | UX Designer |
+| System architecture | Architect |
+| Preparing stories | SM |
+| Writing code | DEV |
+| Setting up tests | TEA |
+| Quick bug fix | Quick Flow Solo Dev |
+
+---
+
+## Related
+
+- [What Are Agents](/docs/explanation/core-concepts/what-are-agents.md) - Foundational concepts
+- [Agent Reference](/docs/reference/agents/index.md) - Complete command reference
+- [Quick Start Guide](/docs/tutorials/getting-started/getting-started-bmadv6.md)

package/docs/explanation/core-concepts/index.md

@@ -0,0 +1,40 @@
+---
+title: "BMad Core Concepts"
+---
+
+
+Understanding the fundamental building blocks of the BMad Method.
+
+## The Essentials
+
+| Concept | Description | Guide |
+|---------|-------------|-------|
+| **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:
+
+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
+
+- **[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](/docs/how-to/customization/index.md)** - Personalize agents and workflows
+
+### Advanced
+
+- **[Web Bundles](/docs/explanation/features/web-bundles.md)** - Use BMad in Gemini Gems and Custom GPTs
+
+---
+
+**Next:** Read the [Agents Guide](/docs/explanation/core-concepts/what-are-agents.md) to understand the core building block of BMad.

package/docs/explanation/core-concepts/what-are-agents.md

@@ -0,0 +1,96 @@
+---
+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:
+
+### Simple Agents
+
+**Self-contained, focused, ready to use.**
+
+Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
+
+**Best for:**
+- Single-purpose assistants (code review, documentation, commit messages)
+- Quick deployment
+- Projects that don't require persistent memory
+- Getting started fast
+
+**Example:** A commit message agent that reads your git diff and generates conventional commits.
+
+### Expert Agents
+
+**Powerful, memory-equipped, domain specialists.**
+
+Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks.
+
+**Best for:**
+- Domain specialists (security architect, game designer, product manager)
+- Tasks requiring persistent memory
+- Complex workflows with multiple stages
+- Projects that grow over time
+
+**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
+
+## Key Differences
+
+| Feature          | Simple         | Expert                     |
+| ---------------- | -------------- | -------------------------- |
+| **Files**        | Single file    | Agent + sidecar folder     |
+| **Memory**       | Session only   | Persistent across sessions |
+| **Capabilities** | Focused scope  | Multi-domain, extensible   |
+| **Setup**        | Zero config    | Sidecar initialization     |
+| **Best Use**     | Specific tasks | Ongoing projects           |
+
+## Agent Components
+
+All agents share these building blocks:
+
+### Persona
+- **Role** - What the agent does (expertise domain)
+- **Identity** - Who the agent is (personality, character)
+- **Communication Style** - How the agent speaks (tone, voice)
+- **Principles** - Why the agent acts (values, decision framework)
+
+### Capabilities
+- Skills, tools, and knowledge the agent can apply
+- Mapped to specific menu commands
+
+### Menu
+- Interactive command list
+- Triggers, descriptions, and handlers
+- Auto-includes help and exit options
+
+### Critical Actions (optional)
+- Instructions that execute before the agent starts
+- Enable autonomous behaviors (e.g., "check git status before changes")
+
+## Which Should You Use?
+
+**Choose Simple when:**
+- You need a task done quickly and reliably
+- The scope is well-defined and won't change much
+- You don't need the agent to remember things between sessions
+
+**Choose Expert when:**
+- You're building something complex over time
+- The agent needs to maintain context (project history, decisions)
+- You want the agent to coordinate workflows or other agents
+- Domain expertise requires specialized knowledge bases
+
+## Creating Custom Agents
+
+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](/docs/how-to/customization/index.md) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
+
+---
+
+**Next:** Learn about [Workflows](/docs/explanation/core-concepts/what-are-workflows.md) to see how agents accomplish complex tasks.

package/docs/explanation/core-concepts/what-are-modules.md

@@ -0,0 +1,79 @@
+---
+title: "Modules"
+---
+
+
+Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
+
+## What is a Module?
+
+A module is a self-contained package that includes:
+
+- **Agents** - Specialized AI assistants
+- **Workflows** - Step-by-step processes
+- **Configuration** - Module-specific settings
+- **Documentation** - Usage guides and reference
+
+## Official Modules
+
+### 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)
+Software and game development:
+- Project planning workflows
+- Implementation agents (Dev, PM, QA, Scrum Master)
+- Testing and architecture guidance
+
+### BMad Builder (BMB)
+Create custom solutions:
+- Agent creation workflows
+- Workflow authoring tools
+- Module scaffolding
+
+### Creative Intelligence Suite (CIS)
+Innovation and creativity:
+- Creative thinking techniques
+- Innovation strategy workflows
+- Storytelling and ideation
+
+### BMad Game Dev (BMGD)
+Game development specialization:
+- Game design workflows
+- Narrative development
+- Performance testing frameworks
+
+## Module Structure
+
+Installed modules follow this structure:
+
+```
+_bmad/
+├── core/           # Always present
+├── bmm/            # BMad Method (if installed)
+├── bmb/            # BMad Builder (if installed)
+├── cis/            # Creative Intelligence (if installed)
+└── bmgd/           # Game Dev (if installed)
+```
+
+## Custom Modules
+
+You can create your own modules containing:
+- Custom agents for your domain
+- Organizational workflows
+- Team-specific configurations
+
+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.
+
+See [Installation Guide](/docs/how-to/installation/index.md) for details.
+
+---
+
+**Next:** Read the [Installation Guide](/docs/how-to/installation/index.md) to set up BMad with the modules you need.

package/docs/explanation/core-concepts/what-are-workflows.md

@@ -0,0 +1,217 @@
+---
+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.
+
+Think of it this way: instead of asking "help me build a nutrition plan" and getting a generic response, a workflow guides you (or runs automatically) through discovery, assessment, strategy, shopping lists, and prep schedules—each step building on the last, nothing missed, no shortcuts taken.
+
+## How do workflows differ from skills?
+
+Actually they really do not - a workflow can be a skill, and a skill can be a workflow. The main thing with a BMad workflow is the suggestion to follow certain conventions, which actually are also skill best practices. A skill has a few optional and required fields to add as the main file workflow and get stored in a specific location depending on your tool choice for automatic invocation by the llm - whereas workflows are generally intentionally launched, with from another process calling them, or a user invoking via a slash command. In the near future, workflows will optionally be installable as skills also - but if you like, you can add front matter to your custom workflows based on the skill spec from Anthropic, and put them in the proper location your tool dictates.
+
+### The Power of Progressive Disclosure
+
+Here's why workflows work so well: the AI only sees the current step. It doesn't know about step 5 when it's on step 2. It can't get ahead of itself, skip steps, or lose focus. Each step gets the AI's full attention, completing fully before the next step loads.
+
+This is the opposite of a giant prompt that tries to handle everything at once and inevitably misses details or loses coherence.
+
+Workflows exist on a spectrum:
+
+- **Interactive workflows** guide users through complex decisions via collaboration and facilitation
+- **Automated workflows** run with minimal user input, processing documents or executing tasks
+- **Hybrid workflows** combine both—some steps need user input, others run automatically
+
+### Real-World Workflow Examples
+
+**Tax Organizer Workflow**
+
+A tax preparation workflow that helps users organize financial documents for tax filing. Runs in a single session, follows prescriptive IRS categories, produces a checklist of required documents with missing-item alerts. Sequential and compliance-focused.
+
+**Meal Planning Workflow**
+
+Creates personalized weekly meal plans through collaborative nutrition planning. Users can stop mid-session and return later because the workflow tracks progress. Intent-based conversation helps discover preferences rather than following a script. Multi-session, creative, and highly interactive.
+
+**Course Creator Workflow**
+
+Helps instructors design course syllabi. Branches based on course type—academic courses need accreditation sections, vocational courses need certification prep, self-paced courses need different structures entirely.
+
+**Therapy Intake Workflow**
+
+Guides mental health professionals through structured client intake sessions. Highly sensitive and confidential, uses intent-based questioning to build rapport while ensuring all required clinical information is collected. Continuable across multiple sessions.
+
+**Software Architecture Workflow** (BMM Module)
+
+Part of a larger software development pipeline. Runs after product requirements and UX design are complete, takes those documents as input, then collaboratively walks through technical decisions: system components, data flows, technology choices, architectural patterns. Produces an architecture document that implementation teams use to build consistently.
+
+**Shard Document Workflow**
+
+Nearly hands-off automated workflow. Takes a large document as input, uses a custom npx tool to split it into smaller files, deletes the original, then augments an index with content details so the LLM can efficiently find and reference specific sections later. Minimal user interaction—just specify the input document.
+
+These examples show the range: from collaborative creative processes to automated batch jobs, workflows ensure completeness and consistency whether the work involves deep collaboration or minimal human oversight.
+
+### The Facilitative Philosophy
+
+When workflows involve users, they should be **facilitative, not directive**. The AI treats users as partners and domain experts, not as passive recipients of generated content.
+
+**Collaborative dialogue, not command-response**: The AI and user work together throughout. The AI brings structured thinking, methodology, and technical knowledge. The user brings domain expertise, context, and judgment. Together they produce something better than either could alone.
+
+**The user is the expert in their domain**: A nutrition planning workflow doesn't dictate meal plans—it guides users through discovering what works for their lifestyle. An architecture workflow doesn't tell architects what to build—it facilitates systematic decision-making so choices are explicit and consistent.
+
+**Intent-based facilitation**: Workflows should describe goals and approaches, not scripts. Instead of "Ask: What is your age? Then ask: What is your goal weight?" use "Guide the user through understanding their health profile. Ask 1-2 questions at a time. Think about their responses before asking follow-ups. Probe to understand their actual needs."
+
+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.
+
+---
+
+## Why Workflows Matter
+
+Workflows solve three fundamental problems with AI interactions:
+
+**Focus**: Each step contains only instructions for that phase. The AI sees one step at a time, preventing it from getting ahead of itself or losing focus.
+
+**Continuity**: Workflows can span multiple sessions. Stop mid-workflow and return later without losing progress—something free-form prompts can't do.
+
+**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
+
+Workflows consist of multiple markdown files, each representing one step:
+
+```
+my-workflow/
+├── workflow.md              # Entry point and configuration
+├── steps/                   # Step files (steps-c/ for create, steps-e/ for edit, steps-v/ for validate)
+│   ├── step-01-init.md
+│   ├── step-02-profile.md
+│   └── step-N-final.md
+├── data/                    # Reference materials, CSVs, examples
+└── templates/               # Output document templates
+```
+
+The `workflow.md` file is minimal—it contains the workflow name, description, goal, the AI's role, and how to start. Importantly, it does not list all steps or detail what each does. This is progressive disclosure in action.
+
+### Sequential Execution
+
+Workflows execute in strict sequence: `step-01 → step-02 → step-03 → ... → step-N`
+
+The AI cannot skip steps or optimize the sequence. It must complete each step fully before loading the next. This ensures thoroughness and prevents shortcuts that compromise quality.
+
+### Continuable Workflows
+
+Some workflows are complex enough that users might need multiple sessions. These "continuable workflows" track which steps are complete in the output document's frontmatter, so users can stop and resume later without losing progress.
+
+Use continuable workflows when:
+- The workflow produces large documents
+- Multiple sessions are likely
+- Complex decisions benefit from reflection
+- The workflow has many steps (8+)
+
+Keep it simple (single-session) when tasks are quick, focused, and can be completed in one sitting.
+
+### Workflow Chaining
+
+Workflows can be chained together where outputs become inputs. The BMM module pipeline is a perfect example:
+
+```
+brainstorming → research → brief → PRD → UX → architecture → epics → sprint-planning
+                                                        ↓
+                                            implement-story → review → repeat
+```
+
+Each workflow checks for required inputs from prior workflows, validates they're complete, and produces output for the next workflow. This creates powerful end-to-end pipelines for complex processes.
+
+### 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.
+
+**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.
+
+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:
+
+**Module affiliation**: Is this standalone or part of a module? Module-based workflows can access module-specific variables and reference other workflow outputs. Also when part of a module, generally they will be associated to an agent.
+
+**Continuable or single-session?**: Will users need multiple sessions, or can this be completed in one sitting?
+
+**Edit/Validate support?**: Do you need Create/Edit/Validate modes (tri-modal structure)? Use tri-modal for complex, critical workflows requiring quality assurance. Use create-only for simple, one-off workflows.
+
+**Document output?**: Does this produce a persistent file, or perform actions without output?
+
+**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:
+
+- **BMB (Module Builder)**: Workflow and agent creation workflows
+- **BMM (Business Method Module)**: Complete software development pipeline from brainstorming through sprint planning
+- **BMGD (Game Development Module)**: Game design briefs, narratives, architecture
+- **CIS (Creativity, Innovation, Strategy)**: Brainstorming, design thinking, storytelling, innovation strategy
+
+Study the workflow.md files to understand how each workflow starts. Examine step files to see how instructions are structured. Notice the frontmatter variables, menu handling, and how steps chain together.
+
+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:
+
+- **Tasks are multi-step and complex**: Break down complexity into manageable pieces
+- **Quality and completeness matter**: Sequential enforcement ensures nothing gets missed
+- **Repeatability is important**: Get consistent results every time
+- **Tasks span multiple sessions**: Continuable workflows preserve progress
+- **You need to chain processes**: Output of one workflow becomes input of another
+- **Compliance or standards matter**: Enforce required steps and documentation
+
+Don't use workflows when:
+
+- **Tasks are simple and one-off**: A single prompt works fine for quick questions
+- **Flexibility trumps structure**: Free-form conversation is better for exploration
+
+Modified BMad Workflows
+
+- **Tasks are truly one-step**
+
+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.
+
+They're not just for software development. You can create workflows for any guided process - meal planning, course design, therapy intake, tax preparation, document processing, creative writing, event planning—any complex task that benefits from structure and thoroughness.
+
+Start simple. Study examples. Build workflows for your own domain. You'll wonder how you ever got by with just prompts.