ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

minor doc updates

This commit is contained in:
Brian Madison 2026-02-06 22:54:47 -06:00
parent 90d9204dc9
commit 6c2d0195d3
5 changed files with 26 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/how-to/established-projects.md
View File

@ -3,7 +3,7 @@ title: "Established Projects"
description: How to use BMad Method on existing codebases description: How to use BMad Method on existing codebases
--- ---
Use BMad Method effectively when working on existing projects and legacy codebases. Use BMad Method effectively when working on existing projects and legacy codebases, sometimes also referred to as brownfield projects.
This guide covers the essential workflow for onboarding to existing projects with BMad Method. This guide covers the essential workflow for onboarding to existing projects with BMad Method.

2
docs/how-to/install-bmad.md
View File

@ -5,6 +5,8 @@ description: Step-by-step guide to installing BMad in your project
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools. Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
If you want to use a non interactive installer and provide all install options on the command line, [this guide](/docs/non-interactive-installation.md).
## When to Use This ## When to Use This
- Starting a new project with BMad - Starting a new project with BMad

38
docs/how-to/shard-large-documents.md
View File

@ -2,23 +2,17 @@
title: "Document Sharding Guide" title: "Document Sharding Guide"
--- ---
Use the `shard-doc` tool to split large markdown files into smaller, organized files for better context management. Use the `shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
This is no longer recommended, and soon with updated workflows and most major llms and tools supporting sub processes this will be unnecessary.
## When to Use This ## When to Use This
- Very large complex PRDs Only use this if you notice your chosen tool / model combination are failing to load and read all the documents as input when needed.
- Architecture documents with multiple system layers
- Epic files with 4+ epics (especially for Phase 4)
- UX design specs covering multiple subsystems
## What is Document Sharding? ## What is Document Sharding?
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables: Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`).
- **Selective Loading** - Workflows load only the sections they need
- **Reduced Token Usage** - Massive efficiency gains for large projects
- **Better Organization** - Logical section-based file structure
- **Maintained Context** - Index file preserves document structure
### Architecture ### Architecture
@ -61,28 +55,6 @@ Agent: Sharding PRD.md...
✓ Complete! ✓ Complete!
``` ```
## What You Get
**index.md structure:**
```markdown
## Sections
1. [Overview](./overview.md) - Project vision and objectives
2. [User Requirements](./user-requirements.md) - Feature specifications
3. [Epic 1: Authentication](./epic-1-authentication.md) - User auth system
4. [Epic 2: Dashboard](./epic-2-dashboard.md) - Main dashboard UI
...
```
**Individual section files:**
- Named from heading text (kebab-case)
- Contains complete section content
- Preserves all markdown formatting
- Can be read independently
## How Workflow Discovery Works ## How Workflow Discovery Works
BMad workflows use a **dual discovery system**: BMad workflows use a **dual discovery system**:

70
docs/how-to/upgrade-to-v6.md
View File

@ -20,14 +20,7 @@ Use the BMad installer to upgrade from v4 to v6, which includes automatic detect
### 1. Run the Installer ### 1. Run the Installer
```bash Follow the [Installer Instructions](/docs/how-to/install-bmad.md).
npx bmad-method install
```
The installer automatically detects:
- **Legacy v4 folder**: `.bmad-method`
- **IDE command artifacts**: Legacy bmad folders in `.claude/commands/`, `.cursor/commands/`, etc.
### 2. Handle Legacy Installation ### 2. Handle Legacy Installation
@ -35,21 +28,16 @@ When v4 is detected, you can:
- Allow the installer to back up and remove `.bmad-method` - Allow the installer to back up and remove `.bmad-method`
- Exit and handle cleanup manually - Exit and handle cleanup manually
- Keep both (not recommended for same project)
If you named your bmad method folder something else - you will need to manual remove the folder yourself.
### 3. Clean Up IDE Commands ### 3. Clean Up IDE Commands
Manually remove legacy v4 IDE commands: Manually remove legacy v4 IDE commands - for example if you have claude, look for any nested folders that start with bmad and remove them:
- `.claude/commands/BMad/agents` - `.claude/commands/BMad/agents`
- `.claude/commands/BMad/tasks` - `.claude/commands/BMad/tasks`
New v6 commands will be at `.claude/commands/bmad/<module>/agents|workflows`.
:::tip[Accidentally Deleted Commands?]
If you delete the wrong commands, rerun the installer and choose "quick update" to restore them.
:::
### 4. Migrate Planning Artifacts ### 4. Migrate Planning Artifacts
**If you have planning documents (Brief/PRD/UX/Architecture):** **If you have planning documents (Brief/PRD/UX/Architecture):**
@ -71,24 +59,6 @@ If you have stories created or implemented:
3. Run the Scrum Master's `sprint-planning` workflow 3. Run the Scrum Master's `sprint-planning` workflow
4. Tell the SM which epics/stories are already complete 4. Tell the SM which epics/stories are already complete
### 6. Migrate Agent Customizations
**v4:** Modified agent files directly in `_bmad-*` folders
**v6:** All customizations go in `_bmad/_config/agents/` using customize files:
```yaml
# _bmad/_config/agents/bmm-pm.customize.yaml
persona:
name: 'Captain Jack'
role: 'Swashbuckling Product Owner'
communication_style: |
- Talk like a pirate
- Use nautical metaphors
```
After modifying customization files, rerun the installer and choose "rebuild all agents" or "quick update".
## What You Get ## What You Get
**v6 unified structure:** **v6 unified structure:**
@ -107,25 +77,19 @@ your-project/
## Module Migration ## Module Migration
| v4 Module | v6 Status | | v4 Module | v6 Status |
|-----------|-----------| | ----------------------------- | ----------------------------------------- |
| `_bmad-2d-phaser-game-dev` | Integrated into BMGD Module | | `.bmad-2d-phaser-game-dev` | Integrated into BMGD Module |
| `_bmad-2d-unity-game-dev` | Integrated into BMGD Module | | `.bmad-2d-unity-game-dev` | Integrated into BMGD Module |
| `_bmad-godot-game-dev` | Integrated into BMGD Module | | `.bmad-godot-game-dev` | Integrated into BMGD Module |
| `_bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon | | `.bmad-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
| `_bmad-creative-writing` | Not adapted — new v6 module coming soon | | `.bmad-creative-writing` | Not adapted — new v6 module coming soon |
## Key Changes ## Key Changes
| Concept | v4 | v6 | | Concept | v4 | v6 |
|---------|----|----| | ------------- | ------------------------------------- | ------------------------------------ |
| **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework | | **Core** | `_bmad-core` was actually BMad Method | `_bmad/core/` is universal framework |
| **Method** | `_bmad-method` | `_bmad/bmm/` | | **Method** | `_bmad-method` | `_bmad/bmm/` |
| **Config** | Modified files directly | `config.yaml` per module | | **Config** | Modified files directly | `config.yaml` per module |
| **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned | | **Documents** | Sharded or unsharded required setup | Fully flexible, auto-scanned |
## Tips
- **Back up first** — Keep your v4 installation until you verify v6 works
- **Use v6 workflows** — Even partial planning docs benefit from v6's improved discovery
- **Rebuild after customizing** — Always run the installer after changing customize files

2
docs/index.md
View File

@ -2,7 +2,7 @@
title: Welcome to the BMad Method title: Welcome to the BMad Method
--- ---
The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software faster and smarter. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity—whether you're fixing a bug or building an enterprise platform. The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Development) is an AI-driven development framework that helps you build software through the whole process from ideation and planning all the way through agentic implementation. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity, whether you're fixing a bug or building an enterprise platform.
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started. If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.