# BMad Documentation Index

## 🎯 Getting Started (Start Here!)

**New users:** Start with one of these based on your situation:

| Your Situation         | Start Here                                         | Then Read                                                   |
| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
| **Brand new to BMad**  | [Quick Start Guide](bmm/quick-start)               | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) |
| **Upgrading from v4**  | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)    | [Quick Start Guide](./modules/bmm/quick-start)              |
| **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start)              |

---

## 📋 Core Documentation

### Project-Level Docs (Root)

- **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions
- **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
- **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes

### Installation & Setup

- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents for 90%+ token savings
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - (temporarily non-functional) Maintainer guide for bundle auto-publishing

---

## 🏗️ Module Documentation

### BMad Method (BMM) - Software & Game Development

The flagship module for agile AI-driven development.

- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
  - [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
  - [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
  - [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
  - [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance

### BMad Builder (BMB) - Create Custom Solutions

Build your own agents, workflows, and modules.

- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents

### Creative Intelligence Suite (CIS) - Innovation & Creativity

AI-powered creative thinking and brainstorming.

- **[CIS Module README](./modules/cis/)** - Module overview and workflows

## 🔧 Advanced Topics

### Custom Agents, Workflow and Modules

- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses

---

## 🎓 Recommended Reading Paths

### Path 1: Brand New to BMad (Software Project)

1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
3. [BMM Module README](./modules/bmm/) - Understand agents
4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology

### Path 2: Game Development Project

1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
3. [BMM Module README](./modules/bmm/) - Game agents are included
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows

### Path 3: Upgrading from v4

1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows

### Path 4: Working with Existing Codebase (Brownfield)

1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology

### Path 5: Building Custom Solutions

1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure

### Path 6: Contributing to BMad

1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
2. Relevant module README - Understand the area you're contributing to
