Files
BMAD-METHOD/docs/explanation/bmm/index.md
Alex Verkhovsky 2e16650067 feat(docs): Diataxis restructure + Astro/Starlight migration (#1263)
* feat(docs): add Diataxis folder structure and update sidebar styling

- Create tutorials, how-to, explanation, reference directories with subdirectories
- Add index.md files for each main Diataxis section
- Update homepage with Diataxis card navigation layout
- Implement clean React Native-inspired sidebar styling
- Convert sidebar to autogenerated for both Diataxis and legacy sections
- Update docusaurus config with dark mode default and navbar changes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): migrate Phase 1 files to Diataxis structure

Move 21 files to new locations:
- Tutorials: quick-start guides, agent creation guide
- How-To: installation, customization, workflows
- Explanation: core concepts, features, game-dev, builder
- Reference: merged glossary from BMM and BMGD

Also:
- Copy images to new locations
- Update internal links via migration script (73 links updated)
- Build verified successfully

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(docs): add category labels for sidebar folders

Add _category_.json files to control display labels and position
for autogenerated sidebar categories.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style(docs): improve welcome page and visual styling

- Rewrite index.md with React Native-inspired welcoming layout
- Add Diataxis section cards with descriptions
- Remove sidebar separator, add spacing instead
- Increase navbar padding with responsive breakpoints
- Add rounded admonitions without left border bar
- Use system font stack for better readability
- Add lighter chevron styling in sidebar
- Constrain max-width to 1600px for wide viewports

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: use baseUrl in meta tag paths for correct deployment URLs

* feat(docs): complete Phase 2 - split files and fix broken links

Phase 2 of Diataxis migration:
- Split 16 large legacy files into 42+ focused documents
- Created FAQ section with 7 topic-specific files
- Created brownfield how-to guides (3 files)
- Created workflow how-to guides (15+ files)
- Created architecture explanation files (3 files)
- Created TEA/testing explanation files
- Moved remaining legacy module files to proper Diataxis locations

Link fixes:
- Fixed ~50 broken internal links across documentation
- Updated relative paths for new file locations
- Created missing index files for installation, advanced tutorials
- Simplified TOC anchors to fix Docusaurus warnings

Cleanup:
- Removed legacy sidebar entries for deleted folders
- Deleted duplicate and empty placeholder files
- Moved workflow diagram assets to tutorials/images

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(build): use file glob instead of sidebar parsing for llms-full.txt

Replace brittle sidebar.js regex parsing with recursive file glob.
The old approach captured non-file strings like 'autogenerated' and
category labels, resulting in only 5 files being processed.

Now correctly processes all 86+ markdown files (~95k tokens).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(seo): use absolute URLs in AI meta tags for agent discoverability

AI web-browsing agents couldn't follow relative paths in meta tags due to
URL security restrictions. Changed llms-full.txt and llms.txt meta tag
URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): recategorize misplaced files per Diataxis analysis

Phase 2.5 categorization fixes based on post-migration analysis:

