External/BMAD-METHOD
1
0
Fork 0
mirror of https://github.com/bmadcode/BMAD-METHOD.git synced 2025-12-29 16:14:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc and text cleanup

Browse Source
This commit is contained in:
Brian Madison
2025-07-04 07:47:57 -05:00
parent be4fcd8668
commit f440d14565
77 changed files with 243 additions and 78705 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/agentic-tools/claude-code-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Claude Code
# BMad Method Guide for Claude Code
This guide covers Claude Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers Claude Code-specific setup and usage with BMad Method. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Claude Code** as your IDE. This
- `.bmad-core/` folder with all agents
- `.claude/commands/` folder with agent command files (`.md`)
## Using BMAD Agents in Claude Code
## Using BMad Agents in Claude Code
Type `/agent-name` in your chat to activate an agent:

6
docs/agentic-tools/cline-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Cline (VS Code)
# BMad Method Guide for Cline (VS Code)
This guide covers Cline-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers Cline-specific setup and usage with BMad Method. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Cline** as your IDE. This creat
- `.clinerules/` directory with numbered agent rule files (`.md`)
- Agents ordered by priority (bmad-master first)
## Using BMAD Agents in Cline
## Using BMad Agents in Cline
1. **Open Cline panel** in VS Code
2. **Type `@agent-name`** in the chat (e.g., `@dev`, `@sm`, `@architect`)

6
docs/agentic-tools/cursor-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Cursor
# BMad Method Guide for Cursor
This guide covers Cursor-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers Cursor-specific setup and usage with BMad Method. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Cursor** as your IDE. This crea
- `.bmad-core/` folder with all agents
- `.cursor/rules/` folder with agent rule files (`.mdc`)
## Using BMAD Agents in Cursor
## Using BMad Agents in Cursor
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent:

6
docs/agentic-tools/gemini-cli-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Gemini CLI
# BMad Method Guide for Gemini CLI
This guide covers Gemini CLI-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers Gemini CLI-specific setup and usage with BMad Method. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Gemini CLI** as your IDE. This
- `.gemini/agents/` directory with all agent context files
- `.gemini/settings.json` configured to load all agents automatically
## Using BMAD Agents with Gemini CLI
## Using BMad Agents with Gemini CLI
Simply mention the agent in your prompt:

6
docs/agentic-tools/roo-code-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Roo Code
# BMad Method Guide for Roo Code
This guide covers Roo Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers Roo Code-specific setup and usage with BMad Method. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Roo Code** as your IDE. This cr
- `.bmad-core/` folder with all agents
- `.roomodes` file in project root with custom modes
## Using BMAD Agents in Roo Code
## Using BMad Agents in Roo Code
Select mode from the mode selector (usually in status bar):

8
docs/agentic-tools/vs-code-copilot-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Visual Studio Code
# BMad Method Guide for Visual Studio Code
This guide covers the setup and usage of the BMAD Method in Visual Studio Code. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers the setup and usage of the BMad Method in Visual Studio Code. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -10,7 +10,7 @@ When running `npx bmad-method install`, select **Visual Studio Code** as your ID
- Create the `.vscode/` directory and add a `settings.json` file with the basic configuration to enable GitHub Copilot's agent mode.
## Using BMAD Agents in VS Code
## Using BMad Agents in VS Code
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list (usually located next to the input field).
@@ -40,7 +40,7 @@ When running `npx bmad-method install`, select **Visual Studio Code** as your ID
- **Activation**: Use the `@` prefix in the GitHub Copilot Chat for instant switching between agents.
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMAD agents to work together in real-time.
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMad agents to work together in real-time.
- **Project Context**: Agents have full access to your workspace, including open files and the selected code.

8
docs/agentic-tools/windsurf-guide.md
View File

@@ -1,6 +1,6 @@
# BMAD Method Guide for Windsurf
# BMad Method Guide for Windsurf
This guide covers Windsurf-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
This guide covers Windsurf-specific setup and usage with BMad Method. For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
## Installation
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Windsurf** as your IDE. This cr
- `.bmad-core/` folder with all agents
- `.windsurf/rules/` folder with agent rule files (`.md`)
## Using BMAD Agents in Windsurf
## Using BMad Agents in Windsurf
Type `@agent-name` in chat to activate an agent:
@@ -27,7 +27,7 @@ Type `@agent-name` in chat to activate an agent:
- **Rule files**: Stored in `.windsurf/rules/` as `.md` files
- **Activation**: Use `@` prefix to mention agents
- **Collaborative features**: Works well with BMAD's agent-switching pattern
- **Collaborative features**: Works well with BMad's agent-switching pattern
- **Project context**: Agents have access to your full project context
## Tips for Windsurf Users

