BMAD-METHOD/src/modules/bmm/docs
Brian Madison 6f7e9f0653 refactor: Major v6 epic creation improvements and documentation overhaul
## Key Changes

### 1. Epic Creation Workflow Enhancements
- Added user-value focused epic structure principles (NO technical layer breakdown)
- Implemented multi-mode detection: CONTINUE, REPLACE, or UPDATE existing epics
- Added comprehensive anti-pattern examples showing wrong vs right epic breakdown
- Epics now created AFTER architecture for technically-informed story breakdown
- Added checkpoint protocol for interactive workflow progression

### 2. Removed Deprecated Solutioning Gate Check
- Deleted entire solutioning-gate-check workflow (682 lines)
- Replaced by new implementation-readiness workflow
- Cleaner separation of concerns in solutioning phase

### 3. PRD Template Simplification
- Removed hardcoded "Implementation Planning", "References", and "Next Steps" sections
- PRD now focuses purely on requirements, not workflow orchestration
- Epics/stories created as separate step after architecture

### 4. Documentation Overhaul (15+ docs updated)
- Updated quick-start guide with v6 workflow sequence
- Clarified that epics are created AFTER architecture, not during PRD
- Updated solutioning docs to reflect implementation-readiness pattern
- Improved agents-guide, brownfield-guide, enterprise docs
- Enhanced glossary, FAQ, and workflow reference documentation

### 5. Workflow Path Adjustments
- All 4 paths updated (enterprise/method × brownfield/greenfield)
- Version bumps across BMGD, BMM, and CIS workflow YAMLs
- Minor instruction file updates for consistency

### Files Changed
- 65 files total: 468 insertions, 978 deletions (net reduction of 510 lines)
- 4 files deleted (entire solutioning-gate-check workflow)
- 1 new directory added (implementation-readiness placeholder)
2025-11-16 00:23:47 -06:00
..
README.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
agents-guide.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
brownfield-guide.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
enterprise-agentic-development.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
faq.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
glossary.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
party-mode.md The install directory is now configurable, with a few minute issues 2025-11-08 13:58:43 -06:00
quick-spec-flow.md More document Updtes and diagram improvements 2025-11-05 07:52:08 -06:00
quick-start.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
scale-adaptive-system.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
test-architecture.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
workflow-architecture-reference.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
workflow-document-project-reference.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
workflows-analysis.md More document Updtes and diagram improvements 2025-11-05 07:52:08 -06:00
workflows-implementation.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
workflows-planning.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00
workflows-solutioning.md refactor: Major v6 epic creation improvements and documentation overhaul 2025-11-16 00:23:47 -06:00

README.md

BMM Documentation

Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.


🚀 Getting Started

New to BMM? Start here:

  • Quick Start Guide - Step-by-step guide to building your first project (15 min read)
    • Installation and setup
    • Understanding the four phases
    • Running your first workflows
    • Agent-based development flow

Quick Path: Install → workflow-init → Follow agent guidance


📖 Core Concepts

Understanding how BMM adapts to your needs:

  • Scale Adaptive System - How BMM adapts to project size and complexity (42 min read)

    • Three planning tracks (Quick Flow, BMad Method, Enterprise Method)
    • Automatic track recommendation
    • Documentation requirements per track
    • Planning workflow routing
  • Quick Spec Flow - Fast-track workflow for Quick Flow track (26 min read)

    • Bug fixes and small features
    • Rapid prototyping approach
    • Auto-detection of stack and patterns
    • Minutes to implementation

🤖 Agents and Collaboration

Complete guide to BMM's AI agent team:

  • Agents Guide - Comprehensive agent reference (45 min read)

    • 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 - Multi-agent collaboration (20 min read)

    • How party mode works (19+ agents collaborate in real-time)
    • When to use it (strategic, creative, cross-functional, complex)
    • Example party compositions
    • Multi-module integration (BMM + CIS + BMB + custom)
    • Agent customization in party mode
    • Best practices

🔧 Working with Existing Code

Comprehensive guide for brownfield development:

  • Brownfield Development Guide - Complete guide for existing codebases (53 min read)
    • Documentation phase strategies
    • Track selection for brownfield
    • Integration with existing patterns
    • Phase-by-phase workflow guidance
    • Common scenarios

📚 Quick References

Essential reference materials:


🎯 Choose Your Path

I need to...

Build something new (greenfield) → Start with Quick Start Guide → Then review Scale Adaptive System to understand tracks

Fix a bug or add small feature → Go directly to Quick Spec Flow

Work with existing codebase (brownfield) → Read Brownfield Development Guide → Pay special attention to Phase 0 documentation requirements

Understand planning tracks and methodology → See Scale Adaptive System

Find specific commands or answers → Check FAQ


📋 Workflow Guides

Comprehensive documentation for all BMM workflows organized by phase:

  • Phase 1: Analysis Workflows - 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 - 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 - 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 - 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 - Comprehensive quality assurance (1,420 lines)

    • Test strategy, automation, quality gates
    • TEA agent and test healing
    • BMad-integrated vs standalone modes

Total: 34 workflows documented across all phases

Advanced Workflow References

For detailed technical documentation on specific complex workflows:

  • Document Project Workflow Reference - Technical deep-dive (445 lines)

    • v1.2.0 context-safe architecture
    • Scan levels, resumability, write-as-you-go
    • Multi-part project detection
    • Deep-dive mode for targeted analysis
  • Architecture Workflow Reference - Decision architecture guide (320 lines)

    • Starter template intelligence
    • Novel pattern design
    • Implementation patterns for agent consistency
    • Adaptive facilitation approach

🧪 Testing and Quality

Quality assurance guidance:

  • Test design workflows
  • Quality gates
  • Risk assessment
  • NFR validation

🏗️ Module Structure

Understanding BMM components:

  • BMM Module README - Overview of module structure
    • Agent roster and roles
    • Workflow organization
    • Teams and collaboration
    • Best practices

🌐 External Resources

Community and Support

Additional Documentation

  • IDE Setup Guides - Configure your development environment
    • Claude Code
    • Cursor
    • Windsurf
    • VS Code
    • Other IDEs

📊 Documentation Map

flowchart TD
    START[New to BMM?]
    START --> QS[Quick Start Guide]

    QS --> DECIDE{What are you building?}

    DECIDE -->|Bug fix or<br/>small feature| QSF[Quick Spec Flow]
    DECIDE -->|New project| SAS[Scale Adaptive System]
    DECIDE -->|Existing codebase| BF[Brownfield Guide]

    QSF --> IMPL[Implementation]
    SAS --> IMPL
    BF --> IMPL

    IMPL --> REF[Quick References<br/>Glossary, FAQ]

    style START fill:#bfb,stroke:#333,stroke-width:2px,color:#000
    style QS fill:#bbf,stroke:#333,stroke-width:2px,color:#000
    style DECIDE fill:#ffb,stroke:#333,stroke-width:2px,color:#000
    style IMPL fill:#f9f,stroke:#333,stroke-width:2px,color:#000

💡 Tips for Using This Documentation

  1. Start with Quick Start if you're new - it provides the essential foundation
  2. Use the FAQ to find quick answers without reading entire guides
  3. Bookmark Glossary for terminology references while reading other docs
  4. Follow the suggested paths above based on your specific situation
  5. Join Discord for interactive help and community insights

Ready to begin?Start with the Quick Start Guide