External/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmadcode/BMAD-METHOD.git synced 2025-12-17 17:55:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
BMAD-METHOD/docs/index.md
Brian Madison 1868477238 refactor(config): replace hardcoded .bmad paths with {bmad_folder} placeholder 
Remove hardcoded .bmad folder references throughout documentation and source files, replacing them with the configurable {bmad_folder} placeholder. This change enables users to customize the BMAD installation folder name via configuration, improving flexibility and reducing coupling to a specific directory structure.

Changes include:
- Update all documentation to reference {bmad_folder} instead of .bmad
- Remove legacy configuration files from .bmad and .claude directories
- Update workflow.xml and CLI documentation with new placeholder syntax
2025-11-12 20:22:47 -06:00

9.1 KiB
Raw Permalink Blame History

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 BMM Workflows Guide
Upgrading from v4 v4 to v6 Upgrade Guide Quick Start Guide
Brownfield project Brownfield Guide Quick Start Guide

📋 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
  • CLAUDE.md - Claude Code specific guidelines for this project

Installation & Setup

🏗️ Module Documentation

BMad Method (BMM) - Software & Game Development

The flagship module for agile AI-driven development.

BMad Builder (BMB) - Create Custom Solutions

Build your own agents, workflows, and modules.

Creative Intelligence Suite (CIS) - Innovation & Creativity

AI-powered creative thinking and brainstorming.

🖥️ IDE-Specific Guides

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

Popular IDEs:

Other Supported IDEs:

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

🔧 Advanced Topics

Installation & Bundling

📊 Documentation Map

docs/                              # Core/cross-module documentation
├── index.md (this file)
├── v4-to-v6-upgrade.md
├── document-sharding-guide.md
├── ide-info/                      # IDE setup guides
│   ├── claude-code.md
│   ├── cursor.md
│   ├── windsurf.md
│   └── [14+ other IDEs]
└── installers-bundlers/           # Installation reference
    ├── ide-injections.md
    ├── installers-modules-platforms-reference.md
    └── web-bundler-usage.md

src/modules/
├── bmm/                           # BMad Method module
│   ├── README.md                  # Module overview & docs index
│   ├── docs/                      # BMM-specific documentation
│   │   ├── quick-start.md
│   │   ├── quick-spec-flow.md
│   │   ├── scale-adaptive-system.md
│   │   └── brownfield-guide.md
│   ├── workflows/README.md        # ESSENTIAL workflow guide
│   └── testarch/README.md         # Testing strategy
├── bmb/                           # BMad Builder module
│   ├── README.md
│   └── workflows/create-agent/README.md
└── cis/                           # Creative Intelligence Suite
    └── README.md

🎓 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
  5. Your IDE guide - Optimize your workflow

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. BMM Workflows Guide - Game workflows
  5. Your IDE guide - Optimize your workflow

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 README - Understand capabilities
  2. Agent Creation Guide - Create agents
  3. BMM 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
  3. Code Style section in CONTRIBUTING.md - 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 folder for your IDE

I'm stuck, what's next? → Check the BMM Workflows Guide or run workflow-status

I want to contribute → Start with 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_folder}/_cfg/agents/ and survive updates. See your IDE guide and module README for details.

🆘 Getting Help