mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-18 02:05:30 +00:00
4308b36d4d
Major Changes: - Add sample custom agents demonstrating installable agent system - commit-poet: Generates semantic commit messages (BMAD Method repo sample) - toolsmith: Development tooling expert with knowledge base covering bundlers, deployment, docs, installers, modules, and tests (BMAD Method repo sample) - Both agents demonstrate custom agent architecture and are installable to projects via BMAD installer system - Include comprehensive installation guides and sidecar knowledge bases - Add bmad-quick-flow methodology for rapid development - create-tech-spec: Direct technical specification workflow - quick-dev: Flexible execution workflow supporting both tech-spec-driven and direct instruction development - quick-flow-solo-dev (Barry): 1 man show agent specialized in bmad-quick-flow methodology - Comprehensive documentation for quick-flow approach and solo development - Remove deprecated tech-spec workflow track - Delete entire tech-spec workflow directory and templates - Remove quick-spec-flow.md documentation (replaced by quick-flow docs) - Clean up unused epic and story templates - Fix custom agent installation across IDE installers - Repair antigravity and multiple IDE installers to properly support custom agents - Enable custom agent installation via quick installer, agent installer, regular installer, and special agent installer - All installation methods now accessible via npx with full documentation Infrastructure: - Update BMM module configurations and team setups - Modify workflow status paths to support quick-flow integration - Reorganize documentation with new agent and workflow guides - Add custom/ directory for user customizations - Update platform codes and installer configurations
6.7 KiB
6.7 KiB
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
- v4 to v6 Upgrade Guide - Migration path for v4 users
- Document Sharding Guide - Split large documents for 90%+ token savings
- Web Bundles - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation
- Bundle Distribution Setup - 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 - Module overview, agents, and complete documentation index
- BMM Documentation - All BMM-specific guides and references:
- Quick Start Guide - Step-by-step guide to building your first project
- Quick Spec Flow - Rapid Level 0-1 development
- Scale Adaptive System - Understanding the 5-level system
- Brownfield Guide - Working with existing codebases
- BMM Workflows Guide - ESSENTIAL READING
- Test Architect Guide - Testing strategy and quality assurance
BMad Builder (BMB) - Create Custom Solutions
Build your own agents, workflows, and modules.
- BMB Module README - Module overview and capabilities
- Agent Creation Guide - Design custom agents
Creative Intelligence Suite (CIS) - Innovation & Creativity
AI-powered creative thinking and brainstorming.
- CIS Module README - Module overview and workflows
🖥️ 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
Custom Agents
- Custom Agent Installation - Install and personalize agents with
bmad agent-install - Agent Customization Guide - Customize agent behavior and responses
Installation & Bundling
- IDE Injections Reference - How agents are installed to IDEs
- Installers & Platforms Reference - CLI tool and platform support
- Web Bundler Usage - Creating web-compatible bundles
🎓 Recommended Reading Paths
Path 1: Brand New to BMad (Software Project)
- README.md - Understand the vision
- Quick Start Guide - Get hands-on
- BMM Module README - Understand agents
- BMM Workflows Guide - Master the methodology
- Your IDE guide - Optimize your workflow
Path 2: Game Development Project
- README.md - Understand the vision
- Quick Start Guide - Get hands-on
- BMM Module README - Game agents are included
- BMM Workflows Guide - Game workflows
- Your IDE guide - Optimize your workflow
Path 3: Upgrading from v4
- v4 to v6 Upgrade Guide - Understand what changed
- Quick Start Guide - Reorient yourself
- BMM Workflows Guide - Learn new v6 workflows
Path 4: Working with Existing Codebase (Brownfield)
- Brownfield Guide - Approach for legacy code
- Quick Start Guide - Follow the process
- BMM Workflows Guide - Master the methodology
Path 5: Building Custom Solutions
- BMB Module README - Understand capabilities
- Agent Creation Guide - Create agents
- BMM Workflows Guide - Understand workflow structure
Path 6: Contributing to BMad
- CONTRIBUTING.md - Contribution guidelines
- Relevant module README - Understand the area you're contributing to
- Code Style section in CONTRIBUTING.md - Follow standards