BMAD-METHOD/docs/index.md

# BMad Documentation Index

Complete map of all BMad Method v6 documentation with recommended reading paths.

---

## 🎯 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](./BMad-Method-V6-Quick-Start.md) | [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) |
| **Upgrading from v4**  | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)      | [Quick Start Guide](./BMad-Method-V6-Quick-Start.md)          |
| **Brownfield project** | [Brownfield Guide](./bmad-brownfield-guide.md)       | [Quick Start Guide](./BMad-Method-V6-Quick-Start.md)          |

---

## 📋 Core Documentation

### Project-Level Docs (Root)

- **[README.md](../README.md)** - Main project overview, feature summary, and module introductions
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history and breaking changes
- **[CLAUDE.md](../CLAUDE.md)** - Claude Code specific guidelines for this project

### Installation & Setup

- **[BMad Method V6 Quick Start](./BMad-Method-V6-Quick-Start.md)** - Step-by-step guide to building your first project with BMM
- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
- **[Brownfield Guide](./bmad-brownfield-guide.md)** - Guidance for working with existing codebases

---

## 🏗️ Module Documentation

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

The flagship module for agile AI-driven development.

- **[BMM Module README](../src/modules/bmm/README.md)** - Module overview, agents, and structure
- **[BMM Workflows Guide](../src/modules/bmm/workflows/README.md)** - **ESSENTIAL READING** - Complete v6 workflow system explanation
  - Phase 1: Analysis (optional)
  - Phase 2: Planning (required, scale-adaptive)
  - Phase 3: Solutioning (complex projects)
  - Phase 4: Implementation (iterative)
- **[Test Architect Guide](../src/modules/bmm/testarch/README.md)** - Testing strategy and quality assurance

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

Build your own agents, workflows, and modules.

- **[BMB Module README](../src/modules/bmb/README.md)** - Module overview and capabilities
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents

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

AI-powered creative thinking and brainstorming.

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

---

## 🖥️ IDE-Specific Guides

Instructions for loading agents and running workflows in your development environment.

**Popular IDEs:**

- [Claude Code](./ide-info/claude-code.md)
- [Cursor](./ide-info/cursor.md)
- [VS Code](./ide-info/windsurf.md)

**Other Supported IDEs:**

- [Augment](./ide-info/auggie.md)
- [Cline](./ide-info/cline.md)
- [Codex](./ide-info/codex.md)
- [Crush](./ide-info/crush.md)
- [Gemini](./ide-info/gemini.md)
- [GitHub Copilot](./ide-info/github-copilot.md)
- [IFlow](./ide-info/iflow.md)
- [Kilo](./ide-info/kilo.md)
- [OpenCode](./ide-info/opencode.md)
- [Qwen](./ide-info/qwen.md)
- [Roo](./ide-info/roo.md)
- [Trae](./ide-info/trae.md)

**Key concept:** Every reference to "load an agent" or "activate an agent" in the main docs links to the [ide-info](./ide-info/) directory for IDE-specific instructions.

---

## 🔧 Advanced Topics

### Installation & Bundling

- [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
- [Installers & Platforms Reference](./installers-bundlers/installers-modules-platforms-reference.md) - CLI tool and platform support
- [Web Bundler Usage](./installers-bundlers/web-bundler-usage.md) - Creating web-compatible bundles

---

## 📊 Documentation Map

```
docs/
├── index.md (this file)
├── BMad-Method-V6-Quick-Start.md
├── v4-to-v6-upgrade.md
├── bmad-brownfield-guide.md
├── ide-info/
│   ├── claude-code.md
│   ├── cursor.md
│   ├── windsurf.md
│   └── [14+ other IDEs]
└── installers-bundlers/
    ├── ide-injections.md
    ├── installers-modules-platforms-reference.md
    └── web-bundler-usage.md

src/
├── modules/
│   ├── bmm/
│   │   ├── README.md
│   │   ├── workflows/README.md (ESSENTIAL)
│   │   └── testarch/README.md
│   ├── bmb/
│   │   ├── README.md
│   │   └── workflows/create-agent/README.md
│   └── cis/
│       └── README.md
```

---

## 🎓 Recommended Reading Paths

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

1. [README.md](../README.md) - Understand the vision
2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Get hands-on
3. [BMM Module README](../src/modules/bmm/README.md) - Understand agents
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
5. [Your IDE guide](./ide-info/) - Optimize your workflow

### Path 2: Game Development Project

1. [README.md](../README.md) - Understand the vision
2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Get hands-on
3. [BMM Module README](../src/modules/bmm/README.md) - Game agents are included
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Game workflows
5. [Your IDE guide](./ide-info/) - Optimize your workflow

### Path 3: Upgrading from v4

1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Reorient yourself
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Learn new v6 workflows

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

1. [Brownfield Guide](./bmad-brownfield-guide.md) - Approach for legacy code
2. [Quick Start Guide](./BMad-Method-V6-Quick-Start.md) - Follow the process
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology

### Path 5: Building Custom Solutions

1. [BMB Module README](../src/modules/bmb/README.md) - Understand capabilities
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure

### Path 6: Contributing to BMad

1. [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines
2. Relevant module README - Understand the area you're contributing to
3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards

---

## 🔍 Quick Reference

**What is each module for?**

- **BMM** - AI-driven software and game development
- **BMB** - Create custom agents and workflows
- **CIS** - Creative thinking and brainstorming

**How do I load an agent?**
→ See [ide-info](./ide-info/) folder for your IDE

**I'm stuck, what's next?**
→ Check the [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) or run `workflow-status`

**I want to contribute**
→ Start with [CONTRIBUTING.md](../CONTRIBUTING.md)

---

## 📚 Important Concepts

### Fresh Chats

Each workflow should run in a fresh chat with the specified agent to avoid context limitations. This is emphasized throughout the docs because it's critical to successful workflows.

### Scale Levels

BMM adapts to project complexity (Levels 0-4). Documentation is scale-adaptive - you only need what's relevant to your project size.

### Update-Safe Customization

All agent customizations go in `bmad/_cfg/agents/` and survive updates. See your IDE guide and module README for details.

---

## 🆘 Getting Help

- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
  - #general-dev - Technical questions
  - #bugs-issues - Bug reports
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
- **YouTube**: [BMad Code Channel](https://www.youtube.com/@BMadCode)

---

**Version**: v6-alpha
**Last Updated**: 2025-10-30

---