Moved to correct Diataxis categories:
- tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md)
- tutorials/brownfield-onboarding.md → how-to/brownfield/index.md
- reference/faq/* (8 files) → explanation/faq/
- reference/agents/barry-quick-flow.md → explanation/agents/
- reference/agents/bmgd-agents.md → explanation/game-dev/agents.md

Created:
- explanation/agents/index.md

Fixed all broken internal links (14 total)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add Getting Started tutorial and simplify build script

- Add comprehensive Getting Started tutorial with installation as Step 1
- Simplify build-docs.js to read directly from docs/ (no consolidation)
- Remove backup/restore dance that could corrupt docs folder on build failure
- Remove ~150 lines of unused consolidation code

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(css): use fixed width layout to prevent content shifting

Apply React Native docs approach: set both width and max-width at
largest breakpoint (1400px) so content area maintains consistent
size regardless of content length. Switches to fluid 100% below
1416px breakpoint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): restructure tutorials with renamed entry point

- Rename index.md to bmad-tutorial.md for clearer navigation
- Remove redundant tutorials/index.md
- Update sidebar and config references

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add tutorial style guide and AI agent announcement bar

- Add docs/_contributing/ with tutorial style guide
- Reformat quick-start-bmm.md and bmad-tutorial.md per style guide
- Remove horizontal separators, add strategic admonitions
- Add persistent announcement bar for AI agents directing to llms-full.txt
- Fix footer broken link to tutorials

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add markdown demo page and UI refinements

- Add comprehensive markdown-demo.md for style testing
- Remove doc category links from navbar (use sidebar instead)
- Remove card buttons from welcome page
- Add dark mode styling for announcement bar
- Clean up index.md card layout

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): apply unified tutorial style and update references

- Reformat create-custom-agent.md to follow tutorial style guide
- Update tutorial-style.md with complete unified structure
- Update all internal references to renamed tutorial files
- Remove obsolete advanced/index.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): migrate from Docusaurus to Astro+Starlight

Replace Docusaurus with Astro and the Starlight documentation theme
for improved performance, better customization, and modern tooling.

Build pipeline changes:
- New build-docs.js orchestrates link checking, artifact generation,
  and Astro build in sequence
- Add check-doc-links.js for validating internal links and anchors
- Generate llms.txt and llms-full.txt for LLM-friendly documentation
- Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip)
- Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build
- Output directly to build/site for cleaner deployment

Website architecture:
- Add rehype-markdown-links.js plugin to transform .md links to routes
- Add site-url.js helper for GitHub Pages URL resolution with strict
  validation (throws on invalid GITHUB_REPOSITORY format)
- Custom Astro components: Banner, Header, MobileMenuFooter
- Symlink docs/ into website/src/content/docs for Starlight

Documentation cleanup:
- Remove Docusaurus _category_.json files (Starlight uses frontmatter)
- Convert all docs to use YAML frontmatter with title field
- Move downloads.md from website/src/pages to docs/
- Consolidate style guide and workflow diagram docs
- Add 404.md and tutorials/index.md

---------

Co-authored-by: forcetrainer <bryan@inagaki.us>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-07 14:42:15 +08:00

6.4 KiB

title
title
BMM Documentation

Complete guides for the BMad Method Module (BMM) - AI-powered agile development workflows that adapt to your project's complexity.


🚀 Getting Started

New to BMM? Start here:

  • Quick Start Guide - Step-by-step guide to building your first project
    • Installation and setup
    • Understanding the four phases
    • Running your first workflows
    • Agent-based development flow

Quick Path: Install → workflow-init → Follow agent guidance

📊 Visual Overview

Complete Workflow Diagram - Visual flowchart showing all phases, agents (color-coded), and decision points for the BMad Method standard greenfield track.

📖 Core Concepts

The BMad Method is meant to be adapted and customized to your specific needs. In this realm there is no one size fits all - your needs are unique, and BMad Method is meant to support this (and if it does not, can be further customized or extended with new modules).

First know there is the full BMad Method Process and then there is a Quick Flow for those quicker smaller efforts.

  • Full Adaptive BMad Method - Full planning and scope support through extensive development and testing.

    • Broken down into 4 phases, all of which are comprised of both required and optional phases
      • Phases 1-3 are all about progressive idea development through planning and preparations to build your project.
      • Phase 4 is the implementation cycle where you will Just In Time (JIT) produce the contextual stories needed for the dev agent based on the extensive planning completed
      • All 4 phases have optional steps in them, depending on how rigorous you want to go with planning, research ideation, validation, testing and traceability.
    • While there is a lot here, know that even this can be distilled down to a simple PRD, Epic and Story list and then jump into the dev cycle. But if that is all you want, you might be better off with the BMad Quick Flow described next
  • BMAD Quick Flow - Fast-track development workflow

    • 3-step process: spec → dev → optional review
    • Perfect for bug fixes and small features
    • Rapid prototyping with production quality
    • Implementation in minutes, not days
    • Has a specialized single agent that does all of this: Quick Flow Solo Dev Agent
  • TEA engagement (optional) - Choose TEA engagement: none, TEA-only (standalone), or integrated by track. See Test Architect Guide.

🤖 Agents and Collaboration

Complete guide to BMM's AI agent team:

  • Agents Guide - Comprehensive agent reference

    • 12 specialized BMM agents + BMad Master
    • Agent roles, workflows, and when to use them
    • Agent customization system
    • Best practices and common patterns
  • Party Mode Guide - Multi-agent collaboration

    • How party mode works (19+ agents collaborate in real-time)
    • When to use it (strategic, creative, cross-functional, complex)
    • Example party compositions
    • Multi-module integration (BMM + CIS + BMB + custom)
    • Agent customization in party mode
    • Best practices

🔧 Working with Existing Code

Comprehensive guide for brownfield development:

  • Brownfield Development Guide - Complete guide for existing codebases
    • Documentation phase strategies
    • Track selection for brownfield
    • Integration with existing patterns
    • Phase-by-phase workflow guidance
    • Common scenarios

📚 Quick References

Essential reference materials:

  • Glossary - Key terminology and concepts
  • FAQ - Frequently asked questions across all topics

🎯 Choose Your Path

I need to...

Build something new (greenfield) → Start with Quick Start Guide

Fix a bug or add small feature → Use the Quick Flow Solo Dev directly with its dedicated stand alone Quick Bmad Spec Flow process

Work with existing codebase (brownfield) → Read Brownfield Development Guide → Pay special attention to documentation requirements for brownfield projects

📋 Workflow Guides

Comprehensive documentation for all BMM workflows organized by phase:

  • Phase 1: Analysis Workflows - Optional exploration and research workflows (595 lines)

    • brainstorm-project, product-brief, research, and more
    • When to use analysis workflows
    • Creative and strategic tools
  • Phase 2: Planning Workflows - Scale-adaptive planning (967 lines)

    • prd, tech-spec, gdd, narrative, ux
    • Track-based planning approach (Quick Flow, BMad Method, Enterprise Method)
    • Which planning workflow to use
  • Phase 3: Solutioning Workflows - Architecture and validation (638 lines)

    • architecture, create-epics-and-stories, implementation-readiness
    • V6: Epics created AFTER architecture for better quality
    • Required for BMad Method and Enterprise Method tracks
    • Preventing agent conflicts
  • Phase 4: Implementation Workflows - Sprint-based development (1,634 lines)

    • sprint-planning, create-story, dev-story, code-review
    • Complete story lifecycle
    • One-story-at-a-time discipline
  • Testing & QA Workflows - Comprehensive quality assurance (1,420 lines)

    • Test strategy, automation, quality gates
    • TEA agent and test healing

🌐 External Resources

Community and Support

Ready to begin?Start with the Quick Start Guide