## 📚 Complete Documentation Restructure **BMM Documentation Hub Created:** - New centralized documentation system at `src/modules/bmm/docs/` - 18 comprehensive guides organized by topic (7000+ lines total) - Clear learning paths for greenfield, brownfield, and quick spec flows - Professional technical writing standards throughout **New Documentation:** - `README.md` - Complete documentation hub with navigation - `quick-start.md` - 15-minute getting started guide - `agents-guide.md` - Comprehensive 12-agent reference (45 min read) - `party-mode.md` - Multi-agent collaboration guide (20 min read) - `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read) - `brownfield-guide.md` - Existing codebase development (53 min read) - `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read) - `workflows-analysis.md` - Phase 1 workflows (12 min read) - `workflows-planning.md` - Phase 2 workflows (19 min read) - `workflows-solutioning.md` - Phase 3 workflows (13 min read) - `workflows-implementation.md` - Phase 4 workflows (33 min read) - `workflows-testing.md` - Testing & QA workflows (29 min read) - `workflow-architecture-reference.md` - Architecture workflow deep-dive - `workflow-document-project-reference.md` - Document-project workflow reference - `enterprise-agentic-development.md` - Team collaboration patterns - `faq.md` - Comprehensive Q&A covering all topics - `glossary.md` - Complete terminology reference - `troubleshooting.md` - Common issues and solutions **Documentation Improvements:** - Removed all version/date footers (git handles versioning) - Agent customization docs now include full rebuild process - Cross-referenced links between all guides - Reading time estimates for all major docs - Consistent professional formatting and structure **Consolidated & Streamlined:** - Module README (`src/modules/bmm/README.md`) streamlined to lean signpost - Root README polished with better hierarchy and clear CTAs - Moved docs from root `docs/` to module-specific locations - Better separation of user docs vs. developer reference ## 🤖 New Agent: Paige (Documentation Guide) **Role:** Technical documentation specialist and information architect **Expertise:** - Professional technical writing standards - Documentation structure and organization - Information architecture and navigation - User-focused content design - Style guide enforcement **Status:** Work in progress - Paige will evolve as documentation needs grow **Integration:** - Listed in agents-guide.md, glossary.md, FAQ - Available for all phases (documentation is continuous) - Can be customized like all BMM agents ## 🔧 Additional Changes - Updated agent manifest with Paige - Updated workflow manifest with new documentation workflows - Fixed workflow-to-agent mappings across all guides - Improved root README with clearer Quick Start section - Better module structure explanations - Enhanced community links with Discord channel names **Total Impact:** - 18 new/restructured documentation files - 7000+ lines of professional technical documentation - Complete navigation system with cross-references - Clear learning paths for all user types - Foundation for knowledge base (coming in beta) Co-Authored-By: Claude <noreply@anthropic.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| agents-guide.md | ||
| brownfield-guide.md | ||
| brownfield-guide.md.backup | ||
| enterprise-agentic-development.md | ||
| faq.md | ||
| glossary.md | ||
| party-mode.md | ||
| quick-spec-flow.md | ||
| quick-start.md | ||
| scale-adaptive-system.md | ||
| troubleshooting.md | ||
| workflow-architecture-reference.md | ||
| workflow-document-project-reference.md | ||
| workflows-analysis.md | ||
| workflows-implementation.md | ||
| workflows-planning.md | ||
| workflows-solutioning.md | ||
| workflows-testing.md | ||
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)
- The five complexity levels (0-4)
- Automatic level detection
- Documentation requirements per level
- Planning workflow routing
-
Quick Spec Flow - Fast-track workflow for Level 0-1 projects (26 min read)
- Bug fixes and small features
- Rapid prototyping approach
- Auto-detection of stack and patterns
- Minutes to implementation
🤖 Agents & 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 and troubleshooting
🔧 Working with Existing Code
Comprehensive guide for brownfield development:
- Brownfield Development Guide - Complete guide for existing codebases (53 min read)
- Documentation phase strategies
- Level detection for brownfield
- Integration with existing patterns
- Phase-by-phase workflow guidance
- Common scenarios and troubleshooting
📚 Quick References
Essential reference materials:
- Glossary - Key terminology and concepts
- FAQ - Frequently asked questions across all topics
- Troubleshooting - Common issues and solutions
- Enterprise Agentic Development - Team collaboration strategies
🎯 Choose Your Path
I need to...
Build something new (greenfield) → Start with Quick Start Guide → Then review Scale Adaptive System to understand levels
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 project complexity levels → See Scale Adaptive System
Find specific commands or answers → Check FAQ or Troubleshooting
📋 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
- Level 0-4 planning approach
- Which planning workflow to use
-
Phase 3: Solutioning Workflows - Architecture and validation (638 lines)
- architecture, solutioning-gate-check
- Required for Level 3-4 projects
- 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 & Quality
Quality assurance guidance:
- Test Architect Guide - Comprehensive testing strategy
- 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 & Support
- Discord Community - Get help from the community (#general-dev, #bugs-issues)
- GitHub Issues - Report bugs or request features
- YouTube Channel - Video tutorials and walkthroughs
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, Troubleshooting]
style START fill:#bfb,stroke:#333,stroke-width:2px
style QS fill:#bbf,stroke:#333,stroke-width:2px
style DECIDE fill:#ffb,stroke:#333,stroke-width:2px
style IMPL fill:#f9f,stroke:#333,stroke-width:2px
💡 Tips for Using This Documentation
- Start with Quick Start if you're new - it provides the essential foundation
- Use the FAQ to find quick answers without reading entire guides
- Bookmark Glossary for terminology references while reading other docs
- Follow the suggested paths above based on your specific situation
- Join Discord for interactive help and community insights
Ready to begin? → Start with the Quick Start Guide