Breakthrough Method for Agile Ai Driven Development
Go to file
Brian Madison cfedecbd53 docs: massive documentation overhaul + introduce Paige (Documentation Guide agent)
## 📚 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>
2025-11-02 21:18:33 -06:00
.claude/commands/bmad docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
.github feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
.husky chore: add code formatting config and pre-commit hooks (#450) 2025-08-16 19:08:39 -05:00
.vscode feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
bmad docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
bmd doc updates 2025-10-26 23:25:48 -05:00
docs docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
src docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
test feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
tools fixed installer note 2025-10-31 19:39:06 -05:00
.gitignore feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
.npmrc feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
.nvmrc feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
.prettierignore feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
CHANGELOG.md some v5 references lingered - change to v6 2025-10-28 20:32:08 -05:00
CONTRIBUTING.md feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
LICENSE feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
README.md docs: massive documentation overhaul + introduce Paige (Documentation Guide agent) 2025-11-02 21:18:33 -06:00
eslint.config.mjs feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
package-lock.json 6.0.0-alpha.3 2025-10-30 11:37:03 -05:00
package.json 6.0.0-alpha.3 2025-10-30 11:37:03 -05:00
prettier.config.mjs feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
v6-open-items.md brownfield guide draft 2025-10-27 21:18:55 -05:00

README.md

BMad CORE + BMad Method

Version License: MIT Node.js Version Discord

🚨 Alpha Version Notice

v6-alpha is near-beta quality—stable and vastly improved over v4, but documentation is still being refined. New videos coming soon to the BMadCode YouTube channel—subscribe for updates!

Getting Started:

  • Install v6 Alpha: npx bmad-method@alpha install
  • Install stable v4: npx bmad-method install
  • Not sure what to do? Load any agent and run *workflow-init for guided setup
  • v4 Users: View v4 documentation or upgrade guide

Universal Human-AI Collaboration Platform

BMad-CORE (Collaboration Optimized Reflection Engine) amplifies human potential through specialized AI agents. Unlike tools that replace thinking, BMad-CORE guides reflective workflows that bring out your best ideas and AI's full capabilities.

The BMad-CORE powers the BMad Method (probably why you're here!), but you can also use BMad Builder to create custom agents, workflows, and modules for any domain—software development, business strategy, creativity, learning, and more.

🎯 Human Amplification🎨 Domain Agnostic Agent-Powered

Table of Contents


What is BMad-CORE?

Foundation framework powering all BMad modules:

  • Agent Orchestration - Specialized AI personas with domain expertise
  • Workflow Engine - Guided multi-step processes with built-in best practices
  • Modular Architecture - Extend with domain-specific modules (BMM, BMB, CIS, custom)
  • IDE Integration - Works with Claude Code, Cursor, Windsurf, VS Code, and more
  • Update-Safe Customization - Your configs persist through all updates

v6 Core Enhancements

  • 🎨 Agent Customization - Modify names, roles, personalities via bmad/_cfg/agents/
  • 🌐 Multi-Language - Independent language settings for communication and output
  • 👤 Personalization - Agents adapt to your name, skill level, and preferences
  • 🔄 Persistent Config - Customizations survive module updates
  • ⚙️ Flexible Settings - Configure per-module or globally

C.O.R.E. Philosophy

  • Collaboration: Human-AI partnership leveraging complementary strengths
  • Optimized: Battle-tested processes for maximum effectiveness
  • Reflection: Strategic questioning that unlocks breakthrough solutions
  • Engine: Framework orchestrating 19+ specialized agents and 50+ workflows

BMad-CORE doesn't give you answers—it helps you discover better solutions through guided reflection.

Modules

BMad Method (BMM) - AI-Driven Agile Development

Revolutionary AI-driven agile framework for software and game development. Automatically adapts from single bug fixes to enterprise-scale systems.

v6 Highlights

🎯 Scale-Adaptive Intelligence (Levels 0-4)

Automatically adjusts planning depth and documentation based on project complexity:

  • Level 0: Bug fixes (hours)
  • Level 1: Small features (1-10 stories)
  • Level 2: Medium projects (5-15 stories)
  • Level 3: Complex integration (12-40 stories)
  • Level 4: Enterprise scale (40+ stories)

🏗️ Four-Phase Methodology

  1. Phase 1: Analysis (Optional) - Brainstorming, research, product briefs
  2. Phase 2: Planning (Required) - Scale-adaptive PRD/tech-spec/GDD
  3. Phase 3: Solutioning (Level 3-4) - Architecture and design decisions
  4. Phase 4: Implementation (Iterative) - Story-centric development with just-in-time context

🤖 12 Specialized Agents

PM • Analyst • Architect • Scrum Master • Developer • Test Architect (TEA) • UX Designer • Paige (Documentation) • Game Designer • Game Developer • Game Architect • BMad Master (Orchestrator)

📚 Documentation


🚀 Quick Start

First Time?

npx bmad-method@alpha install
# Load Analyst agent → *workflow-init

Three Paths to Choose From:

  1. Quick Spec Flow - Bug fixes and small features (Level 0-1)

  2. 📋 Full BMM Flow - Medium to enterprise projects (Level 2-4)

  3. 🏢 Brownfield Projects - Add to existing codebases

Not sure which path? Run *workflow-init and let BMM analyze your project goal and recommend the right approach.

📚 Learn More: Scale Adaptive System - How BMM adapts from Level 0 to Level 4


BMad Builder (BMB) - Create Custom Solutions

Build your own agents, workflows, and modules using the BMad-CORE framework.

What You Can Build:

  • Custom Agents - Domain experts with specialized knowledge
  • Guided Workflows - Multi-step processes for any task
  • Complete Modules - Full solutions for specific domains
  • Three Agent Types - Full module, hybrid, or standalone

Perfect For: Creating domain-specific solutions (legal, medical, finance, education, creative, etc.) or extending BMM with custom development workflows.

Documentation:

Creative Intelligence Suite (CIS) - Innovation & Creativity

AI-powered creative facilitation using proven methodologies and techniques.

5 Interactive Workflows:

  • Brainstorming - Generate and refine ideas with 30+ techniques
  • Design Thinking - Human-centered problem solving
  • Problem Solving - Systematic breakthrough techniques
  • Innovation Strategy - Disruptive business model thinking
  • Storytelling - Compelling narrative frameworks

5 Specialized Agents: Each with unique facilitation styles and domain expertise

Shared Resource: CIS workflows are used by other modules (BMM's brainstorm-project uses CIS brainstorming)

Documentation:


Installation

Prerequisites: Node.js v20+ (Download)

# v6 Alpha (recommended for new projects)
npx bmad-method@alpha install

# Stable v4 (production)
npx bmad-method install

Interactive Setup: The installer walks you through:

  1. Project Location - Where to install (defaults to current directory)
  2. Module Selection - Choose BMM, BMB, CIS (or all)
  3. Configuration - Your name, language, game dev options
  4. IDE Integration - Automatic environment setup

Result: Clean, unified bmad/ folder structure:

your-project/
└── bmad/
    ├── core/         # Core framework + BMad Master agent
    ├── bmm/          # BMad Method (12 agents, 34 workflows)
    ├── bmb/          # BMad Builder (1 agent, 7 workflows)
    ├── cis/          # Creative Intelligence (5 agents, 5 workflows)
    └── _cfg/         # Your customizations (survives updates)
        └── agents/   # Agent customization files

First Steps After Install:

Load any agent in your IDE and run *workflow-init to set up your project workflow path.


Key Features

🎨 Update-Safe Customization

Modify agents without touching core files:

  • Override agent names, personalities, expertise via bmad/_cfg/agents/
  • Customizations persist through all updates
  • Multi-language support (communication + output)
  • Module-level or global configuration

🚀 Intelligent Installation

Smart setup that adapts to your environment:

  • Auto-detects v4 installations for smooth upgrades
  • Configures IDE integrations (Claude Code, Cursor, Windsurf, VS Code)
  • Resolves cross-module dependencies
  • Generates unified agent/workflow manifests

📁 Clean Architecture

Everything in one place:

  • Single bmad/ folder (no scattered files)
  • Modules live side-by-side (core, bmm, bmb, cis)
  • Your configs in _cfg/ (survives updates)
  • Easy to version control or exclude

📄 Document Sharding (Advanced)

Optional optimization for large projects (Level 3-4):

  • Massive Token Savings - Phase 4 workflows load only needed sections (90%+ reduction)
  • Automatic Support - All workflows handle whole or sharded documents seamlessly
  • Easy Setup - Built-in tool splits documents by headings
  • Smart Discovery - Workflows auto-detect format

→ Document Sharding Guide


Documentation

Module Documentation:

Additional Resources:


Community & Support


Contributing

We welcome contributions! See CONTRIBUTING.md for:

  • Code contribution guidelines
  • Documentation improvements
  • Module development
  • Issue reporting

License

MIT License - See LICENSE for details

Trademarks: BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.


Contributors

Built with ❤️ for the human-AI collaboration community