BMAD-METHOD/docs/index.md

BMad Documentation Index

Core Documentation

Project-Level Docs (Root)

• README.md - Main project overview, feature summary, and module introductions
• CONTRIBUTING.md - How to contribute, pull request guidelines, code style
• CHANGELOG.md - Version history and breaking changes

Installation & Setup

• Quick Installation - Add BMad official and custom modules to a project folder.
• v4 to v6 Upgrade Guide - Migration path for v4 users
• Document Sharding Guide - Split large documents
• Bundle Distribution Setup - (temporarily non-functional) Maintainer guide for bundle auto-publishing

Module Documentation

Core Module Global Entities

• Core Module Index — Shared functionality available to all modules
  • Global Core Config — Inheritable configuration impacting all modules and custom content
  • Core Workflows — Domain-agnostic workflows usable by any module
    • Party Mode — Multi-agent conversation orchestration
    • Brainstorming — Structured creative sessions with 60+ techniques
    • Advanced Elicitation — LLM rethinking with 50+ reasoning methods
  • Core Tasks — Common tasks available across modules
    • Index Docs — Generate directory index files
    • Adversarial Review — Critical content review
    • Shard Document — Split large documents into sections

BMad Method (BMM) - Software & Game Development

The flagship module for agile AI-driven development.

• BMM Module Index - Module overview, agents, and complete documentation index
  • Quick Start Guide - Step-by-step guide to building your first project
  • Quick Spec Flow - Rapid Level 0-1 development
  • Brownfield Guide - Working with existing codebases
• BMM Workflows Guide - ESSENTIAL READING
• Test Architect Guide - Testing strategy and quality assurance

BMad Builder (BMB) - Create Custom Solutions

Build your own agents, workflows, and modules.

• BMB Module Overview - Module overview and capabilities
• Custom Content Guide - Design custom agents, workflows, and modules
• How to Install Custom Agents, Workflows and Modules - Share and Install Custom Creations

Creative Intelligence Suite (CIS) - Innovation & Creativity

• CIS Docs

Bmad Game Dev (BMGD)

• Main Game Dev Module Docs Index

AI-powered creative thinking and brainstorming.

• CIS Module README - Module overview and workflows

Advanced Topics

Custom Agents, Workflow and Modules

• Custom Content Installation - Install and personalize agents, workflows and modules with the default bmad-method installer!
• Agent Customization Guide - Customize agent behavior and responses
• Workflow Customization Guide - Customize and Optimize workflows with step replacement and hooks (Capability Coming Soon)

Recommended Reading Paths

Path 1: Brand New to BMad (Software Project)

1. README.md - Understand the vision
2. Quick Start Guide - Get hands-on
3. BMM Module README - Understand agents
4. BMM Workflows Guide - Master the methodology

Path 2: Game Development Project

1. README.md - Understand the vision
2. Quick Start Guide - Get hands-on
3. BMM Module README - Game agents are included
4. BMGD Workflows Guide - Game-specific workflows

Path 3: Upgrading from v4

1. v4 to v6 Upgrade Guide - Understand what changed
2. Quick Start Guide - Reorient yourself
3. BMM Workflows Guide - Learn new v6 workflows

Path 4: Working with Existing Codebase (Brownfield)

1. Brownfield Guide - Approach for legacy code
2. Quick Start Guide - Follow the process
3. BMM Workflows Guide - Master the methodology

Path 5: Building Custom Solutions

1. BMB Module Overview - Understand capabilities
2. Agent Creation Guide - Create agents
3. BMB Workflows Guide - Understand workflow structure

Path 6: Contributing to BMad

1. CONTRIBUTING.md - Contribution guidelines
2. Relevant module README - Understand the area you're contributing to