# 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](../src/modules/bmm/docs/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](../src/modules/bmm/docs/quick-start.md) | | **Brownfield project** | [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) | --- ## 🌐 Documentation en FranΓ§ais Complete French language documentation for BMAD-METHOD: - **[README FranΓ§ais](../README.fr.md)** - Vue d'ensemble complΓ¨te en franΓ§ais - **[Guide d'Installation](./fr/installation.md)** - Installation et configuration multi-langue - **[IntΓ©gration IDE](./fr/integration-ide.md)** - Configuration pour Claude Code, Cursor, Windsurf, etc. - **[Bundles Web](./fr/bundles-web.md)** - Utiliser avec Gemini Gems et Custom GPTs - **[Guide de DΓ©marrage Rapide](./fr/demarrage-rapide.md)** - Introduction de 15 minutes --- ## πŸ“‹ 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 - **[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 - **[Web Bundles](./USING_WEB_BUNDLES.md)** - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation - **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - 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](../src/modules/bmm/README.md)** - Module overview, agents, and complete documentation index - **[BMM Documentation](../src/modules/bmm/docs/)** - All BMM-specific guides and references: - [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Step-by-step guide to building your first project - [Quick Spec Flow](../src/modules/bmm/docs/quick-spec-flow.md) - Rapid Level 0-1 development - [Scale Adaptive System](../src/modules/bmm/docs/scale-adaptive-system.md) - Understanding the 5-level system - [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Working with existing codebases - **[BMM Workflows Guide](../src/modules/bmm/workflows/README.md)** - **ESSENTIAL READING** - **[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 ### Content Creator - Advanced Content Creation with Voice Profiling Multi-platform content creation with authentic voice matching and style customization. - **[Content Creator Module README](../src/modules/content-creator/README.md)** - Module overview, agents, and workflows - **Voice & Style System:** - Build Voice Profile - Create comprehensive voice profiles from writing samples - Train Voice - Continuously refine and evolve your voice profile - Create Style Guide - Generate complete custom style guides - Style Analyzer - Deep analysis of writing patterns and characteristics - **Content Workflows:** - Article Pipeline - Complete article creation with multi-platform repurposing - Research Topic - Deep research with trend analysis - Extract Themes - Pattern recognition from raw notes - Quick Post - Fast social media content creation - Optimize Content - SEO and engagement improvements --- ## πŸ–₯️ 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/ # 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 └── content-creator/ # Content Creator module β”œβ”€β”€ README.md # Module overview & documentation β”œβ”€β”€ data/ β”‚ β”œβ”€β”€ voice-profiles/ # Voice profile storage β”‚ └── style-guides/ # Style guide storage └── workflows/ β”œβ”€β”€ build-voice-profile/ # Voice profiling system β”œβ”€β”€ train-voice/ # Voice training └── create-style-guide/ # Style guide generation ``` --- ## πŸŽ“ Recommended Reading Paths ### Path 1: Brand New to BMad (Software Project) 1. [README.md](../README.md) - Understand the vision 2. [Quick Start Guide](../src/modules/bmm/docs/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](../src/modules/bmm/docs/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](../src/modules/bmm/docs/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](../src/modules/bmm/docs/brownfield-guide.md) - Approach for legacy code 2. [Quick Start Guide](../src/modules/bmm/docs/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: Content Creation with Voice Profiling 1. [Content Creator Module README](../src/modules/content-creator/README.md) - Understand capabilities 2. Build your voice profile with `*build-voice-profile` 3. Create content with `*write` using your authentic voice 4. Train and refine your voice over time with `*train-voice` ### Path 7: Marketing Operations 1. [Marketing Ops Module README](../src/modules/marketing-ops/README.md) - Understand capabilities 2. Develop brand strategy with `*brand-strategy` (Sofia - Brand Marketer) 3. Plan campaigns with `*campaign-plan` (Marcus - Media Buyer) 4. Analyze performance with `*analytics-report` (Elena - Marketing Analyst) 5. Create design briefs with `*design-brief` (Maya - Marketing Designer) ### Path 8: 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 - **Content Creator** - Multi-platform content creation with voice profiling - **Marketing Ops** - Complete marketing operations suite (strategy, campaigns, analytics, creative) **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_folder}/_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)