12
docs/bmad-workflow-guide.md
View File

@@ -1,12 +1,12 @@
# BMAD Method Universal Workflow Guide
# BMad Method Universal Workflow Guide
This guide outlines the core BMAD workflow that applies regardless of which AI-powered IDE you're using.
This guide outlines the core BMad workflow that applies regardless of which AI-powered IDE you're using.
## Overview
The BMAD Method follows a structured approach to AI-assisted software development:
The BMad Method follows a structured approach to AI-assisted software development:
1. **Install BMAD** in your project
1. **Install BMad** in your project
2. **Plan with Gemini** using team-fullstack
3. **Organize with bmad-master** (document sharding)
4. **Develop iteratively** with SM → Dev cycles
@@ -15,7 +15,7 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
### Phase 1: Project Setup
1. **Install BMAD in your project**:
1. **Install BMad in your project**:
```bash
npx bmad-method install
@@ -35,7 +35,7 @@ Use Google's Gemini for collaborative planning with the full team:
1. **Open [Google Gems](https://gemini.google.com/gems/view)**
2. **Create a new Gem**:
- Give it a title and description (e.g., "BMAD Team Fullstack")
- Give it a title and description (e.g., "BMad Team Fullstack")
3. **Load team-fullstack**:
- Copy contents of: `dist/teams/team-fullstack.txt` from your project
- Paste this content into the Gem setup to configure the team

203
docs/core-architecture.md
View File

@@ -1,24 +1,22 @@
# BMAD Method: Core Architecture
This document serves as the definitive source of truth for the BMAD-Method's architecture. It is designed to be understood by both human developers and the AI agents that operate within the framework.
# BMad Method: Core Architecture
## 1. Overview
The BMAD-Method is an AI-Powered Agile Development Framework designed to transform software development by providing specialized AI agents for every role in a complete Agile team. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex software development tasks in a predictable, high-quality manner.
The BMad Method is designed to provide agentic modes, tasks and templates to allow repeatable helpful workflows be it for agile agentic development, or expansion into vastly different domains. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex tasks, guided discussions, or other meaningful domain specific flows in a predictable, high-quality manner.
The system facilitates a full development lifecycle:
The systems core module facilitates a full development lifecycle tailored to the challenges of current modern AI Agentic tooling:
1. **Ideation & Planning**: Brainstorming, market research, and creating project briefs.
2. **Architecture & Design**: Defining system architecture and UI/UX specifications.
3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories with extremely specific context and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
## 2. System Architecture Diagram
The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
The entire BMad-Method ecosystem is designed around the installed `bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
```mermaid
graph TD
subgraph BMAD Method Project
subgraph BMad Method Project
subgraph Core Framework
A["bmad-core"]
A --> B["agents"]
@@ -63,9 +61,9 @@ graph TD
## 3. Core Components
The `.bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
The `bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
### 3.1. Agents (`.bmad-core/agents/`)
### 3.1. Agents (`bmad-core/agents/`)
- **Purpose**: These are the foundational building blocks of the system. Each markdown file (e.g., `bmad-master.md`, `pm.md`, `dev.md`) defines the persona, capabilities, and dependencies of a single AI agent.
- **Structure**: An agent file contains a YAML header that specifies its role, persona, dependencies, and startup instructions. These dependencies are lists of tasks, templates, checklists, and data files that the agent is allowed to use.
@@ -73,12 +71,12 @@ The `.bmad-core` directory contains all the definitions and resources that give
- **Document Integration**: Agents can reference and load documents from the project's `docs/` folder as part of tasks, workflows, or startup sequences. Users can also drag documents directly into chat interfaces to provide additional context.
- **Example**: The `bmad-master` agent lists its dependencies, which tells the build tool which files to include in a web bundle and informs the agent of its own capabilities.
### 3.2. Agent Teams (`.bmad-core/agent-teams/`)
### 3.2. Agent Teams (`bmad-core/agent-teams/`)
- **Purpose**: Team files (e.g., `team-all.yaml`) define collections of agents and workflows that are bundled together for a specific purpose, like "full-stack development" or "backend-only". This creates a larger, pre-packaged context for web UI environments.
- **Structure**: A team file lists the agents to include. It can use wildcards, such as `"*"` to include all agents. This allows for the creation of comprehensive bundles like `team-all`.
### 3.3. Workflows (`.bmad-core/workflows/`)
### 3.3. Workflows (`bmad-core/workflows/`)
- **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.yaml`) that define a prescribed sequence of steps and agent interactions for a specific project type. They act as a strategic guide for the user and the `bmad-orchestrator` agent.
- **Structure**: A workflow defines sequences for both complex and simple projects, lists the agents involved at each step, the artifacts they create, and the conditions for moving from one step to the next. It often includes a Mermaid diagram for visualization.
@@ -93,21 +91,21 @@ The `.bmad-core` directory contains all the definitions and resources that give
#### 3.4.1. Template Processing System
A key architectural principle of BMAD is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
A key architectural principle of BMad is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
The BMAD framework employs a sophisticated template processing system orchestrated by three key components:
The BMad framework employs a sophisticated template processing system orchestrated by three key components:
- **`template-format.md`** (`.bmad-core/utils/`): Defines the foundational markup language used throughout all BMAD templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
- **`template-format.md`** (`bmad-core/utils/`): Defines the foundational markup language used throughout all BMad templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
- **`create-doc.md`** (`.bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
- **`create-doc.md`** (`bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
- **`advanced-elicitation.md`** (`.bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
- **`advanced-elicitation.md`** (`bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
The system maintains a clean separation of concerns: template markup is processed internally by AI agents but never exposed to users, while providing sophisticated AI processing capabilities through embedded intelligence within the templates themselves.
#### 3.4.2. Technical Preferences System
BMAD includes a personalization layer through the `technical-preferences.md` file in `.bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
BMad includes a personalization layer through the `technical-preferences.md` file in `bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
**Purpose and Benefits:**
@@ -144,14 +142,14 @@ The framework is designed for two primary environments: local IDEs and web-based
### 4.2. Environment-Specific Usage
- **For IDEs**: Users interact with the agents directly via their markdown files in `.bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
- **For IDEs**: Users interact with the agents directly via their markdown files in `bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
- **For Web UIs**: Users upload a pre-built bundle from `dist`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
## 5. BMAD Workflows
## 5. BMad Workflows
### 5.1. The Planning Workflow
Before development begins, BMAD follows a structured planning workflow that establishes the foundation for successful project execution:
Before development begins, BMad follows a structured planning workflow that establishes the foundation for successful project execution:
```mermaid
graph TD
@@ -219,166 +217,3 @@ graph TD
```
This cycle continues, with the Scrum Master, Developer, and optionally QA agents working together. The QA agent provides senior developer review capabilities through the `review-story` task, offering code refactoring, quality improvements, and knowledge transfer. This ensures high code quality while maintaining development velocity.
## 8. Complete Source Tree
The BMAD-METHOD project structure is designed for clarity, modularity, and extensibility. Here's the complete source tree with explanations:
```plaintext
bmad-method/
├── .bmad-core/ # Core framework (installed in user projects)
│ ├── agents/ # Individual agent definitions
│ │ ├── analyst.md # Business analyst agent
│ │ ├── architect.md # Solution architect agent
│ │ ├── bmad-master.md # Universal expert agent
│ │ ├── bmad-orchestrator.md # Multi-agent coordinator
│ │ ├── dev.md # Full-stack developer agent
│ │ ├── pm.md # Product manager agent
│ │ ├── po.md # Product owner agent
│ │ ├── qa.md # QA specialist agent
│ │ ├── sm.md # Scrum master agent
│ │ └── ux-expert.md # UX designer agent
│ ├── agent-teams/ # Pre-configured agent teams
│ │ ├── team-all.yaml # All agents bundle
│ │ ├── team-fullstack.yaml # Full-stack development team
│ │ ├── team-ide-minimal.yaml # Minimal IDE-focused team
│ │ └── team-no-ui.yaml # Backend-only team
│ ├── checklists/ # Quality assurance checklists
│ │ ├── architect-checklist.md
│ │ ├── po-master-checklist.md
│ │ └── story-dod-checklist.md
│ ├── data/ # Knowledge base and preferences
│ │ ├── bmad-kb.md # Core knowledge base
│ │ └── technical-preferences.md # User tech preferences
│ ├── tasks/ # Reusable task definitions
│ │ ├── advanced-elicitation.md # Deep diving techniques
│ │ ├── create-doc.md # Document creation task
│ │ ├── create-next-story.md # Story generation task
│ │ ├── doc-migration-task.md # V3 to V4 migration
│ │ ├── execute-checklist.md # Checklist runner
│ │ └── shard-doc.md # Document sharding task
│ ├── templates/ # Document templates
│ │ ├── full-stack-architecture-tmpl.md
│ │ ├── prd-tmpl.md
│ │ ├── project-brief-tmpl.md
│ │ ├── story-tmpl.md
│ │ └── [other templates...]
│ ├── utils/ # Utility components
│ │ ├── agent-switcher.web # Web UI agent switching
│ │ ├── template-format.md # Template markup spec
│ │ └── workflow-management.md # Workflow helpers
│ ├── workflows/ # Development workflows
│ │ ├── brownfield-enhancement.yaml
│ │ ├── greenfield-fullstack.yaml
│ │ ├── greenfield-service.yaml
│ │ └── greenfield-simple.yaml
│ └── core-config.yaml # V4 configuration system
│
├── dist/ # Pre-built bundles (generated)
│ ├── agents/ # Individual agent bundles
│ │ ├── analyst.txt
│ │ ├── architect.txt
│ │ └── [other agents...]
│ ├── teams/ # Team bundles for web UI
│ │ ├── team-all.txt
│ │ ├── team-fullstack.txt
│ │ └── [other teams...]
│ └── expansion-packs/ # Expansion pack bundles
│
├── docs/ # Documentation
│ ├── agentic-tools/ # IDE-specific guides
│ │ ├── claude-code-guide.md
│ │ ├── cursor-guide.md
│ │ ├── cline-guide.md
│ │ ├── gemini-cli-guide.md
│ │ ├── roo-code-guide.md
│ │ ├── windsurf-guide.md
│ │ └── vs-code-copilot-guide.md
│ ├── bmad-workflow-guide.md # Universal workflow guide
│ ├── core-architecture.md # This document
│ ├── expansion-packs.md # Expansion pack guide
│ ├── user-guide.md # Comprehensive user guide
│ └── [other docs...]
│
├── expansion-packs/ # Domain-specific extensions
│ ├── bmad-2d-phaser-game-dev/ # Game development pack
│ ├── bmad-creator-tools/ # Agent creation tools
│ ├── bmad-infrastructure-devops/ # DevOps pack
│ └── README.md
│
├── tools/ # Build and installation tools
│ ├── builders/ # Build system
│ │ └── web-builder.js # Bundle generator
│ ├── cli.js # Main CLI tool
│ ├── installer/ # NPX installer
│ │ ├── index.js # Installer entry point
│ │ ├── config/ # Installation configs
│ │ ├── lib/ # Installer utilities
│ │ └── templates/ # IDE template files
│ └── lib/ # Shared libraries
│ ├── bundle-utils.js
│ ├── dependency-resolver.js
│ └── file-processor.js
│
├── .github/ # GitHub configuration
│ ├── workflows/ # GitHub Actions
│ └── ISSUE_TEMPLATE/ # Issue templates
│
├── common/ # Shared resources
│ ├── tasks/ # Common tasks
│ └── utils/ # Common utilities
│
├── bmad-core/ # Source for .bmad-core
│ └── [mirrors .bmad-core structure]
│
├── package.json # Node.js configuration
├── README.md # Project readme
├── CONTRIBUTING.md # Contribution guidelines
├── GUIDING-PRINCIPLES.md # Core principles
└── LICENSE # MIT license
```
### Directory Purposes
#### Core Framework (.bmad-core/)
- **agents/**: Individual AI agent personalities and capabilities
- **agent-teams/**: Bundles of agents for specific workflows
- **checklists/**: Quality assurance and validation steps
- **data/**: Knowledge base and user preferences
- **tasks/**: Reusable procedures agents can execute
- **templates/**: Document templates with embedded AI instructions
- **utils/**: Helper components for agents
- **workflows/**: Structured development processes
#### Generated Bundles (dist/)
- Pre-built text files ready for web UI upload
- Automatically generated by the build system
- Includes resolved dependencies for each agent/team
#### Tools (tools/)
- **cli.js**: Main build tool for creating bundles
- **installer/**: NPX-based installer for projects
- **builders/**: Bundle generation logic
- **lib/**: Shared utilities for build system
#### Expansion Packs (expansion-packs/)
- Domain-specific agent collections
- Extend BMAD beyond software development
- Each pack is self-contained with its own agents, tasks, and templates
#### Documentation (docs/)
- Comprehensive guides for users
- Technical architecture documentation
- IDE-specific setup instructions
### Key Files
- **core-config.yaml**: V4's flexible configuration system
- **bmad-kb.md**: Central knowledge base loaded by most agents
- **template-format.md**: Specification for BMAD's template markup
- **dependency-resolver.js**: Manages agent resource loading

8
docs/expansion-packs.md
View File

@@ -1,14 +1,14 @@
# The Power of BMAD Expansion Packs
# The Power of BMad Expansion Packs
## Overview
BMAD Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMAD into a universal AI agent system.
BMad Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMad into a universal AI agent system.
## Why Expansion Packs?
### Keep Core Lean
The core BMAD framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
The core BMad framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
### Domain Expertise
@@ -275,6 +275,6 @@ Every expansion pack:
## Remember
The BMAD Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
The BMad Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
**What expertise will you share with the world?**

2
docs/how-to-contribute-with-pull-requests.md
View File

@@ -22,7 +22,7 @@ A pull request (PR) is how you propose changes to a project on GitHub. Think of
### 1. Fork the Repository
1. Go to the [BMAD-METHOD repository](https://github.com/bmadcode/bmad-method)
1. Go to the [BMad-Method repository](https://github.com/bmadcode/bmad-method)
2. Click the "Fork" button in the top-right corner
3. This creates your own copy of the project

38
docs/user-guide.md
View File

@@ -1,10 +1,10 @@
# BMAD-METHOD Agentic Agile Driven Development User Guide
# BMad-Method Agentic Agile Driven Development User Guide
This comprehensive guide will help you understand and effectively use the BMad Method framework for AI-assisted software development.
## Table of Contents
1. [Understanding BMAD](#understanding-bmad)
1. [Understanding BMad](#understanding-bmad)
2. [Getting Started](#getting-started)
3. [Agent System](#agent-system)
4. [Templates and Document Creation](#templates-and-document-creation)
@@ -16,11 +16,11 @@ This comprehensive guide will help you understand and effectively use the BMad M
10. [Troubleshooting](#troubleshooting)
11. [Best Practices](#best-practices)
## Understanding BMAD
## Understanding BMad
### What is BMAD-METHOD?
### What is BMad-Method?
BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent orchestration framework that provides specialized AI agents for every role in a complete Agile development team. Unlike generic AI assistants, each BMAD agent has deep expertise in their specific domain and can collaborate to deliver complete software projects.
BMad-Method (Breakthrough Method of Agile AI-Driven Development) is an AI agent orchestration framework that provides specialized AI agents for every role in a complete Agile development team. Unlike generic AI assistants, each BMad agent has deep expertise in their specific domain and can collaborate to deliver complete software projects.
### Core Principles
@@ -30,7 +30,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
4. **Dynamic Dependencies**: Agents only load resources they need
5. **Platform Agnostic**: Works with any AI platform or IDE
### When to Use BMAD
### When to Use BMad
- **New Projects (Greenfield)**: Complete end-to-end development
- **Existing Projects (Brownfield)**: Feature additions and enhancements
@@ -83,7 +83,7 @@ npx bmad-method status
### Upgrading from V3 to V4
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
If you have an existing BMad-Method V3 project, simply run the installer in your project directory:
```bash
npx bmad-method install
@@ -104,7 +104,7 @@ After upgrading:
2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent by saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}'
3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
The reason #2 and #3 are optional is because now BMAD V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration)
The reason #2 and #3 are optional is because now BMad V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration)
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
@@ -181,7 +181,7 @@ dependencies:
### Understanding Templates
BMAD templates are **self-contained and interactive** - they embed both the desired document output and the LLM instructions needed to work with users. This means no separate task is needed for most document creation.
BMad templates are **self-contained and interactive** - they embed both the desired document output and the LLM instructions needed to work with users. This means no separate task is needed for most document creation.
#### Template Structure
@@ -283,7 +283,7 @@ This provides 10 structured brainstorming actions:
### The Planning Workflow (Web UI)
Before development begins, BMAD follows a structured planning workflow that's ideally done in web UI for cost efficiency:
Before development begins, BMad follows a structured planning workflow that's ideally done in web UI for cost efficiency:
```mermaid
graph TD
@@ -320,7 +320,7 @@ graph TD
### The Core Development Cycle (IDE)
Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
Once planning is complete and documents are sharded, BMad follows a structured development workflow:
```mermaid
graph TD
@@ -1039,7 +1039,7 @@ Agents can reference and load documents from the `docs/` folder:
### Technical Preferences System
BMAD includes a powerful personalization system through the `technical-preferences.md` file located in `.bmad-core/data/`.
BMad includes a powerful personalization system through the `technical-preferences.md` file located in `.bmad-core/data/`.
#### What is technical-preferences.md?
@@ -1133,11 +1133,11 @@ When creating custom web bundles or uploading to AI platforms, include your `tec
### Core Configuration
The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
#### Understanding core-config.yaml
This configuration file acts as a map for BMAD agents, telling them exactly where to find your project documents and how they're structured. It's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
This configuration file acts as a map for BMad agents, telling them exactly where to find your project documents and how they're structured. It's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
#### Configuration Structure
@@ -1347,7 +1347,7 @@ customTechnicalDocuments:
#### Best Practices
1. **Always Configure for Your Structure**: Don't force your project to match BMAD defaults
1. **Always Configure for Your Structure**: Don't force your project to match BMad defaults
2. **Keep devLoadAlwaysFiles Focused**: Only include files needed for every dev task
3. **Use Debug Log**: Enable when troubleshooting story implementation issues
4. **Version Control core-config.yaml**: Track changes to understand project evolution
@@ -1433,7 +1433,7 @@ Add specialized capabilities:
```text
project/
├── .bmad-core/ # BMAD agents and resources
├── .bmad-core/ # BMad agents and resources
├── docs/ # Generated documentation
│ ├── prd.md
│ ├── architecture.md
@@ -1445,7 +1445,7 @@ project/
#### Document Management
- Keep generated docs in `docs/` folder
- Version control all BMAD-generated content
- Version control all BMad-generated content
- Regular backups of `.bmad-core/` customizations
### Recommended Development Flow
@@ -1512,7 +1512,7 @@ project/
## Conclusion
BMAD-METHOD provides a comprehensive framework for AI-assisted software development. By following this guide, you'll be able to:
BMad-Method provides a comprehensive framework for AI-assisted software development. By following this guide, you'll be able to:
- Effectively use specialized AI agents
- Create professional documentation
@@ -1520,7 +1520,7 @@ BMAD-METHOD provides a comprehensive framework for AI-assisted software developm
- Integrate with your preferred tools
- Maintain high quality standards
Remember: BMAD is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
Remember: BMad is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
---

8
docs/versions.md
View File

@@ -2,9 +2,9 @@
## Previous Versions
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3)
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2)
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1)
- [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3)
- [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2)
- [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1)
## Current Version: V4 - Alpha
@@ -25,7 +25,7 @@ V3 didn't fix the disconnect, but it did make it easier to maintain them all in
V3's biggest impact was a full explosion of customizability. Tasks, Personas, Agent Configurations, Doc Templates, data payloads.
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMAD AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMad AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
Now, instead of configuring 4+ web agents, all needing many files uploaded to create them, a single Agent called BMad, with a whole team, and the ability to switch and maintain personas evolved. Now you could in the same chat thread, talk to the whole team, or anyone on the team. No more exporting and reimporting docs to different chats - all of the sudden, you could finish the PRD, and ask Josh to pass it off to the Architect, and that was it, the architect just had it and we moved on! And all of that with just 7 total files to upload, delivering all power.

2
docs/working-in-the-brownfield.md
View File

@@ -353,6 +353,6 @@ Is this a major enhancement affecting multiple systems?
## Conclusion
Brownfield development with BMAD-METHOD provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
Brownfield development with BMad-Method provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
Remember: **Document First, Plan Carefully, Integrate Safely**