mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
Compare commits
21 Commits
6.0.0-alph
...
6.0.0-alph
| Author | SHA1 | Date | |
|---|---|---|---|
|
8b92e5ee59 | ||
|
|
9f53d896b7 | ||
|
|
b46409e71d | ||
|
|
8cffd09fb7 | ||
|
|
2b89ee1302 | ||
|
|
b72c810a1f | ||
|
|
484990de50 | ||
|
|
b8836ced24 | ||
|
|
c7fcf16eae | ||
|
|
529d4a8c95 | ||
|
|
f0520c39d9 | ||
|
|
ff0517f4d0 | ||
|
|
b509fb9a1e | ||
|
|
e0090e5602 | ||
|
|
8d679b177b | ||
|
|
ea421adbf9 | ||
|
|
2a8a4388a9 | ||
|
|
d4a94df29a | ||
|
|
949cf64d3b | ||
|
|
aba9d11c88 | ||
|
|
208f27dcdb |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -46,8 +46,6 @@ CLAUDE.local.md
|
||||
# Project-specific
|
||||
_bmad-core
|
||||
_bmad-creator-tools
|
||||
test-project-install/*
|
||||
sample-project/*
|
||||
flattened-codebase.xml
|
||||
*.stats.md
|
||||
.internal-docs/
|
||||
@@ -66,6 +64,7 @@ shared-modules
|
||||
z*/
|
||||
|
||||
_bmad
|
||||
_bmad-output
|
||||
.claude
|
||||
.codex
|
||||
.github/chatmodes
|
||||
|
||||
1
.vscode/settings.json
vendored
1
.vscode/settings.json
vendored
@@ -57,6 +57,7 @@
|
||||
"tileset",
|
||||
"tmpl",
|
||||
"Trae",
|
||||
"Unsharded",
|
||||
"VNET",
|
||||
"webskip"
|
||||
],
|
||||
|
||||
156
CHANGELOG.md
156
CHANGELOG.md
@@ -1,5 +1,161 @@
|
||||
# Changelog
|
||||
|
||||
## [6.0.0-alpha.22]
|
||||
|
||||
**Release: December 31, 2025**
|
||||
|
||||
### 🌟 Key Highlights
|
||||
|
||||
1. **Unified Agent Workflow**: Create, Edit, and Validate workflows consolidated into single powerful agent workflow with separate step paths
|
||||
2. **Agent Knowledge System**: Comprehensive data file architecture with persona properties, validation patterns, and crafting principles
|
||||
3. **Deep Language Integration**: All sharded progressive workflows now support language choice at every step
|
||||
4. **Core Module Documentation**: Extensive docs for core workflows (brainstorming, party mode, advanced elicitation)
|
||||
5. **BMAD Core Concepts**: New documentation structure explaining agents, workflows, modules, and installation
|
||||
6. **Tech Spec Sharded**: create-tech-spec workflow converted to sharded format with orient-first pattern
|
||||
|
||||
### 🤖 Unified Agent Workflow (Major Feature)
|
||||
|
||||
**Consolidated Architecture:**
|
||||
|
||||
- **Single Workflow, Three Paths**: Create, Edit, and Validate operations unified under `src/modules/bmb/workflows/agent/`
|
||||
- **steps-c/**: Create path with 9 comprehensive steps for building new agents
|
||||
- **steps-e/**: Edit path with 10 steps for modifying existing agents
|
||||
- **steps-v/**: Validate path for standalone agent validation review
|
||||
- **data/**: Centralized knowledge base for all agent-building intel
|
||||
|
||||
### 📚 Agent Knowledge System
|
||||
|
||||
**Data File Architecture:**
|
||||
|
||||
Located in `src/modules/bmb/workflows/agent/data/`:
|
||||
|
||||
- **agent-metadata.md** (208 lines) - Complete metadata field reference
|
||||
- **agent-menu-patterns.md** (233 lines) - Menu design patterns and best practices
|
||||
- **agent-compilation.md** (273 lines) - Compilation process documentation
|
||||
- **persona-properties.md** (266 lines) - Persona crafting properties and examples
|
||||
- **principles-crafting.md** (292 lines) - Core principles for agent design
|
||||
- **critical-actions.md** (120 lines) - Critical action patterns
|
||||
- **expert-agent-architecture.md** (236 lines) - Expert agent structure
|
||||
- **expert-agent-validation.md** (173 lines) - Expert-specific validation
|
||||
- **module-agent-validation.md** (124 lines) - Module-specific validation
|
||||
- **simple-agent-architecture.md** (204 lines) - Simple agent structure
|
||||
- **simple-agent-validation.md** (132 lines) - Simple agent validation
|
||||
- **understanding-agent-types.md** (222 lines) - Agent type comparison
|
||||
- **brainstorm-context.md** - Brainstorming guidance
|
||||
- **communication-presets.csv** - Communication style presets
|
||||
|
||||
**Reference Examples:**
|
||||
|
||||
- **reference/module-examples/architect.agent.yaml** - Module agent example
|
||||
- **reference/simple-examples/commit-poet.agent.yaml** - Simple agent example
|
||||
- **journal-keeper/** - Complete sidecar pattern example
|
||||
|
||||
**Templates:**
|
||||
|
||||
- **templates/simple-agent.template.md** - Simple agent template
|
||||
- **templates/expert-agent-template/expert-agent.template.md** - Expert agent template
|
||||
- **templates/expert-agent-sidecar/** - Sidecar templates (instructions, memories)
|
||||
|
||||
### 🌍 Deep Language Integration
|
||||
|
||||
**Progressive Workflow Language Support:**
|
||||
|
||||
- **Every Step Biased**: All sharded progressive workflow steps now include language preference context
|
||||
- **260+ Files Updated**: Comprehensive language integration across:
|
||||
- Core workflows (brainstorming, party mode, advanced elicitation)
|
||||
- BMB workflows (create-agent, create-module, create-workflow, edit-workflow, etc.)
|
||||
- BMGD workflows (game-brief, gdd, narrative, game-architecture, etc.)
|
||||
- BMM workflows (research, create-ux-design, prd, create-architecture, etc.)
|
||||
- **Tested Languages**: Verified working with Spanish and Pirate Speak
|
||||
- **Natural Conversations**: AI agents respond in configured language throughout workflow
|
||||
|
||||
### 📖 Core Module Documentation
|
||||
|
||||
**New Core Documentation Structure:**
|
||||
|
||||
`docs/modules/core/`:
|
||||
|
||||
- **index.md** - Core module overview
|
||||
- **core-workflows.md** - Core workflow documentation
|
||||
- **core-tasks.md** - Core task reference
|
||||
- **brainstorming.md** (100 lines) - Brainstorming workflow guide
|
||||
- **party-mode.md** (50 lines) - Party mode guide
|
||||
- **advanced-elicitation.md** (105 lines) - Advanced elicitation techniques
|
||||
- **document-sharding-guide.md** (133 lines) - Sharded workflow format guide
|
||||
- **global-core-config.md** - Global core configuration reference
|
||||
|
||||
**Advanced Elicitation Moved:**
|
||||
|
||||
- **From**: `docs/` root
|
||||
- **To**: `src/core/workflows/advanced-elicitation/`
|
||||
- **Status**: Now a proper core workflow with methods.csv
|
||||
|
||||
### 📚 BMAD Core Concepts Documentation
|
||||
|
||||
**New Documentation Structure:**
|
||||
|
||||
`docs/bmad-core-concepts/`:
|
||||
|
||||
- **index.md** - Core concepts introduction
|
||||
- **agents.md** (93 lines) - Understanding agents in BMAD
|
||||
- **workflows.md** (89 lines) - Understanding workflows in BMAD
|
||||
- **modules.md** (76 lines) - Understanding modules (BMM, BMGD, CIS, BMB, Core)
|
||||
- **installing/index.md** (77 lines) - Installation guide
|
||||
- **installing/upgrading.md** (144 lines) - Upgrading guide
|
||||
- **bmad-customization/index.md** - Customization overview
|
||||
- **bmad-customization/agents.md** - Agent customization guide
|
||||
- **bmad-customization/workflows.md** (30 lines) - Workflow customization guide
|
||||
- **web-bundles/index.md** (34 lines) - Web bundle distribution guide
|
||||
|
||||
**Documentation Cleanup:**
|
||||
|
||||
- **Removed v4-to-v6-upgrade.md** - Outdated upgrade guide
|
||||
- **Removed document-sharding-guide.md** from docs root (moved to core)
|
||||
- **Removed web-bundles-gemini-gpt-guide.md** - Consolidated into web-bundles/index.md
|
||||
- **Removed getting-started/installation.md** - Migrated to bmad-core-concepts
|
||||
- **Removed all ide-info/*.md files** - Consolidated into web-bundles documentation
|
||||
|
||||
### 🔧 Create-Tech-Spec Sharded Conversion
|
||||
|
||||
**Monolithic to Sharded:**
|
||||
|
||||
- **From**: Single `workflow.yaml` with `instructions.md`
|
||||
- **To**: Sharded `workflow.md` with individual step files
|
||||
- **Pattern**: Orient-first approach (understand before investigating)
|
||||
|
||||
### 🔨 Additional Improvements
|
||||
|
||||
**Workflow Status Path Fixes:**
|
||||
|
||||
- **Corrected Discovery Paths**: workflow-status workflows now properly use planning_artifacts and implementation_artifacts
|
||||
- **Updated All Path Files**: enterprise-brownfield, enterprise-greenfield, method-brownfield, method-greenfield
|
||||
|
||||
**Documentation Updates:**
|
||||
|
||||
- **BMB Agent Creation Guide**: Comprehensive 166-line guide for agent creation
|
||||
- **Workflow Vendoring Doc**: New 42-line guide on workflow customization and inheritance
|
||||
- **Document Project Reference**: Moved from BMM docs to shared location
|
||||
- **Workflows Planning Guide**: New 89-line guide for planning workflows
|
||||
|
||||
**BMB Documentation Streamlining:**
|
||||
|
||||
- **Removed Redundant Docs**: Eliminated duplicate documentation in `src/modules/bmb/docs/`
|
||||
- **Step File Rules**: New 469-line comprehensive guide for step file creation
|
||||
- **Agent Docs Moved**: Agent architecture and validation docs moved to workflow data/
|
||||
|
||||
**Windows Inquirer Fix:**
|
||||
|
||||
- **Another Default Addition**: Additional inquirer default value setting for better Windows multiselection support
|
||||
|
||||
**Code Quality:**
|
||||
|
||||
- **Removed Old BMM README**: Consolidated module documentation
|
||||
- **Removed BMM Troubleshooting**: 661-line doc moved to shared location
|
||||
- **Removed Enterprise Agentic Development**: 686-line doc consolidated
|
||||
- **Removed Scale Adaptive System**: 618-line doc consolidated
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0-alpha.21]
|
||||
|
||||
**Release: December 27, 2025**
|
||||
|
||||
70
README.md
70
README.md
@@ -24,9 +24,8 @@ The completely revamped **BMAD V6 installer** now includes built-in support for
|
||||
|
||||
**📚 Learn More:**
|
||||
|
||||
- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
|
||||
- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
|
||||
- [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder
|
||||
- [**Custom Content Overview**](docs/modules/bmb-bmad-builder/custom-content.md) - Discover all supported content types
|
||||
- [**Installation Guide**](docs/modules/bmb-bmad-builder/custom-content-installation.md) - Learn to create and install custom content
|
||||
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||
|
||||
</div>
|
||||
@@ -68,7 +67,7 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
|
||||
## 📊 See It In Action
|
||||
|
||||
<p align="center">
|
||||
<img src="./src/modules/bmm/docs/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
||||
<img src="./docs/modules/bmm-bmad-method/images/workflow-method-greenfield.svg" alt="BMad Method Workflow" width="100%">
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -80,13 +79,18 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
|
||||
### 1. Install BMad Method
|
||||
|
||||
```bash
|
||||
# Install v6 Alpha (recommended)
|
||||
# Install v6 RECOMMENDED
|
||||
npx bmad-method@alpha install
|
||||
|
||||
# Or stable v4 for production
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
```bash
|
||||
# Install v4 Legacy (not recommended if starting fresh)
|
||||
npx bmad-method install
|
||||
# OR
|
||||
npx bmad-method@latest install
|
||||
```
|
||||
|
||||
|
||||
### 2. Initialize Your Project
|
||||
|
||||
Load any agent in your IDE and run:
|
||||
@@ -101,8 +105,8 @@ This analyzes your project and recommends the right workflow track.
|
||||
|
||||
BMad Method adapts to your needs with three intelligent tracks:
|
||||
|
||||
| Track | Use For | Planning | Time to Start |
|
||||
| ------------------ | ------------------------- | ----------------------- | ------------- |
|
||||
| Track | Use For | Planning | Time to Start |
|
||||
| ----------------- | ------------------------- | ----------------------- | ------------- |
|
||||
| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes |
|
||||
| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes |
|
||||
| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes |
|
||||
@@ -124,35 +128,35 @@ Each phase has specialized workflows and agents working together to deliver exce
|
||||
|
||||
**12 Specialized Agents** working in concert:
|
||||
|
||||
| Development | Architecture | Product | Leadership |
|
||||
| ----------- | -------------- | ------------- | -------------- |
|
||||
| Developer | Architect | PM | Scrum Master |
|
||||
| UX Designer | Test Architect | Analyst | BMad Master |
|
||||
| Tech Writer | Game Architect | Game Designer | Game Developer |
|
||||
| Development | Architecture | Product | Leadership |
|
||||
| ----------- | -------------- | ----------- | ------------ |
|
||||
| Developer | Architect | PM | Scrum Master |
|
||||
| UX Designer | Test Architect | Analyst | BMad Master |
|
||||
| | | Tech Writer | |
|
||||
|
||||
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready fixture-based utilities.
|
||||
**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities.
|
||||
|
||||
Each agent brings deep expertise and can be customized to match your team's style.
|
||||
|
||||
## 📦 What's Included
|
||||
|
||||
### Core Modules
|
||||
### Official Modules
|
||||
|
||||
- **BMad Method (BMM)** - Complete agile development framework
|
||||
- 12 specialized agents
|
||||
- 34 workflows across 4 phases
|
||||
- Scale-adaptive planning
|
||||
- [→ Documentation Hub](./src/modules/bmm/docs/index.md)
|
||||
- Stand Along Quick Spec Flow for a streamlined simple implementation process
|
||||
- [→ Documentation Hub](./docs/modules/bmm-bmad-method/index.md)
|
||||
|
||||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||
- Build anything from simple agents to complex modules
|
||||
- Create domain-specific solutions (legal, medical, finance, education)
|
||||
- [→ Builder Guide](./src/modules/bmb/docs/index.md)
|
||||
- [→ Builder Guide](./docs/modules/bmb-bmad-builder/index.md)
|
||||
|
||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||
- Brainstorming, design thinking, storytelling
|
||||
- 5 creative facilitation workflows
|
||||
- [→ Creative Workflows](./src/modules/cis/docs/index.md)
|
||||
- [→ Creative Workflows](./docs/modules/cis-creative-intelligence-suite/index.md)
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -166,14 +170,14 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
||||
|
||||
### Quick Links
|
||||
|
||||
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
|
||||
- **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references
|
||||
- **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
|
||||
- **[Quick Start Guide](./docs/modules/bmm-bmad-method/quick-start.md)** - 15-minute introduction
|
||||
- **[Complete BMM Documentation](./docs/modules/bmm-bmad-method/index.md)** - All guides and references
|
||||
- **[Agent Customization](docs/bmad-customization/agent-customization-guide.md)** - Personalize your agents
|
||||
- **[All Documentation](./docs/index.md)** - Complete documentation index
|
||||
|
||||
### For v4 Users
|
||||
|
||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)**
|
||||
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
||||
- **[v4 to v6 Upgrade Guide](./docs/v4-to-v6-upgrade.md)**
|
||||
|
||||
## 💬 Community & Support
|
||||
@@ -181,24 +185,12 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
||||
- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects
|
||||
- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features
|
||||
- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos
|
||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles
|
||||
- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon)
|
||||
- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines
|
||||
|
||||
## 🛠️ Development
|
||||
|
||||
For contributors working on the BMad codebase:
|
||||
|
||||
```bash
|
||||
# Run all quality checks
|
||||
npm test
|
||||
|
||||
# Development commands
|
||||
npm run lint:fix # Fix code style
|
||||
npm run format:fix # Auto-format code
|
||||
npm run bundle # Build web bundles
|
||||
```
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||
If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
|
||||
|
||||
## What's New in v6
|
||||
|
||||
|
||||
93
docs/bmad-core-concepts/agents.md
Normal file
93
docs/bmad-core-concepts/agents.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# Agents
|
||||
|
||||
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
|
||||
|
||||
## Agent Types
|
||||
|
||||
BMAD has two primary agent types, designed for different use cases:
|
||||
|
||||
### Simple Agents
|
||||
|
||||
**Self-contained, focused, ready to use.**
|
||||
|
||||
Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
|
||||
|
||||
**Best for:**
|
||||
- Single-purpose assistants (code review, documentation, commit messages)
|
||||
- Quick deployment
|
||||
- Projects that don't require persistent memory
|
||||
- Getting started fast
|
||||
|
||||
**Example:** A commit message agent that reads your git diff and generates conventional commits.
|
||||
|
||||
### Expert Agents
|
||||
|
||||
**Powerful, memory-equipped, domain specialists.**
|
||||
|
||||
Expert agents have a **sidecar** - a companion folder containing additional instructions, workflows, and memory files. They remember context across sessions and handle complex, multi-step tasks.
|
||||
|
||||
**Best for:**
|
||||
- Domain specialists (security architect, game designer, product manager)
|
||||
- Tasks requiring persistent memory
|
||||
- Complex workflows with multiple stages
|
||||
- Projects that grow over time
|
||||
|
||||
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
|
||||
|
||||
## Key Differences
|
||||
|
||||
| Feature | Simple | Expert |
|
||||
| ---------------- | -------------- | -------------------------- |
|
||||
| **Files** | Single file | Agent + sidecar folder |
|
||||
| **Memory** | Session only | Persistent across sessions |
|
||||
| **Capabilities** | Focused scope | Multi-domain, extensible |
|
||||
| **Setup** | Zero config | Sidecar initialization |
|
||||
| **Best Use** | Specific tasks | Ongoing projects |
|
||||
|
||||
## Agent Components
|
||||
|
||||
All agents share these building blocks:
|
||||
|
||||
### Persona
|
||||
- **Role** - What the agent does (expertise domain)
|
||||
- **Identity** - Who the agent is (personality, character)
|
||||
- **Communication Style** - How the agent speaks (tone, voice)
|
||||
- **Principles** - Why the agent acts (values, decision framework)
|
||||
|
||||
### Capabilities
|
||||
- Skills, tools, and knowledge the agent can apply
|
||||
- Mapped to specific menu commands
|
||||
|
||||
### Menu
|
||||
- Interactive command list
|
||||
- Triggers, descriptions, and handlers
|
||||
- Auto-includes help and exit options
|
||||
|
||||
### Critical Actions (optional)
|
||||
- Instructions that execute before the agent starts
|
||||
- Enable autonomous behaviors (e.g., "check git status before changes")
|
||||
|
||||
## Which Should You Use?
|
||||
|
||||
**Choose Simple when:**
|
||||
- You need a task done quickly and reliably
|
||||
- The scope is well-defined and won't change much
|
||||
- You don't need the agent to remember things between sessions
|
||||
|
||||
**Choose Expert when:**
|
||||
- You're building something complex over time
|
||||
- The agent needs to maintain context (project history, decisions)
|
||||
- You want the agent to coordinate workflows or other agents
|
||||
- Domain expertise requires specialized knowledge bases
|
||||
|
||||
## Creating Custom Agents
|
||||
|
||||
BMAD provides the **BMAD Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](../modules/bmb-bmad-builder/agent-creation-guide.md) for step-by-step instructions.
|
||||
|
||||
## Customizing Existing Agents
|
||||
|
||||
You can modify any agent's behavior without editing core files. See [BMAD Customization](./bmad-customization/) for details. It is critical to never modify an installed agents .md file directly and follow the customization process, this way future updates to the agent or module its part of will continue to be updated and recompiled with the installer tool, and your customizations will still be retained.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Learn about [Workflows](./workflows.md) to see how agents accomplish complex tasks.
|
||||
@@ -81,7 +81,7 @@ Add your own workflows to the agent's menu:
|
||||
```yaml
|
||||
menu:
|
||||
- trigger: my-workflow
|
||||
workflow: '{project-root}/custom/my-workflow.yaml'
|
||||
workflow: '{project-root}/my-custom/workflows/my-workflow.yaml'
|
||||
description: My custom workflow
|
||||
- trigger: deploy
|
||||
action: '#deploy-prompt'
|
||||
@@ -203,6 +203,8 @@ memories:
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[BMM Agents Guide](./modules/bmm/agents-guide)** - Learn about the BMad Method agents
|
||||
- **[BMB Create Agent Workflow](./modules/bmb/agents/index)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](./modules/bmm/index)** - Full BMad Method reference
|
||||
- **[Learn about Agents](../agents.md)** - Understand Simple vs Expert agents
|
||||
- **[Agent Creation Guide](../../modules/bmb-bmad-builder/agent-creation-guide.md)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](../../modules/bmm-bmad-method/index)** - Full BMad Method reference
|
||||
|
||||
[← Back to Customization](./index.md)
|
||||
26
docs/bmad-core-concepts/bmad-customization/index.md
Normal file
26
docs/bmad-core-concepts/bmad-customization/index.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# BMAD Customization
|
||||
|
||||
Personalize agents and workflows to match your needs.
|
||||
|
||||
## Guides
|
||||
|
||||
| Guide | Description |
|
||||
|-------|-------------|
|
||||
| **[Agent Customization](./agents.md)** | Modify agent behavior without editing core files |
|
||||
| **[Workflow Customization](./workflows.md)** | Customize and optimize workflows |
|
||||
|
||||
## Overview
|
||||
|
||||
BMAD provides two main customization approaches:
|
||||
|
||||
### Agent Customization
|
||||
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
|
||||
|
||||
### Workflow Customization
|
||||
Replace or extend workflow steps to create tailored processes. (Coming soon)
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Agent Customization Guide](./agents.md) to start personalizing your agents.
|
||||
|
||||
[← Back to Core Concepts](../index.md)
|
||||
30
docs/bmad-core-concepts/bmad-customization/workflows.md
Normal file
30
docs/bmad-core-concepts/bmad-customization/workflows.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Workflow Customization Guide
|
||||
|
||||
Customize and optimize workflows with step replacement and hooks.
|
||||
|
||||
## Status
|
||||
|
||||
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
|
||||
|
||||
## What to Expect
|
||||
|
||||
Workflow customization will allow you to:
|
||||
|
||||
- **Replace Steps** - Swap out specific workflow steps with custom implementations
|
||||
- **Add Hooks** - Inject custom behavior before/after workflow steps
|
||||
- **Extend Workflows** - Create new workflows based on existing ones
|
||||
- **Override Behavior** - Customize workflow logic for your project's needs
|
||||
|
||||
## For Now
|
||||
|
||||
While workflow customization is in development, you can:
|
||||
|
||||
- **Create Custom Workflows** - Use the BMAD Builder to create entirely new workflows
|
||||
- **Customize Agents** - Modify agent behavior using [Agent Customization](./agents.md)
|
||||
- **Provide Feedback** - Share your workflow customization needs with the community
|
||||
|
||||
---
|
||||
|
||||
**In the meantime:** Learn how to [create custom workflows](../../modules/bmb-bmad-builder/index) from scratch.
|
||||
|
||||
[← Back to Customization](./index.md)
|
||||
37
docs/bmad-core-concepts/index.md
Normal file
37
docs/bmad-core-concepts/index.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# BMAD Core Concepts
|
||||
|
||||
Understanding the fundamental building blocks of the BMAD Method.
|
||||
|
||||
## The Essentials
|
||||
|
||||
| Concept | Description | Guide |
|
||||
|---------|-------------|-------|
|
||||
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](./agents.md) |
|
||||
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](./workflows.md) |
|
||||
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](./modules.md) |
|
||||
|
||||
## Getting Started
|
||||
|
||||
### New to BMAD?
|
||||
Start here to understand what BMAD is and how it works:
|
||||
|
||||
1. **[Agents Guide](./agents.md)** - Learn about Simple and Expert agents
|
||||
2. **[Workflows Guide](./workflows.md)** - Understand how workflows orchestrate tasks
|
||||
3. **[Modules Guide](./modules.md)** - See how modules organize functionality
|
||||
|
||||
### Installing BMAD
|
||||
|
||||
- **[Installation Guide](./installing/)** - Set up BMAD in your project
|
||||
- **[Upgrading from v4](./installing/upgrading.md)** - Migrate from earlier versions
|
||||
|
||||
### Configuration
|
||||
|
||||
- **[BMAD Customization](./bmad-customization/)** - Personalize agents and workflows
|
||||
|
||||
### Advanced
|
||||
|
||||
- **[Web Bundles](./web-bundles/)** - Use BMAD in Gemini Gems and Custom GPTs
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Agents Guide](./agents.md) to understand the core building block of BMAD.
|
||||
77
docs/bmad-core-concepts/installing/index.md
Normal file
77
docs/bmad-core-concepts/installing/index.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# Installation
|
||||
|
||||
Get BMAD up and running in your project.
|
||||
|
||||
## Upgrading?
|
||||
|
||||
If you're upgrading from v4, see the [Upgrade Guide](./upgrading.md).
|
||||
|
||||
---
|
||||
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
This interactive installer will:
|
||||
|
||||
1. Let you choose a location to install to
|
||||
2. Let you choose which Agentic LLM Tools you would like to use (Such as Claude Code, Cursor, Windsurf, etc...)
|
||||
3. Let you choose which official modules to install (BMad Method, Creative Intelligence suite, BMad Builder)
|
||||
4. Let you choose any custom local modules, workflows or agents to install
|
||||
5. Let you configure each module or quickly accept the default recommended settings for each selected model
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Node.js** 20+ (for the installer)
|
||||
- **Git** (recommended for version control)
|
||||
- An **AI-powered Agent and/or IDE** or access to Claude/ChatGPT/Gemini
|
||||
|
||||
## Module Options
|
||||
|
||||
During installation, you'll choose which modules to install:
|
||||
|
||||
| Module | Description | Best For |
|
||||
| -------- | -------------------- | ----------------------------------------------------- |
|
||||
| **BMM** | BMAD Method Core | Software development projects |
|
||||
| **BMGD** | Game Development | Game projects with specialized workflows |
|
||||
| **CIS** | Creative Intel Suite | Creativity Unlocking Suite, not software dev specific |
|
||||
| **BMB** | Builder | Creating custom agents and workflows |
|
||||
|
||||
You will also be asked if you would like to install custom content (agents, workflows or modules) you have created with the BMB, or shared from others in the community.
|
||||
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMAD configuration and agents
|
||||
│ ├── bmm/ # Method module (if installed)
|
||||
│ ├── bmgd/ # Game dev module (if installed)
|
||||
│ ├── core/ # Always installed, includes party mode, advanced elicitation, and other core generic utils
|
||||
│ ├── {others}/ # etc...
|
||||
├── _bmad-output/ # BMAD default output folder - configurable during install
|
||||
├── .claude/ # IDE-specific setup (varies by IDE)
|
||||
└── ... your code # maybe nothing else yet if a fresh new folder
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Read the [Quick Start Guide](../../modules/bmm-bmad-method/quick-start)** to build your first feature
|
||||
2. **Explore [Workflows](../../modules/bmm-bmad-method/index#-workflow-guides)** to understand the methodology
|
||||
3. **Learn about [Agents](../agents.md)** to understand BMAD's core building blocks
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**"Command not found: npx"**
|
||||
: Install Node.js 20+ from [nodejs.org](https://nodejs.org)
|
||||
|
||||
**"Permission denied"**
|
||||
: Run with appropriate permissions or check your npm configuration
|
||||
|
||||
For more help, join our [Discord](https://discord.gg/bmad).
|
||||
144
docs/bmad-core-concepts/installing/upgrading.md
Normal file
144
docs/bmad-core-concepts/installing/upgrading.md
Normal file
@@ -0,0 +1,144 @@
|
||||
# BMad v4 to v6 Upgrade Guide
|
||||
|
||||
## Overview
|
||||
|
||||
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
|
||||
|
||||
---
|
||||
|
||||
## Automatic V4 Detection
|
||||
|
||||
When you run `npm run install:bmad` on a project, the installer automatically detects:
|
||||
|
||||
- **Legacy v4 installation folder**: `.bmad-method`
|
||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
||||
|
||||
### What Happens During Detection
|
||||
|
||||
1. **Automatic Detection of v4 Modules**
|
||||
1. Installer will suggest removal or backup of your .bmad-method folder. You can choose to exit the installer and handle this cleanup, or allow the install to continue. Technically you can have both v4 and v6 installed, but it is not recommended. All BMad content and modules will be installed under a .bmad folder, fully segregated.
|
||||
|
||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
||||
- Located in IDE config folders, for example claude: `.claude/commands/BMad/agents`, `.claude/commands/BMad/tasks`, etc.
|
||||
- NOTE: if the upgrade and install of v6 finished, the new commands will be under `.claude/commands/bmad/<module>/agents|workflows`
|
||||
- Note 2: If you accidentally delete the wrong/new bmad commands - you can easily restore them by rerunning the installer, and choose quick update option, and all will be reapplied properly.
|
||||
|
||||
## Module Migration
|
||||
|
||||
### Deprecated Modules from v4
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
| ----------------------------- | ---------------------------------------------- |
|
||||
| `_bmad-2d-phaser-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-2d-unity-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-godot-game-dev` | Integrated into new BMGD Module |
|
||||
| `_bmad-*-game-dev` (any) | Integrated into new BMGD Module |
|
||||
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming soon |
|
||||
| `_bmad-creative-writing` | Not adapted - New v6 module coming soon |
|
||||
|
||||
Aside from .bmad-method - if you have any of these others installed also, again its recommended to remove them and use the V6 equivalents, but its also fine if you decide to keep both. But it is not recommended to use both on the same project long term.
|
||||
|
||||
## Architecture Changes
|
||||
|
||||
### Folder Structure
|
||||
|
||||
**v4 "Expansion Packs" Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .bmad-method/
|
||||
├── .bmad-game-dev/
|
||||
├── .bmad-creative-writing/
|
||||
└── .bmad-infrastructure-devops/
|
||||
```
|
||||
|
||||
**v6 Unified Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder is _bmad
|
||||
└── _config/ # Your customizations
|
||||
| └── agents/ # Agent customization files
|
||||
├── core/ # Real core framework (applies to all modules)
|
||||
├── bmm/ # BMad Method (software/game dev)
|
||||
├── bmb/ # BMad Builder (create agents/workflows)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
├── _bmad_output # Default bmad output folder (was doc folder in v4)
|
||||
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method
|
||||
- **v6 `_bmad/core/`**: Is the real universal core framework
|
||||
- **v6 `_bmad/bmm/`**: Is the BMad Method module
|
||||
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
|
||||
|
||||
## Project Progress Migration
|
||||
|
||||
### If You've Completed Some or all Planning Phases (Brief/PRD/UX/Architecture) with the BMad Method:
|
||||
|
||||
After running the v6 installer, if you kept the paths the same as the installation suggested, you will need to move a few files, or run the installer again. It is recommended to stick with these defaults as it will be easier to adapt if things change in the future.
|
||||
|
||||
If you have any planning artifacts, put them in a folder called _bmad-output/planning-artifacts at the root of your project, ensuring that:
|
||||
PRD has PRD in the file name or folder name if sharded.
|
||||
Similar for 'brief', 'architecture', 'ux-design'.
|
||||
|
||||
If you have other long term docs that will not be as ephemeral as these project docs, you can put them in the /docs folder, ideally with a index.md file.
|
||||
|
||||
HIGHLY RECOMMENDED NOTE: If you are only partway through planning, its highly recommended to restart and do the PRD, UX and ARCHITECTURE steps. You could even use your existing documents as inputs letting the agent know you want to redo them with the new workflows. These optimized v6 progressive discovery workflows that also will utilize web search at key moments, while offering better advanced elicitation and part mode in the IDE will produce superior results. And then once all are complete, an epics with stories is generated after the architecture step now - ensuring it uses input from all planing documents.
|
||||
|
||||
### If You're Mid-Development (Stories Created/Implemented)
|
||||
|
||||
1. Complete the v6 installation as above
|
||||
2. Ensure you have a file called epics.md or epics/epic*.md - these need to be located under the _bmad-output/planning-artifacts folder.
|
||||
3. Run the scrum masters `sprint-planning` workflow to generate the implementation tracking plan in _bmad-output/implementation-artifacts.
|
||||
4. Inform the SM after the output is complete which epics and stories were completed already and should be parked properly in the file.
|
||||
|
||||
## Agent Customization Migration
|
||||
|
||||
### v4 Agent Customization
|
||||
|
||||
In v4, you may have modified agent files directly in `_bmad-*` folders.
|
||||
|
||||
### v6 Agent Customization
|
||||
|
||||
**All customizations** now go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
**Example: Renaming an agent and changing communication style**
|
||||
|
||||
File: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
|
||||
```yaml
|
||||
# Customize the PM agent
|
||||
persona:
|
||||
name: 'Captain Jack' # Override agent name
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors for software concepts
|
||||
- Always upbeat and adventurous
|
||||
```
|
||||
|
||||
There is a lot more that is possible with agent customization, which is covered in detail in the [Agent Customization Guide](../bmad-customization/agents.md)
|
||||
|
||||
CRITICAL NOTE: After you modify the customization file, you need to run the npx installer against your installed location, and choose the option to rebuild all agents, or just do a quick update again. This always builds agents fresh and applies customizations.
|
||||
|
||||
**How it works:**
|
||||
|
||||
- Base agent: `_bmad/bmm/agents/pm.md`
|
||||
- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
- Rebuild all agents -> Result: Agent uses your custom name and style
|
||||
|
||||
## Document Compatibility
|
||||
|
||||
### Sharded vs Unsharded Documents
|
||||
|
||||
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
|
||||
|
||||
- ✅ Sharded documents (split into multiple files)
|
||||
- ✅ Unsharded documents (single file per section)
|
||||
- ✅ Custom sections for your project type
|
||||
- ✅ Mixed approaches
|
||||
|
||||
All workflow files are scanned automatically. No manual configuration needed.
|
||||
76
docs/bmad-core-concepts/modules.md
Normal file
76
docs/bmad-core-concepts/modules.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Modules
|
||||
|
||||
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
|
||||
|
||||
## What is a Module?
|
||||
|
||||
A module is a self-contained package that includes:
|
||||
|
||||
- **Agents** - Specialized AI assistants
|
||||
- **Workflows** - Step-by-step processes
|
||||
- **Configuration** - Module-specific settings
|
||||
- **Documentation** - Usage guides and reference
|
||||
|
||||
## Official Modules
|
||||
|
||||
### Core Module
|
||||
Always installed, provides shared functionality:
|
||||
- Global configuration
|
||||
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
|
||||
- Common tasks (document indexing, sharding, review)
|
||||
|
||||
### BMAD Method (BMM)
|
||||
Software and game development:
|
||||
- Project planning workflows
|
||||
- Implementation agents (Dev, PM, QA, Scrum Master)
|
||||
- Testing and architecture guidance
|
||||
|
||||
### BMAD Builder (BMB)
|
||||
Create custom solutions:
|
||||
- Agent creation workflows
|
||||
- Workflow authoring tools
|
||||
- Module scaffolding
|
||||
|
||||
### Creative Intelligence Suite (CIS)
|
||||
Innovation and creativity:
|
||||
- Creative thinking techniques
|
||||
- Innovation strategy workflows
|
||||
- Storytelling and ideation
|
||||
|
||||
### BMAD Game Dev (BMGD)
|
||||
Game development specialization:
|
||||
- Game design workflows
|
||||
- Narrative development
|
||||
- Performance testing frameworks
|
||||
|
||||
## Module Structure
|
||||
|
||||
Installed modules follow this structure:
|
||||
|
||||
```
|
||||
_bmad/
|
||||
├── core/ # Always present
|
||||
├── bmm/ # BMAD Method (if installed)
|
||||
├── bmb/ # BMAD Builder (if installed)
|
||||
├── cis/ # Creative Intelligence (if installed)
|
||||
└── bmgd/ # Game Dev (if installed)
|
||||
```
|
||||
|
||||
## Custom Modules
|
||||
|
||||
You can create your own modules containing:
|
||||
- Custom agents for your domain
|
||||
- Organizational workflows
|
||||
- Team-specific configurations
|
||||
|
||||
Custom modules are installed the same way as official modules.
|
||||
|
||||
## Installing Modules
|
||||
|
||||
During BMAD installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
|
||||
|
||||
See [Installation Guide](./installing/) for details.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Read the [Installation Guide](./installing/) to set up BMAD with the modules you need.
|
||||
34
docs/bmad-core-concepts/web-bundles/index.md
Normal file
34
docs/bmad-core-concepts/web-bundles/index.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Web Bundles
|
||||
|
||||
Use BMAD agents in Gemini Gems and Custom GPTs.
|
||||
|
||||
## Status
|
||||
|
||||
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
|
||||
|
||||
## What Are Web Bundles?
|
||||
|
||||
Web bundles package BMad agents as self-contained files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file for easy upload.
|
||||
|
||||
### What's Included
|
||||
|
||||
- Complete agent persona and instructions
|
||||
- All workflows and dependencies
|
||||
- Interactive menu system
|
||||
- Party mode for multi-agent collaboration
|
||||
- No external files required
|
||||
|
||||
### Use Cases
|
||||
|
||||
**Perfect for:**
|
||||
- Uploading a single file to a Gemini GEM or Custom GPT
|
||||
- Using BMAD Method from the Web
|
||||
- Cost savings (generally lower cost than local usage)
|
||||
- Quick sharing of agent configurations
|
||||
|
||||
**Trade-offs:**
|
||||
- Some quality reduction vs local usage
|
||||
- Less convenient than full local installation
|
||||
- Limited to agent capabilities (no workflow file access)
|
||||
|
||||
[← Back to Core Concepts](../index.md)
|
||||
89
docs/bmad-core-concepts/workflows.md
Normal file
89
docs/bmad-core-concepts/workflows.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# Workflows
|
||||
|
||||
Workflows are structured processes that guide agents through complex tasks. Think of them as recipes that ensure consistent, high-quality outcomes.
|
||||
|
||||
## What is a Workflow?
|
||||
|
||||
A workflow is a step-by-step process that agents follow to accomplish specific objectives. A workflow can be a single file if small enough, but more than likely is comprized of a very small workflow or skill definition file with multiple steps and data files that are loaded as needed on demand. Each step file:
|
||||
|
||||
- Defines a clear goal
|
||||
- Provides instructions for the agent
|
||||
- May include decision points or user interactions
|
||||
- Produces specific outputs
|
||||
- Progressively at a specific point can load the next proper step.
|
||||
|
||||
## How Workflows Work
|
||||
|
||||
```
|
||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||
│ Step 1 │ → │ Step 2 │ → │ Step 3 │ → │ Complete │
|
||||
│ Discover │ │ Define │ │ Build │ │ Output │
|
||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||
```
|
||||
|
||||
**Key characteristics:**
|
||||
- **Progressive** - Each step builds on the previous
|
||||
- **Interactive** - Workflows can pause for user input
|
||||
- **Reusable** - The same workflow produces consistent results
|
||||
- **Composable** - Workflow steps can call other workflow steps, or whole other workflows!
|
||||
- **LLM Reinforcement** - Some rules or info is repeated in each step file ensuring certain rules are always top of agent mind, even during context heavy processes or very long workflows!
|
||||
|
||||
## Workflow Types
|
||||
|
||||
### Planning Workflows
|
||||
|
||||
Generate project artifacts like requirements, architecture, and task breakdowns.
|
||||
|
||||
**Examples:** Brief creation, PRD authoring, architecture design, sprint planning
|
||||
|
||||
### Execution Workflows
|
||||
|
||||
Guide implementation of specific tasks or features.
|
||||
|
||||
**Examples:** Code implementation, code review, testing, deployment
|
||||
|
||||
### Support Workflows
|
||||
|
||||
Handle cross-cutting concerns and creative processes.
|
||||
|
||||
**Examples:** Brainstorming, retrospectives, root cause analysis
|
||||
|
||||
## Progressive Disclosure
|
||||
|
||||
BMAD workflows use **progressive disclosure** - each step only knows about its immediate next step and what it is currently meant to do. This:
|
||||
|
||||
- Reduces cognitive load on the AI
|
||||
- Ensures each step gets full attention
|
||||
- Allows for conditional routing based on previous outcomes
|
||||
- Makes workflows easier to debug and modify
|
||||
|
||||
## Menu-Driven Interaction
|
||||
|
||||
Most workflows use interactive menus with standard options:
|
||||
|
||||
| Option | Purpose |
|
||||
| ---------------- | -------------------------------------------------- |
|
||||
| **[A] Advanced** | Invoke deeper reasoning techniques |
|
||||
| **[P] Party** | Get multiple agent perspectives |
|
||||
| **[C] Continue** | Proceed to next step after all writes are complete |
|
||||
|
||||
## Workflow Files
|
||||
|
||||
Workflows are markdown files with structured frontmatter - this front matter also allows them to easily work as skills and also slash command loaded:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: 'my-workflow'
|
||||
description: 'What this workflow does and when it should be used or loaded automatically (or call out if it should be requested to run explicitly by the user)'
|
||||
---
|
||||
```
|
||||
|
||||
The content in the workflow file is very minimal, sets up the reinforcement of the agent persona and reminder that it is a facilitator working with a user, lays out rules of processing steps only when told to do a specific step, loads all config file variables needed by the workflow, and then routes to step 1. No other info about other steps should be in this workflow file. Keeping it as small and lean as possible help in compilation as a skill, as overall size of the skill main file (workflow.md) is critical to keep small.
|
||||
|
||||
## Creating Custom Workflows
|
||||
|
||||
The **BMAD Builder (BMB)** module includes workflows for creating custom workflows. See [BMB Documentation](../modules/bmb-bmad-builder/) for details.
|
||||
|
||||
---
|
||||
|
||||
**Next:** Learn about [Modules](./modules.md) to see how agents and workflows are organized.
|
||||
@@ -1,449 +0,0 @@
|
||||
# Document Sharding Guide
|
||||
|
||||
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [What is Document Sharding?](#what-is-document-sharding)
|
||||
- [When to Use Sharding](#when-to-use-sharding)
|
||||
- [How Sharding Works](#how-sharding-works)
|
||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
||||
- [Workflow Support](#workflow-support)
|
||||
- [Best Practices](#best-practices)
|
||||
- [Examples](#examples)
|
||||
|
||||
## What is Document Sharding?
|
||||
|
||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
|
||||
|
||||
- **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
|
||||
|
||||
```
|
||||
Before Sharding:
|
||||
docs/
|
||||
└── PRD.md (large 50k token file)
|
||||
|
||||
After Sharding:
|
||||
docs/
|
||||
└── prd/
|
||||
├── index.md # Table of contents with descriptions
|
||||
├── overview.md # Section 1
|
||||
├── user-requirements.md # Section 2
|
||||
├── technical-requirements.md # Section 3
|
||||
└── ... # Additional sections
|
||||
```
|
||||
|
||||
## When to Use Sharding
|
||||
|
||||
### Ideal Candidates
|
||||
|
||||
**Large Multi-Epic Projects:**
|
||||
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
|
||||
**Token Thresholds:**
|
||||
|
||||
- **Consider sharding**: Documents > 20k tokens
|
||||
- **Strongly recommended**: Documents > 40k tokens
|
||||
- **Critical for efficiency**: Documents > 60k tokens
|
||||
|
||||
### When NOT to Shard
|
||||
|
||||
**Small Projects:**
|
||||
|
||||
- Single epic projects
|
||||
- Level 0-1 projects (tech-spec only)
|
||||
- Documents under 10k tokens
|
||||
- Quick prototypes
|
||||
|
||||
**Frequently Updated Docs:**
|
||||
|
||||
- Active work-in-progress documents
|
||||
- Documents updated daily
|
||||
- Documents where whole-file context is essential
|
||||
|
||||
## How Sharding Works
|
||||
|
||||
### Sharding Process
|
||||
|
||||
1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
|
||||
2. **Section Extraction**: Tool splits by level 2 headings
|
||||
3. **File Creation**: Each section becomes a separate file
|
||||
4. **Index Generation**: `index.md` created with structure and descriptions
|
||||
|
||||
### Workflow Discovery
|
||||
|
||||
BMad workflows use a **dual discovery system**:
|
||||
|
||||
1. **Try whole document first** - Look for `document-name.md`
|
||||
2. **Check for sharded version** - Look for `document-name/index.md`
|
||||
3. **Priority rule** - Whole document takes precedence if both exist
|
||||
|
||||
### Loading Strategies
|
||||
|
||||
**Full Load (Phase 1-3 workflows):**
|
||||
|
||||
```
|
||||
If sharded:
|
||||
- Read index.md
|
||||
- Read ALL section files
|
||||
- Treat as single combined document
|
||||
```
|
||||
|
||||
**Selective Load (Phase 4 workflows):**
|
||||
|
||||
```
|
||||
If sharded epics and working on Epic 3:
|
||||
- Read epics/index.md
|
||||
- Load ONLY epics/epic-3.md
|
||||
- Skip all other epic files
|
||||
- 90%+ token savings!
|
||||
```
|
||||
|
||||
## Using the Shard-Doc Tool
|
||||
|
||||
### CLI Command
|
||||
|
||||
```bash
|
||||
# Activate bmad-master or analyst agent, then:
|
||||
/shard-doc
|
||||
```
|
||||
|
||||
### Interactive Process
|
||||
|
||||
```
|
||||
Agent: Which document would you like to shard?
|
||||
User: docs/PRD.md
|
||||
|
||||
Agent: Default destination: docs/prd/
|
||||
Accept default? [y/n]
|
||||
User: y
|
||||
|
||||
Agent: Sharding PRD.md...
|
||||
✓ Created 12 section files
|
||||
✓ Generated index.md
|
||||
✓ Complete!
|
||||
```
|
||||
|
||||
### What Gets Created
|
||||
|
||||
**index.md structure:**
|
||||
|
||||
```markdown
|
||||
# PRD - Index
|
||||
|
||||
## 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
|
||||
|
||||
## Workflow Support
|
||||
|
||||
### Universal Support
|
||||
|
||||
**All BMM workflows support both formats:**
|
||||
|
||||
- ✅ Whole documents
|
||||
- ✅ Sharded documents
|
||||
- ✅ Automatic detection
|
||||
- ✅ Transparent to user
|
||||
|
||||
### Workflow-Specific Patterns
|
||||
|
||||
#### Phase 1-3 (Full Load)
|
||||
|
||||
Workflows load entire sharded documents:
|
||||
|
||||
- `product-brief` - Research, brainstorming docs
|
||||
- `prd` - Product brief, research
|
||||
- `gdd` - Game brief, research
|
||||
- `create-ux-design` - PRD, brief, architecture (if available)
|
||||
- `tech-spec` - Brief, research
|
||||
- `architecture` - PRD, UX design (if available)
|
||||
- `create-epics-and-stories` - PRD, architecture
|
||||
- `implementation-readiness` - All planning docs
|
||||
|
||||
#### Phase 4 (Selective Load)
|
||||
|
||||
Workflows load only needed sections:
|
||||
|
||||
**sprint-planning** (Full Load):
|
||||
|
||||
- Needs ALL epics to build complete status
|
||||
|
||||
**create-story, code-review** (Selective):
|
||||
|
||||
```
|
||||
Working on Epic 3, Story 2:
|
||||
✓ Load epics/epic-3.md only
|
||||
✗ Skip epics/epic-1.md, epic-2.md, epic-4.md, etc.
|
||||
|
||||
Result: 90%+ token reduction for 10-epic projects!
|
||||
```
|
||||
|
||||
### Input File Patterns
|
||||
|
||||
Workflows use standardized patterns:
|
||||
|
||||
```yaml
|
||||
input_file_patterns:
|
||||
prd:
|
||||
whole: '{output_folder}/*prd*.md'
|
||||
sharded: '{output_folder}/*prd*/index.md'
|
||||
|
||||
epics:
|
||||
whole: '{output_folder}/*epic*.md'
|
||||
sharded_index: '{output_folder}/*epic*/index.md'
|
||||
sharded_single: '{output_folder}/*epic*/epic-{{epic_num}}.md'
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Sharding Strategy
|
||||
|
||||
**Do:**
|
||||
|
||||
- ✅ Shard after planning phase complete
|
||||
- ✅ Keep level 2 headings well-organized
|
||||
- ✅ Use descriptive section names
|
||||
- ✅ Shard before Phase 4 implementation
|
||||
- ✅ Keep original file as backup initially
|
||||
|
||||
**Don't:**
|
||||
|
||||
- ❌ Shard work-in-progress documents
|
||||
- ❌ Shard small documents (<20k tokens)
|
||||
- ❌ Mix sharded and whole versions
|
||||
- ❌ Manually edit index.md structure
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
**Good Section Names:**
|
||||
|
||||
```markdown
|
||||
## Epic 1: User Authentication
|
||||
|
||||
## Technical Requirements
|
||||
|
||||
## System Architecture
|
||||
|
||||
## UX Design Principles
|
||||
```
|
||||
|
||||
**Poor Section Names:**
|
||||
|
||||
```markdown
|
||||
## Section 1
|
||||
|
||||
## Part A
|
||||
|
||||
## Details
|
||||
|
||||
## More Info
|
||||
```
|
||||
|
||||
### File Management
|
||||
|
||||
**When to Re-shard:**
|
||||
|
||||
- Significant structural changes to document
|
||||
- Adding/removing major sections
|
||||
- After major refactoring
|
||||
|
||||
**Updating Sharded Docs:**
|
||||
|
||||
1. Edit individual section files directly
|
||||
2. OR edit original, delete sharded folder, re-shard
|
||||
3. Don't manually edit index.md
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Large PRD
|
||||
|
||||
**Scenario:** 15-epic project, PRD is 45k tokens
|
||||
|
||||
**Before Sharding:**
|
||||
|
||||
```
|
||||
Every workflow loads entire 45k token PRD
|
||||
Architecture workflow: 45k tokens
|
||||
UX design workflow: 45k tokens
|
||||
```
|
||||
|
||||
**After Sharding:**
|
||||
|
||||
```bash
|
||||
/shard-doc
|
||||
Source: docs/PRD.md
|
||||
Destination: docs/prd/
|
||||
|
||||
Created:
|
||||
prd/index.md
|
||||
prd/overview.md (3k tokens)
|
||||
prd/functional-requirements.md (8k tokens)
|
||||
prd/non-functional-requirements.md (6k tokens)
|
||||
prd/user-personas.md (4k tokens)
|
||||
...additional FR/NFR sections
|
||||
```
|
||||
|
||||
**Result:**
|
||||
|
||||
```
|
||||
Architecture workflow: Can load specific sections needed
|
||||
UX design workflow: Can load specific sections needed
|
||||
Significant token reduction for large requirement docs!
|
||||
```
|
||||
|
||||
### Example 2: Sharding Epics File
|
||||
|
||||
**Scenario:** 8 epics with detailed stories, 35k tokens total
|
||||
|
||||
```bash
|
||||
/shard-doc
|
||||
Source: docs/bmm-epics.md
|
||||
Destination: docs/epics/
|
||||
|
||||
Created:
|
||||
epics/index.md
|
||||
epics/epic-1.md
|
||||
epics/epic-2.md
|
||||
...
|
||||
epics/epic-8.md
|
||||
```
|
||||
|
||||
**Efficiency Gain:**
|
||||
|
||||
```
|
||||
Working on Epic 5 stories:
|
||||
Old: Load all 8 epics (35k tokens)
|
||||
New: Load epic-5.md only (4k tokens)
|
||||
Savings: 88% reduction
|
||||
```
|
||||
|
||||
### Example 3: Architecture Document
|
||||
|
||||
**Scenario:** Multi-layer system architecture, 28k tokens
|
||||
|
||||
```bash
|
||||
/shard-doc
|
||||
Source: docs/architecture.md
|
||||
Destination: docs/architecture/
|
||||
|
||||
Created:
|
||||
architecture/index.md
|
||||
architecture/system-overview.md
|
||||
architecture/frontend-architecture.md
|
||||
architecture/backend-services.md
|
||||
architecture/data-layer.md
|
||||
architecture/infrastructure.md
|
||||
architecture/security-architecture.md
|
||||
```
|
||||
|
||||
**Benefit:** Code-review workflow can reference specific architectural layers without loading entire architecture doc.
|
||||
|
||||
## Custom Workflow Integration
|
||||
|
||||
### For Workflow Builders
|
||||
|
||||
When creating custom workflows that load large documents:
|
||||
|
||||
**1. Add input_file_patterns to workflow.yaml:**
|
||||
|
||||
```yaml
|
||||
input_file_patterns:
|
||||
your_document:
|
||||
whole: '{output_folder}/*your-doc*.md'
|
||||
sharded: '{output_folder}/*your-doc*/index.md'
|
||||
```
|
||||
|
||||
**2. Add discovery instructions to instructions.md:**
|
||||
|
||||
```markdown
|
||||
## Document Discovery
|
||||
|
||||
1. Search for whole document: _your-doc_.md
|
||||
2. Check for sharded version: _your-doc_/index.md
|
||||
3. If sharded: Read index + ALL sections (or specific sections if selective load)
|
||||
4. Priority: Whole document first
|
||||
```
|
||||
|
||||
**3. Choose loading strategy:**
|
||||
|
||||
- **Full Load**: Read all sections when sharded
|
||||
- **Selective Load**: Read only relevant sections (requires section identification logic)
|
||||
|
||||
### Pattern Templates
|
||||
|
||||
**Full Load Pattern:**
|
||||
|
||||
```xml
|
||||
<action>Search for document: {output_folder}/*doc-name*.md</action>
|
||||
<action>If not found, check for sharded: {output_folder}/*doc-name*/index.md</action>
|
||||
<action if="sharded found">Read index.md to understand structure</action>
|
||||
<action if="sharded found">Read ALL section files listed in index</action>
|
||||
<action if="sharded found">Combine content as single document</action>
|
||||
```
|
||||
|
||||
**Selective Load Pattern (with section ID):**
|
||||
|
||||
```xml
|
||||
<action>Determine section needed (e.g., epic_num = 3)</action>
|
||||
<action>Check for sharded version: {output_folder}/*doc-name*/index.md</action>
|
||||
<action if="sharded found">Read ONLY the specific section file needed</action>
|
||||
<action if="sharded found">Skip all other section files</action>
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**Both whole and sharded exist:**
|
||||
|
||||
- Workflows will use whole document (priority rule)
|
||||
- Delete or archive the one you don't want
|
||||
|
||||
**Index.md out of sync:**
|
||||
|
||||
- Delete sharded folder
|
||||
- Re-run shard-doc on original
|
||||
|
||||
**Workflow can't find document:**
|
||||
|
||||
- Check file naming matches patterns (`*prd*.md`, `*epic*.md`, etc.)
|
||||
- Verify index.md exists in sharded folder
|
||||
- Check output_folder path in config
|
||||
|
||||
**Sections too granular:**
|
||||
|
||||
- Combine sections in original document
|
||||
- Use fewer level 2 headings
|
||||
- Re-shard
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation
|
||||
- [BMM Workflows Guide](./modules/bmm/index.md#-workflow-guides) - Workflow overview
|
||||
- [Workflow Creation Guide](./modules/bmb/workflows/index) - Custom workflow patterns
|
||||
|
||||
---
|
||||
|
||||
**Document sharding is optional but powerful** - use it when efficiency matters for large projects!
|
||||
@@ -1,76 +0,0 @@
|
||||
# Installation
|
||||
|
||||
Get BMAD Method running in your project in under 2 minutes.
|
||||
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
This interactive installer will:
|
||||
|
||||
1. Detect your IDE (Claude Code, Cursor, VS Code, etc.)
|
||||
2. Let you choose which modules to install
|
||||
3. Configure agents and workflows for your project
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Node.js** 18+ (for the installer)
|
||||
- **Git** (recommended for version control)
|
||||
- An **AI-powered IDE** or access to Claude/ChatGPT/Gemini
|
||||
|
||||
## Module Options
|
||||
|
||||
During installation, you'll choose which modules to install:
|
||||
|
||||
| Module | Description | Best For |
|
||||
| -------- | ---------------- | ---------------------------------------- |
|
||||
| **BMM** | BMAD Method Core | Software development projects |
|
||||
| **BMGD** | Game Development | Game projects with specialized workflows |
|
||||
| **BMB** | Builder | Creating custom agents and workflows |
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMAD configuration and agents
|
||||
│ ├── bmm/ # Method module (if installed)
|
||||
│ ├── bmgd/ # Game dev module (if installed)
|
||||
│ └── config.yaml # Your project configuration
|
||||
├── .claude/ # IDE-specific setup (varies by IDE)
|
||||
└── ... your code
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature
|
||||
2. **Check your [IDE Guide](../ide-info/index.md)** for IDE-specific tips
|
||||
3. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology
|
||||
|
||||
## Alternative: Web Bundles
|
||||
|
||||
Don't want to install? Use BMAD agents directly in:
|
||||
|
||||
- **Claude Projects** - Upload the web bundle
|
||||
- **ChatGPT** - Use custom GPT bundles
|
||||
- **Gemini** - Import agent prompts
|
||||
|
||||
See the [Web Bundles Guide](../web-bundles-gemini-gpt-guide.md) for details.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**"Command not found: npx"**
|
||||
: Install Node.js 18+ from [nodejs.org](https://nodejs.org)
|
||||
|
||||
**"Permission denied"**
|
||||
: Run with appropriate permissions or check your npm configuration
|
||||
|
||||
**IDE not detected**
|
||||
: The installer will prompt you to select your IDE manually
|
||||
|
||||
For more help, see [Troubleshooting](../modules/bmm/troubleshooting.md) or join our [Discord](https://discord.gg/bmad).
|
||||
@@ -1,31 +0,0 @@
|
||||
# BMAD Method - Auggie CLI Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents can be installed in multiple locations based on your setup.
|
||||
|
||||
### Common Locations
|
||||
|
||||
- User Home: `~/.augment/commands/`
|
||||
- Project: `.augment/commands/`
|
||||
- Custom paths you selected
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `@{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates
|
||||
3. **Tasks**: Use `@task-{task-name}` for tasks
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@dev - Activate development agent
|
||||
@architect - Activate architect agent
|
||||
@task-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Agents can be in multiple locations
|
||||
- Check your installation paths
|
||||
- Activation syntax same across all locations
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Claude Code Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as slash commands in `.claude/commands/bmad/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Slash Command**: Start with `/` to see available commands
|
||||
2. **Select Agent**: Type `/bmad-{agent-name}` (e.g., `/bmad-dev`)
|
||||
3. **Execute**: Press Enter to activate that agent persona
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/bmad:bmm:agents:dev - Activate development agent
|
||||
/bmad:bmm:agents:architect - Activate architect agent
|
||||
/bmad:bmm:workflows:dev-story - Execute dev-story workflow
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Commands are autocompleted when you type `/`
|
||||
- Agent remains active for the conversation
|
||||
- Start a new conversation to switch agents
|
||||
@@ -1,31 +0,0 @@
|
||||
# BMAD Method - Cline Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as **toggleable rules** in `.clinerules/` directory.
|
||||
|
||||
### Important: Rules are OFF by default
|
||||
|
||||
- Rules are NOT automatically loaded to avoid context pollution
|
||||
- You must manually enable the agent you want to use
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Rules Panel**: Click the rules icon below the chat input
|
||||
2. **Enable an Agent**: Toggle ON the specific agent rule you need (e.g., `01-core-dev`)
|
||||
3. **Activate in Chat**: Type `@{agent-name}` to activate that persona
|
||||
4. **Disable When Done**: Toggle OFF to free up context
|
||||
|
||||
### Best Practices
|
||||
|
||||
- Only enable 1-2 agents at a time to preserve context
|
||||
- Disable agents when switching tasks
|
||||
- Rules are numbered (01-, 02-) for organization, not priority
|
||||
|
||||
### Example
|
||||
|
||||
```
|
||||
Toggle ON: 01-core-dev.md
|
||||
In chat: "@dev help me refactor this code"
|
||||
When done: Toggle OFF the rule
|
||||
```
|
||||
@@ -1,21 +0,0 @@
|
||||
# BMAD Method - Codex Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents, tasks and workflows are installed as custom prompts in
|
||||
`$CODEX_HOME/prompts/bmad-*.md` files. If `CODEX_HOME` is not set, it
|
||||
defaults to `$HOME/.codex/`.
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/bmad-bmm-agents-dev - Activate development agent
|
||||
/bmad-bmm-agents-architect - Activate architect agent
|
||||
/bmad-bmm-workflows-dev-story - Execute dev-story workflow
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
Prompts are autocompleted when you type /
|
||||
Agent remains active for the conversation
|
||||
Start a new conversation to switch agents
|
||||
@@ -1,30 +0,0 @@
|
||||
# BMAD Method - Crush Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as commands in `.crush/commands/bmad/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Command Palette**: Use Crush command interface
|
||||
2. **Navigate**: Browse to `_bmad/{module}/agents/`
|
||||
3. **Select Agent**: Choose the agent command
|
||||
4. **Execute**: Run to activate agent persona
|
||||
|
||||
### Command Structure
|
||||
|
||||
```
|
||||
.crush/commands/bmad/
|
||||
├── agents/ # All agents
|
||||
├── tasks/ # All tasks
|
||||
├── core/ # Core module
|
||||
│ ├── agents/
|
||||
│ └── tasks/
|
||||
└── {module}/ # Other modules
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Commands organized by module
|
||||
- Can browse hierarchically
|
||||
- Agent activates for session
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Cursor Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed in `.cursor/rules/bmad/` as MDC rules.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Reference in Chat**: Use `@_bmad/{module}/agents/{agent-name}`
|
||||
2. **Include Entire Module**: Use `@_bmad/{module}`
|
||||
3. **Reference Index**: Use `@_bmad/index` for all available agents
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@_bmad/core/agents/dev - Activate dev agent
|
||||
@_bmad/bmm/agents/architect - Activate architect agent
|
||||
@_bmad/core - Include all core agents/tasks
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Rules are Manual type - only loaded when explicitly referenced
|
||||
- No automatic context pollution
|
||||
- Can combine multiple agents: `@_bmad/core/agents/dev @_bmad/core/agents/test`
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Gemini CLI Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are concatenated in `.gemini/bmad-method/GEMINI.md`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `*{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates from the concatenated file
|
||||
3. **Continue**: Agent remains active for conversation
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
*dev - Activate development agent
|
||||
*architect - Activate architect agent
|
||||
*test - Activate test agent
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- All agents loaded from single GEMINI.md file
|
||||
- Triggers with asterisk: `*{agent-name}`
|
||||
- Context includes all agents (may be large)
|
||||
@@ -1,26 +0,0 @@
|
||||
# BMAD Method - GitHub Copilot Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as chat modes in `.github/chatmodes/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Chat View**: Click Copilot icon in VS Code sidebar
|
||||
2. **Select Mode**: Click mode selector (top of chat)
|
||||
3. **Choose Agent**: Select the BMAD agent from dropdown
|
||||
4. **Chat**: Agent is now active for this session
|
||||
|
||||
### VS Code Settings
|
||||
|
||||
Configured in `.vscode/settings.json`:
|
||||
|
||||
- Max requests per session
|
||||
- Auto-fix enabled
|
||||
- MCP discovery enabled
|
||||
|
||||
### Notes
|
||||
|
||||
- Modes persist for the chat session
|
||||
- Switch modes anytime via dropdown
|
||||
- Multiple agents available in mode selector
|
||||
@@ -1,33 +0,0 @@
|
||||
# BMAD Method - iFlow CLI Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as commands in `.iflow/commands/bmad/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Access Commands**: Use iFlow command interface
|
||||
2. **Navigate**: Browse to `_bmad/agents/` or `_bmad/tasks/`
|
||||
3. **Select**: Choose the agent or task command
|
||||
4. **Execute**: Run to activate
|
||||
|
||||
### Command Structure
|
||||
|
||||
```
|
||||
.iflow/commands/bmad/
|
||||
├── agents/ # Agent commands
|
||||
└── tasks/ # Task commands
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/_bmad/agents/core-dev - Activate dev agent
|
||||
/_bmad/tasks/core-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Commands organized by type (agents/tasks)
|
||||
- Agent activates for session
|
||||
- Similar to Crush command structure
|
||||
@@ -1,24 +0,0 @@
|
||||
# IDE Guides
|
||||
|
||||
BMAD Method works with any AI-powered development environment. Choose your IDE below for specific setup instructions and tips.
|
||||
|
||||
## All Supported IDEs
|
||||
|
||||
| IDE | Type | BMAD Support |
|
||||
| ----------------------------------- | ----------------- | --------------------- |
|
||||
| [Claude Code](claude-code.md) | CLI/Terminal | Native slash commands |
|
||||
| [Cursor](cursor.md) | Desktop Editor | Full agent support |
|
||||
| [VS Code / Windsurf](windsurf.md) | Desktop Editor | Extension-based |
|
||||
| [Cline](cline.md) | VS Code Extension | Full support |
|
||||
| [GitHub Copilot](github-copilot.md) | Extension | Workspace agents |
|
||||
| [Augment](auggie.md) | Extension | Agent loading |
|
||||
| [Codex](codex.md) | CLI | Prompt injection |
|
||||
| [Gemini](gemini.md) | Web/API | Web bundles |
|
||||
| [Roo](roo.md) | VS Code Extension | Mode support |
|
||||
| [Kilo](kilo.md) | Extension | Basic support |
|
||||
| [OpenCode](opencode.md) | Open Source | Full support |
|
||||
| [Qwen](qwen.md) | Web/API | Web bundles |
|
||||
| [Trae](trae.md) | Extension | Basic support |
|
||||
| [Crush](crush.md) | Desktop | Agent support |
|
||||
| [iFlow](iflow.md) | Extension | Prompt loading |
|
||||
| [Rovo Dev](rovo-dev.md) | Atlassian | Integration |
|
||||
@@ -1,24 +0,0 @@
|
||||
# BMAD Method - KiloCode Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as custom modes in `.kilocodemodes`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Project**: Modes auto-load when project opens
|
||||
2. **Select Mode**: Use mode selector in KiloCode interface
|
||||
3. **Choose Agent**: Pick `bmad-{module}-{agent}` mode
|
||||
4. **Activate**: Mode is now active
|
||||
|
||||
### Mode Format
|
||||
|
||||
- Mode name: `bmad-{module}-{agent}`
|
||||
- Display: `{icon} {title}`
|
||||
- Example: `bmad-core-dev` shows as `🤖 Dev`
|
||||
|
||||
### Notes
|
||||
|
||||
- Modes persist until changed
|
||||
- Similar to Roo Code mode system
|
||||
- Icon shows in mode selector
|
||||
@@ -1,24 +0,0 @@
|
||||
# BMAD Method - OpenCode Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as OpenCode agents in `.opencode/agent/BMAD/{module_name}` and workflow commands in `.opencode/command/BMAD/{module_name}`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Switch Agents**: Press **Tab** to cycle through primary agents or select using the `/agents`
|
||||
2. **Activate Agent**: Once the Agent is selected say `hello` or any prompt to activate that agent persona
|
||||
3. **Execute Commands**: Type `/bmad` to see and execute bmad workflow commands (commands allow for fuzzy matching)
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
/agents - to see a list of agents and switch between them
|
||||
/_bmad/bmm/workflows/workflow-init - Activate the workflow-init command
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Press **Tab** to switch between primary agents (Analyst, Architect, Dev, etc.)
|
||||
- Commands are autocompleted when you type `/` and allow for fuzzy matching
|
||||
- Workflow commands execute in current agent context, make sure you have the right agent activated before running a command
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Qwen Code Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are concatenated in `.qwen/bmad-method/QWEN.md`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `*{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates from the concatenated file
|
||||
3. **Continue**: Agent remains active for conversation
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
*dev - Activate development agent
|
||||
*architect - Activate architect agent
|
||||
*test - Activate test agent
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- All agents loaded from single QWEN.md file
|
||||
- Triggers with asterisk: `*{agent-name}`
|
||||
- Similar to Gemini CLI setup
|
||||
@@ -1,27 +0,0 @@
|
||||
# BMAD Method - Roo Code Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as custom modes in `.roomodes`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Project**: Modes auto-load when project opens
|
||||
2. **Select Mode**: Use mode selector in Roo interface
|
||||
3. **Choose Agent**: Pick `bmad-{module}-{agent}` mode
|
||||
4. **Activate**: Mode is now active with configured permissions
|
||||
|
||||
### Permission Levels
|
||||
|
||||
Modes are configured with file edit permissions:
|
||||
|
||||
- Development files only
|
||||
- Configuration files only
|
||||
- Documentation files only
|
||||
- All files (if configured)
|
||||
|
||||
### Notes
|
||||
|
||||
- Modes persist until changed
|
||||
- Each mode has specific file access rights
|
||||
- Icon shows in mode selector for easy identification
|
||||
@@ -1,22 +0,0 @@
|
||||
# BMAD Method - Rovo Dev Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as subagents in `.rovodev/subagents/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Project**: Subagents auto-load when project opens
|
||||
2. **Invoke Agent**: Type `@` and select agent (e.g., `@bmad-bmm-dev`, `@bmad-bmm-architect`)
|
||||
3. **Reference Files**: Check `.rovodev/workflows/` and `.rovodev/references/`
|
||||
|
||||
### Directory Structure
|
||||
|
||||
- `.rovodev/subagents/` - BMAD agents
|
||||
- `.rovodev/workflows/` - Workflow guides
|
||||
- `.rovodev/references/` - Tasks and tools
|
||||
|
||||
### Notes
|
||||
|
||||
- Agents are automatically discovered by Rovo Dev
|
||||
- Subagents use YAML frontmatter for configuration
|
||||
@@ -1,25 +0,0 @@
|
||||
# BMAD Method - Trae Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as rules in `.trae/rules/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Type Trigger**: Use `@{agent-name}` in your prompt
|
||||
2. **Activate**: Agent persona activates automatically
|
||||
3. **Continue**: Agent remains active for conversation
|
||||
|
||||
### Examples
|
||||
|
||||
```
|
||||
@dev - Activate development agent
|
||||
@architect - Activate architect agent
|
||||
@task-setup - Execute setup task
|
||||
```
|
||||
|
||||
### Notes
|
||||
|
||||
- Rules auto-load from `.trae/rules/` directory
|
||||
- Multiple agents can be referenced: `@dev and @test`
|
||||
- Agent follows YAML configuration in rule file
|
||||
@@ -1,22 +0,0 @@
|
||||
# BMAD Method - Windsurf Instructions
|
||||
|
||||
## Activating Agents
|
||||
|
||||
BMAD agents are installed as workflows in `.windsurf/workflows/`.
|
||||
|
||||
### How to Use
|
||||
|
||||
1. **Open Workflows**: Access via Windsurf menu or command palette
|
||||
2. **Select Workflow**: Choose the agent/task workflow
|
||||
3. **Execute**: Run to activate that agent persona
|
||||
|
||||
### Workflow Types
|
||||
|
||||
- **Agent workflows**: `{module}-{agent}.md` (auto_execution_mode: 3)
|
||||
- **Task workflows**: `task-{module}-{task}.md` (auto_execution_mode: 2)
|
||||
|
||||
### Notes
|
||||
|
||||
- Agents run with higher autonomy (mode 3)
|
||||
- Tasks run with guided execution (mode 2)
|
||||
- Workflows persist for the session
|
||||
162
docs/index.md
162
docs/index.md
@@ -1,143 +1,111 @@
|
||||
# BMad Documentation Index
|
||||
# BMAD Documentation
|
||||
|
||||
Complete map of all BMad Method v6 documentation with recommended reading paths.
|
||||
Complete documentation for the BMAD Method.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### New to BMAD?
|
||||
Start with the core concepts to understand how BMAD works:
|
||||
|
||||
- **[Core Concepts](./bmad-core-concepts/)** - Agents, workflows, and modules explained
|
||||
- **[Installation Guide](./bmad-core-concepts/installing/)** - Set up BMAD in your project
|
||||
- **[Quick Start Guide](./modules/bmm-bmad-method/quick-start)** - Build your first feature
|
||||
|
||||
### Upgrading from v4?
|
||||
- **[v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md)** - Migration path for v4 users
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Getting Started (Start Here!)
|
||||
## Module Documentation
|
||||
|
||||
**New users:** Start with one of these based on your situation:
|
||||
|
||||
| Your Situation | Start Here | Then Read |
|
||||
| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| **Brand new to BMad** | [Quick Start Guide](./modules/bmm/quick-start) | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) |
|
||||
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](./modules/bmm/quick-start) |
|
||||
| **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start) |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Core Documentation
|
||||
|
||||
### Project-Level Docs (Root)
|
||||
|
||||
- **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions
|
||||
- **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
|
||||
- **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes
|
||||
|
||||
### 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
|
||||
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Module Documentation
|
||||
|
||||
### BMad Method (BMM) - Software & Game Development
|
||||
### BMAD Method (BMM) - Software & Game Development
|
||||
|
||||
The flagship module for agile AI-driven development.
|
||||
|
||||
- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
|
||||
- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
|
||||
- [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
|
||||
- [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
|
||||
- [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
|
||||
- [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
|
||||
- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
|
||||
- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance
|
||||
- **[BMM Module Index](./modules/bmm-bmad-method/index)** - Module overview, agents, and documentation
|
||||
- [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Step-by-step guide
|
||||
- [Quick Spec Flow](./modules/bmm-bmad-method/quick-spec-flow) - Rapid Level 0-1 development
|
||||
- [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Working with existing codebases
|
||||
- **[BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides)** - Essential reading
|
||||
|
||||
### BMad Builder (BMB) - Create Custom Solutions
|
||||
### BMAD Builder (BMB) - Create Custom Solutions
|
||||
|
||||
Build your own agents, workflows, and modules.
|
||||
|
||||
- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents
|
||||
- **[BMB Module Overview](./modules/bmb-bmad-builder/index)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](./modules/bmb-bmad-builder/agent-creation-guide.md)** - Create custom agents
|
||||
- **[Custom Content Installation](./modules/bmb-bmad-builder/custom-content-installation.md)** - Share and install custom creations
|
||||
|
||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||
|
||||
AI-powered creative thinking and brainstorming.
|
||||
- **[CIS Documentation](./modules/cis-creative-intelligence-suite/index)**
|
||||
|
||||
- **[CIS Module README](./modules/cis/)** - Module overview and workflows
|
||||
### BMAD Game Dev (BMGD)
|
||||
|
||||
- **[BMGD Documentation](./modules/bmgd-bmad-game-dev/index)** - Game development workflows
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ IDE-Specific Guides
|
||||
## Core Module
|
||||
|
||||
Instructions for loading agents and running workflows in your development environment.
|
||||
### Global Core Entities
|
||||
|
||||
**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)
|
||||
- [Rovo Dev](./ide-info/rovo-dev.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.
|
||||
- **[Core Module Index](./modules/core/index)** - Shared functionality available to all modules
|
||||
- [Global Core Config](./modules/core/global-core-config.md) - Inheritable configuration
|
||||
- [Core Workflows](./modules/core/core-workflows.md) - Domain-agnostic workflows
|
||||
- [Party Mode](./modules/core/party-mode.md) - Multi-agent conversations
|
||||
- [Brainstorming](./modules/core/brainstorming.md) - Structured creative sessions
|
||||
- [Advanced Elicitation](./modules/core/advanced-elicitation.md) - LLM reasoning techniques
|
||||
- [Core Tasks](./modules/core/core-tasks.md) - Common tasks across modules
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Advanced Topics
|
||||
## Advanced Topics
|
||||
|
||||
### Custom Agents, Workflow and Modules
|
||||
### Customization
|
||||
|
||||
- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
|
||||
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
|
||||
- **[BMAD Customization](./bmad-core-concepts/bmad-customization/)** - Modify agents and workflows
|
||||
|
||||
### Platform Guides
|
||||
|
||||
- **[Web Bundles](./bmad-core-concepts/web-bundles/)** - Use BMAD in Gemini Gems and Custom GPTs
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Recommended Reading Paths
|
||||
## Recommended Reading Paths
|
||||
|
||||
### Path 1: Brand New to BMad (Software Project)
|
||||
### Path 1: Brand New to BMAD (Software Project)
|
||||
|
||||
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
||||
3. [BMM Module README](./modules/bmm/) - Understand agents
|
||||
4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
||||
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
||||
1. [Core Concepts](./bmad-core-concepts/) - Understand agents and workflows
|
||||
2. [Installation Guide](./bmad-core-concepts/installing/) - Set up BMAD
|
||||
3. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Get hands-on
|
||||
4. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
||||
|
||||
### Path 2: Game Development Project
|
||||
|
||||
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
||||
3. [BMM Module README](./modules/bmm/) - Game agents are included
|
||||
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
|
||||
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
||||
1. [Core Concepts](./bmad-core-concepts/) - Understand agents and workflows
|
||||
2. [Installation Guide](./bmad-core-concepts/installing/) - Set up BMAD
|
||||
3. [BMGD Workflows Guide](./modules/bmgd-bmad-game-dev/workflows-guide) - Game-specific workflows
|
||||
|
||||
### Path 3: Upgrading from v4
|
||||
|
||||
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
|
||||
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows
|
||||
1. [v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md) - Understand what changed
|
||||
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Reorient yourself
|
||||
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Learn new v6 workflows
|
||||
|
||||
### Path 4: Working with Existing Codebase (Brownfield)
|
||||
|
||||
1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
|
||||
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
||||
1. [Brownfield Guide](./modules/bmm-bmad-method/brownfield-guide) - Approach for legacy code
|
||||
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Follow the process
|
||||
3. [BMM Workflows Guide](./modules/bmm-bmad-method/index#-workflow-guides) - Master the methodology
|
||||
|
||||
### Path 5: Building Custom Solutions
|
||||
### Path 5: Building Custom Agents
|
||||
|
||||
1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
|
||||
2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
|
||||
3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure
|
||||
1. [Core Concepts: Agents](./bmad-core-concepts/agents.md) - Understand Simple vs Expert
|
||||
2. [Agent Creation Guide](./modules/bmb-bmad-builder/agent-creation-guide.md) - Build your first agent
|
||||
3. [Agent Architecture](./modules/bmb-bmad-builder/index) - Deep technical details
|
||||
|
||||
### Path 6: Contributing to BMad
|
||||
### Path 6: Contributing to BMAD
|
||||
|
||||
1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
|
||||
2. Relevant module README - Understand the area you're contributing to
|
||||
|
||||
166
docs/modules/bmb-bmad-builder/agent-creation-guide.md
Normal file
166
docs/modules/bmb-bmad-builder/agent-creation-guide.md
Normal file
@@ -0,0 +1,166 @@
|
||||
# Agent Creation Guide
|
||||
|
||||
Create your own custom agents using the BMAD Builder workflow.
|
||||
|
||||
## Overview
|
||||
|
||||
The BMAD Builder (BMB) module provides an interactive workflow that guides you through creating a custom agent from concept to completion. You define the agent's purpose, personality, capabilities, and menu - then the workflow generates a complete, ready-to-use agent file.
|
||||
|
||||
## Before You Start
|
||||
|
||||
**Prerequisites:**
|
||||
- BMAD installed with the BMB module
|
||||
- An idea for what you want your agent to do
|
||||
- About 15-30 minutes for your first agent
|
||||
|
||||
**Know Before You Go:**
|
||||
- What problem should your agent solve?
|
||||
- Who will use this agent?
|
||||
- What should the agent be able to do?
|
||||
|
||||
## Quick Start
|
||||
|
||||
### 1. Start the Workflow
|
||||
|
||||
In your IDE (Claude Code, Cursor, etc.), invoke the create-agent workflow:
|
||||
|
||||
```
|
||||
"Run the BMAD Builder create-agent workflow"
|
||||
```
|
||||
|
||||
Or trigger it via the BMAD Master menu.
|
||||
|
||||
### 2. Follow the Steps
|
||||
|
||||
The workflow guides you through:
|
||||
|
||||
| Step | What You'll Do |
|
||||
|------|----------------|
|
||||
| **Brainstorm** (optional) | Explore ideas with creative techniques |
|
||||
| **Discovery** | Define the agent's purpose and goals |
|
||||
| **Type & Metadata** | Choose Simple or Expert, name your agent |
|
||||
| **Persona** | Craft the agent's personality and principles |
|
||||
| **Commands** | Define what the agent can do |
|
||||
| **Activation** | Set up autonomous behaviors (optional) |
|
||||
| **Build** | Generate the agent file |
|
||||
| **Validation** | Review and verify everything works |
|
||||
|
||||
### 3. Install Your Agent
|
||||
|
||||
Once created, package your agent for installation:
|
||||
|
||||
```
|
||||
my-custom-stuff/
|
||||
├── module.yaml # Contains: unitary: true
|
||||
├── agents/
|
||||
│ └── {agent-name}/
|
||||
│ ├── {agent-name}.agent.yaml
|
||||
│ └── _memory/ # Expert agents only
|
||||
│ └── {sidecar-folder}/
|
||||
└── workflows/ # Optional: custom workflows
|
||||
```
|
||||
|
||||
See [Custom Content Installation](./custom-content-installation.md) for details.
|
||||
|
||||
## Choosing Your Agent Type
|
||||
|
||||
The workflow will help you decide, but here's the quick reference:
|
||||
|
||||
### Choose Simple Agent When:
|
||||
|
||||
- Task is well-defined and focused
|
||||
- Don't need persistent memory
|
||||
- Want fast setup and deployment
|
||||
- Single-purpose assistant (e.g., commit messages, code review)
|
||||
|
||||
**Example:** A "Code Commenter" that reads files and adds helpful comments.
|
||||
|
||||
### Choose Expert Agent When:
|
||||
|
||||
- Domain requires specialized knowledge
|
||||
- Need persistent memory across sessions
|
||||
- Agent coordinates complex workflows
|
||||
- Building ongoing project infrastructure
|
||||
|
||||
**Example:** A "Security Architect" that remembers your design decisions and maintains security standards across the project.
|
||||
|
||||
### Choose Module Agent When:
|
||||
|
||||
- Agent builds other agents or workflows
|
||||
- Need integration with module system
|
||||
- Creating professional tooling
|
||||
|
||||
**Example:** A "Team Builder" that helps set up agents for new team members.
|
||||
|
||||
## The Persona System
|
||||
|
||||
Your agent's personality is defined by four fields:
|
||||
|
||||
| Field | Purpose | Example |
|
||||
|-------|---------|---------|
|
||||
| **Role** | What they do | "Senior code reviewer who catches bugs and suggests improvements" |
|
||||
| **Identity** | Who they are | "Friendly but exacting, believes clean code is a craft" |
|
||||
| **Communication Style** | How they speak | "Direct, constructive, explains the 'why' behind suggestions" |
|
||||
| **Principles** | Why they act | "Security first, clarity over cleverness, test what you fix" |
|
||||
|
||||
**Key:** Keep each field focused on its purpose. The role isn't personality; the identity isn't job description.
|
||||
|
||||
## Tips for Success
|
||||
|
||||
### Start Small
|
||||
|
||||
Your first agent should solve **one problem well**. You can always add more capabilities later.
|
||||
|
||||
### Learn by Example
|
||||
|
||||
Study the reference agents in `src/modules/bmb/reference/agents/`:
|
||||
- **Simple:** [commit-poet](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)
|
||||
- **Expert:** [journal-keeper](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper)
|
||||
|
||||
### Write Great Principles
|
||||
|
||||
The first principle should "activate" the agent's expertise:
|
||||
|
||||
❌ **Weak:** "Be helpful and accurate"
|
||||
✅ **Strong:** "Channel decades of security expertise: threat modeling begins with trust boundaries, never trust client input, defense in depth is non-negotiable"
|
||||
|
||||
### Use the Menu System
|
||||
|
||||
The workflow provides options at each step:
|
||||
- **[A] Advanced** - Get deeper insights and reasoning
|
||||
- **[P] Party** - Get multiple agent perspectives
|
||||
- **[C] Continue** - Move to the next step
|
||||
|
||||
Use these when you need extra input or creative options.
|
||||
|
||||
## After Creation
|
||||
|
||||
### Test Your Agent
|
||||
|
||||
1. Install your custom module using the BMAD installer
|
||||
2. Invoke your new agent in your IDE
|
||||
3. Try each menu command
|
||||
4. Verify the personality feels right
|
||||
|
||||
### Iterate
|
||||
|
||||
If something isn't right:
|
||||
1. Edit the agent YAML directly, or
|
||||
2. Edit the customization file in `_bmad/_config/agents/`
|
||||
3. Rebuild using `npx bmad-method build <agent-name>`
|
||||
|
||||
### Share
|
||||
|
||||
Package your agent as a standalone module (see [Installation Guide](../../bmad-core-concepts/installing/)) and share it with your team or the community.
|
||||
|
||||
## Further Reading
|
||||
|
||||
- **[Agent Architecture](./index.md)** - Deep technical details on agent types
|
||||
- **[Agent Customization](../../bmad-core-concepts/agent-customization/)** - Modify agents without editing core files
|
||||
- **[Custom Content Installation](./custom-content-installation.md)** - Package and distribute your agents
|
||||
|
||||
---
|
||||
|
||||
**Ready?** Start the workflow and create your first agent!
|
||||
|
||||
[← Back to BMB Documentation](./index.md)
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams.
|
||||
|
||||
For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
|
||||
For detailed information about the different types of custom content available, see [Custom Content](modules/bmb-bmad-builder/custom-content.md).
|
||||
|
||||
You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
|
||||
|
||||
@@ -26,10 +26,8 @@ To create an installable custom module:
|
||||
- Create a folder with a short, abbreviated name (e.g., `cis` for Creative Intelligence Suite)
|
||||
- The folder name serves as the module code
|
||||
|
||||
2. **Required Files**
|
||||
- Include a `module.yaml` file in the root folder
|
||||
- This file drives the installation process when used by the BMAD installer
|
||||
- Reference existing modules or the BMad Builder for configuration examples
|
||||
2. **Required File**
|
||||
- Include a `module.yaml` file in the root folder (this drives questions for the final generated config.yaml at install target)
|
||||
|
||||
3. **Folder Organization**
|
||||
Follow these conventions for optimal compatibility:
|
||||
@@ -56,8 +54,10 @@ For standalone content that isn't part of a cohesive module collection, follow t
|
||||
|
||||
1. **Module Configuration**
|
||||
- Create a folder with a `module.yaml` file (similar to custom modules)
|
||||
- Add the property `unitary: true` to the module.yaml
|
||||
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
||||
- Add the property `unitary: true` in the module.yaml
|
||||
- The `unitary: true` property indicates this is a collection of potentially unrelated items that don't depend on each other
|
||||
- Any content you add to this folder should still be nested under workflows and agents - but the key with stand alone content is they do not rely on each other.
|
||||
- Agents do not reference other workflows even if stored in a unitary:true module. But unitary Agents can have their own workflows in their sidecar, or reference workflows as requirements from other modules - with a process known as workflow vendoring. Keep in mind, this will require that the workflow referenced from the other module would need to be available for the end user to install, so its recommended to only vendor workflows from the core module, or official bmm modules (See [Workflow Vendoring, Customization, and Inheritance](workflow-vendoring-customization-inheritance.md)).
|
||||
|
||||
2. **Folder Structure**
|
||||
Organize content in specific named folders:
|
||||
@@ -1,6 +1,6 @@
|
||||
# Custom Content
|
||||
|
||||
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agent provides workflows and expertise to plan and build any custom content you can imagine.
|
||||
BMAD supports several categories of officially supported custom content that extend the platform's capabilities. Custom content can be created manually or with the recommended assistance of the BMad Builder (BoMB) Module. The BoMB Agents provides workflows and expertise to plan and build any custom content you can imagine.
|
||||
|
||||
This flexibility transforms the platform beyond its current capabilities, enabling:
|
||||
|
||||
@@ -21,7 +21,7 @@ This flexibility transforms the platform beyond its current capabilities, enabli
|
||||
- [Custom Global Modules](#custom-global-modules)
|
||||
- [Custom Agents](#custom-agents)
|
||||
- [BMad Tiny Agents](#bmad-tiny-agents)
|
||||
- [Simple vs Expert Agents](#simple-vs-expert-agents)
|
||||
- [Simple and Expert Agents](#simple-and-expert-agents)
|
||||
- [Custom Workflows](#custom-workflows)
|
||||
|
||||
## Custom Stand Alone Modules
|
||||
@@ -57,7 +57,7 @@ Similar to Custom Stand Alone Modules, but designed to add functionality that ap
|
||||
|
||||
Examples include:
|
||||
|
||||
- The current TTS (Text-to-Speech) functionality for Claude, which will be rebuilt as a global module
|
||||
- The current TTS (Text-to-Speech) functionality for Claude, which will soon be converted to a global module
|
||||
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
|
||||
- Installation and update tools that work with any BMAD method configuration
|
||||
|
||||
@@ -81,7 +81,7 @@ Personal agents designed for highly specific needs that may not be suitable for
|
||||
|
||||
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
|
||||
|
||||
### Simple vs Expert Agents
|
||||
### Simple and Expert Agents
|
||||
|
||||
The distinction between simple and expert agents lies in their structure:
|
||||
|
||||
@@ -89,7 +89,6 @@ The distinction between simple and expert agents lies in their structure:
|
||||
|
||||
- Single file containing all prompts and configuration
|
||||
- Self-contained and straightforward
|
||||
- has metadata type: simple
|
||||
|
||||
**Expert Agent:**
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
# BMB Module Documentation
|
||||
|
||||
Reference documentation for building BMAD agents and workflows.
|
||||
Create custom agents, workflows, and modules for BMAD.
|
||||
|
||||
## Quick Start
|
||||
|
||||
- **[Agent Creation Guide](./agent-creation-guide.md)** - Step-by-step guide to building your first agent
|
||||
- **[Understanding Agent Types](./understanding-agent-types.md)** - Learn the differences between Simple and Expert agents
|
||||
|
||||
## Agent Architecture
|
||||
|
||||
@@ -37,7 +42,7 @@ Production-ready examples in [bmb/reference/agents/](https://github.com/bmad-cod
|
||||
|
||||
For installing standalone simple and expert agents, see:
|
||||
|
||||
- [Custom Agent Installation](/docs/custom-content-installation.md)
|
||||
- [Custom Agent Installation](/docs/modules/bmb-bmad-builder/custom-content-installation.md)
|
||||
|
||||
## Key Concepts
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
# Workflow Vendoring, Customization, and Inheritance (Official Support Consing Soon)
|
||||
|
||||
Vendoring and Inheritance of workflows are 2 ways of sharing or reutilizing workflows - but with some key distinctions and use cases.
|
||||
|
||||
## Workflow Vendoring
|
||||
|
||||
Workflow Vendoring allows an agent to have access to a workflow from another module, without having to install said module. At install time, the module workflow being vendored will be cloned and installed into the module that is receiving the vendored workflow the agent needs.
|
||||
|
||||
### How to Vendor
|
||||
|
||||
Lets assume you are building a module, and you do not want to recreate a workflow from the BMad Method, such as workflows/4-implementation/dev-story/workflow.md. Instead of copying all the context to your module, and having to maintain it over time as updates are made, you can instead use the exec-vendor menu item in your agent.
|
||||
|
||||
From your modules agent definition, you would implement the menu item as follows in the agent:
|
||||
|
||||
```yaml
|
||||
- trigger: develop-story
|
||||
exec-vendor: "{project-root}/_bmad/<source-module>/workflows/4-production/dev-story/workflow.md"
|
||||
exec: "{project-root}/_bmad/<my-module>/workflows/dev-story/workflow.md"
|
||||
description: "Execute Dev Story workflow, implementing tasks and tests, or performing updates to the story"
|
||||
```
|
||||
|
||||
At install time, it will clone the workflow and all of its required assets, and the agent that gets built will have an exec to a path installed in its own module. The content gets added to the folder you specify in exec. While it does not have to exactly match the source path, you will want to ensure you are specifying the workflow.md to be in a new location (in other words in this example, dev-story would not already be the path of another custom module workflow that already exists.)
|
||||
|
||||
## Workflow Inheritance (Official Support Coming Post Beta)
|
||||
|
||||
Workflow Inheritance is a different concept, that allows you to modify or extend existing workflow.
|
||||
|
||||
Party Mode from the core is an example of a workflow that is designed with inheritance in mind - customization for specific party needs. While party mode itself is generic - there might be specific agent collaborations you want to create. Without having to reinvent the whole party mode concept, or copy and paste all of its content - you could inherit from party mode to extend it to be specific.
|
||||
|
||||
Some possible examples could be:
|
||||
|
||||
- Retrospective
|
||||
- Sprint Planning
|
||||
- Collaborative Brainstorming Sessions
|
||||
|
||||
## Workflow Customization (Official Support Coming Post Beta)
|
||||
|
||||
Similar to Workflow Inheritance, Workflow Customization will soon be allowed for certain workflows that are meant to be user customized - similar in process to how agents are customized now.
|
||||
|
||||
This will take the shape of workflows with optional hooks, configurable inputs, and the ability to replace whole at install time.
|
||||
|
||||
For example, assume you are using the Create PRD workflow, which is comprised of 11 steps, and you want to always include specifics about your companies domain, technical landscape or something else. While project-context can be helpful with that, you can also through hooks and step overrides, have full replace steps, the key requirement being to ensure your step replace file is an exact file name match of an existing step, follows all conventions, and ends in a similar fashion to either hook back in to call the next existing step, or more custom steps that eventually hook back into the flow.
|
||||
@@ -291,4 +291,3 @@ Phase 4 workflows inherit from BMM base and add BMGD-specific overrides.
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD
|
||||
- **[Game Types Guide](./game-types-guide.md)** - Game genre reference
|
||||
- **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions
|
||||
@@ -50,7 +50,6 @@ Understanding how BMGD works:
|
||||
Essential reference materials:
|
||||
|
||||
- **[Glossary](./glossary.md)** - Key game development terminology
|
||||
- **[Troubleshooting](./troubleshooting.md)** - Common issues and solutions
|
||||
|
||||
---
|
||||
|
||||
@@ -148,7 +147,6 @@ BMGD Documentation
|
||||
├── quick-flow-guide.md # Rapid prototyping and development
|
||||
├── game-types-guide.md # Game type templates
|
||||
├── glossary.md # Terminology
|
||||
└── troubleshooting.md # Common issues
|
||||
```
|
||||
|
||||
---
|
||||
@@ -164,9 +162,6 @@ BMGD Documentation
|
||||
### Related Documentation
|
||||
|
||||
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
||||
- **[IDE Guides](../../ide-info/)** - Configure your development environment
|
||||
|
||||
---
|
||||
|
||||
## Tips for Using This Documentation
|
||||
|
||||
|
Before Width: | Height: | Size: 200 KiB After Width: | Height: | Size: 200 KiB |
@@ -8,7 +8,7 @@ Complete reference for all BMGD workflows organized by development phase.
|
||||
|
||||
BMGD workflows are organized into four phases:
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
@@ -259,7 +259,7 @@ Checks current project status across all phases. Shows completed documents, curr
|
||||
|
||||
## Quick-Flow Workflows
|
||||
|
||||
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](./quick-flow-guide.md)** for detailed usage.
|
||||
Fast-track workflows that skip full planning phases. See **[Quick-Flow Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md)** for detailed usage.
|
||||
|
||||
### Quick-Prototype
|
||||
|
||||
@@ -457,7 +457,7 @@ This means:
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **[Quick Start Guide](./quick-start.md)** - Get started with BMGD
|
||||
- **[Quick-Flow Guide](./quick-flow-guide.md)** - Rapid prototyping and development
|
||||
- **[Agents Guide](./agents-guide.md)** - Agent reference
|
||||
- **[Game Types Guide](./game-types-guide.md)** - Game type templates
|
||||
- **[Quick Start Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-start.md)** - Get started with BMGD
|
||||
- **[Quick-Flow Guide](../../../../docs/modules/bmgd-bmad-game-dev/quick-flow-guide.md)** - Rapid prototyping and development
|
||||
- **[Agents Guide](../../../../docs/modules/bmgd-bmad-game-dev/agents-guide.md)** - Agent reference
|
||||
- **[Game Types Guide](../../../../docs/modules/bmgd-bmad-game-dev/game-types-guide.md)** - Game type templates
|
||||
@@ -725,7 +725,6 @@ flowchart TD
|
||||
- **[Quick Start Guide](./quick-start.md)** - Getting started with BMM
|
||||
- **[Glossary](./glossary.md)** - Key terminology
|
||||
- **[FAQ](./faq.md)** - Common questions
|
||||
- **[Troubleshooting](./troubleshooting.md)** - Problem resolution
|
||||
- **[Workflow Documentation](./index.md#-workflow-guides)** - Complete workflow reference
|
||||
|
||||
---
|
||||
@@ -354,8 +354,6 @@ Use them together for best results.
|
||||
|
||||
**Why model quality matters:** BMM workflows require LLMs that can follow multi-step processes, maintain context across phases, and implement code that adheres to specifications. Tools with weaker models will struggle with workflow adherence and code quality.
|
||||
|
||||
See [IDE Setup Guides](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for configuration specifics.
|
||||
|
||||
### Q: Can I customize agents?
|
||||
|
||||
**A:** Yes! Agents are installed as markdown files with XML-style content (optimized for LLMs, readable by any model). Create customization files in `_bmad/_config/agents/[agent-name].customize.yaml` to override default behaviors while keeping core functionality intact. See agent documentation for customization options.
|
||||
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
@@ -22,26 +22,23 @@ Complete guides for the BMad Method Module (BMM) - AI-powered agile development
|
||||
|
||||
## 📖 Core Concepts
|
||||
|
||||
Understanding how BMM adapts to your needs:
|
||||
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).
|
||||
|
||||
- **[Scale Adaptive System](./scale-adaptive-system.md)** - How BMM adapts to project size and complexity
|
||||
- Three planning tracks (Quick Flow, BMad Method, Enterprise Method)
|
||||
- Automatic track recommendation
|
||||
- Documentation requirements per track
|
||||
- Planning workflow routing
|
||||
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](#-workflow-guides)** - 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 planing 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](./bmad-quick-flow.md)** - Fast-track development workflow
|
||||
- 3-step process: spec → dev → optional review
|
||||
- Perfect for bug fixes and small features
|
||||
- Rapid prototyping with production quality
|
||||
- Hours to implementation, not days
|
||||
- Barry (Quick Flow Solo Dev) agent owned
|
||||
|
||||
- **[Quick Flow Solo Dev Agent](./quick-flow-solo-dev.md)** - Elite solo developer for rapid development
|
||||
- Barry is an elite developer who thrives on autonomous execution
|
||||
- Lives and breathes the BMAD Quick Flow workflow
|
||||
- Takes projects from concept to deployment with ruthless efficiency
|
||||
- No handoffs, no delays - just pure focused development
|
||||
- Implementation in minutes, not days
|
||||
- Has a specialized single agent that does all of this: **[Quick Flow Solo Dev Agent](./quick-flow-solo-dev.md)**
|
||||
|
||||
## 🤖 Agents and Collaboration
|
||||
|
||||
@@ -78,7 +75,6 @@ Essential reference materials:
|
||||
|
||||
- **[Glossary](./glossary.md)** - Key terminology and concepts
|
||||
- **[FAQ](./faq.md)** - Frequently asked questions across all topics
|
||||
- **[Enterprise Agentic Development](./enterprise-agentic-development.md)** - Team collaboration strategies
|
||||
|
||||
## 🎯 Choose Your Path
|
||||
|
||||
@@ -86,19 +82,14 @@ Essential reference materials:
|
||||
|
||||
**Build something new (greenfield)**
|
||||
→ Start with [Quick Start Guide](./quick-start.md)
|
||||
→ Then review [Scale Adaptive System](./scale-adaptive-system.md) to understand tracks
|
||||
|
||||
**Fix a bug or add small feature**
|
||||
→ Go to [BMAD Quick Flow](./bmad-quick-flow.md) for rapid development
|
||||
→ Or use [Quick Flow Solo Dev](./quick-flow-solo-dev.md) directly
|
||||
→ User the [Quick Flow Solo Dev](./quick-flow-solo-dev.md) directly with its dedicated stand alone [Quick Bmad Spec Flow](./quick-spec-flow.md) process
|
||||
|
||||
**Work with existing codebase (brownfield)**
|
||||
→ Read [Brownfield Development Guide](./brownfield-guide.md)
|
||||
→ Pay special attention to documentation requirements for brownfield projects
|
||||
|
||||
**Understand planning tracks and methodology**
|
||||
→ See [Scale Adaptive System](./scale-adaptive-system.md)
|
||||
|
||||
## 📋 Workflow Guides
|
||||
|
||||
Comprehensive documentation for all BMM workflows organized by phase:
|
||||
@@ -127,35 +118,6 @@ Comprehensive documentation for all BMM workflows organized by phase:
|
||||
- **[Testing & QA Workflows](./test-architecture.md)** - Comprehensive quality assurance (1,420 lines)
|
||||
- Test strategy, automation, quality gates
|
||||
- TEA agent and test healing
|
||||
- BMad-integrated vs standalone modes
|
||||
|
||||
**Total: 34 workflows documented across all phases**
|
||||
|
||||
### Advanced Workflow References
|
||||
|
||||
For detailed technical documentation on specific complex workflows:
|
||||
|
||||
- **[Document Project Workflow Reference](./workflow-document-project-reference.md)** - Technical deep-dive (445 lines)
|
||||
- v1.2.0 context-safe architecture
|
||||
- Scan levels, resumability, write-as-you-go
|
||||
- Multi-part project detection
|
||||
- Deep-dive mode for targeted analysis
|
||||
|
||||
- **[Architecture Workflow Reference](./workflow-architecture-reference.md)** - Decision architecture guide (320 lines)
|
||||
- Starter template intelligence
|
||||
- Novel pattern design
|
||||
- Implementation patterns for agent consistency
|
||||
- Adaptive facilitation approach
|
||||
|
||||
## 🏗️ Module Structure
|
||||
|
||||
Understanding BMM components:
|
||||
|
||||
- **[BMM Module README](../README.md)** - Overview of module structure
|
||||
- Agent roster and roles
|
||||
- Workflow organization
|
||||
- Teams and collaboration
|
||||
- Best practices
|
||||
|
||||
## 🌐 External Resources
|
||||
|
||||
@@ -2,13 +2,11 @@
|
||||
|
||||
**Get all your AI agents in one conversation**
|
||||
|
||||
---
|
||||
|
||||
## What is Party Mode?
|
||||
|
||||
Ever wanted to gather your entire AI team in one room and see what happens? That's party mode.
|
||||
|
||||
Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer, the CIS creative agents - everyone shows up.
|
||||
Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent or at key workflow junctions when asked), and suddenly you've got **all your AI agents** in one conversation. PM, Architect, DEV, UX Designer and more that you can choose from.
|
||||
|
||||
**Why it's useful:**
|
||||
|
||||
@@ -19,8 +17,6 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and su
|
||||
- **Sprint retrospectives** - Party mode powers the retrospective workflow
|
||||
- **Sprint planning** - Multi-agent collaboration for planning sessions
|
||||
|
||||
**Future use:** Advanced elicitation workflows will leverage party mode for sophisticated requirement gathering.
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
@@ -46,6 +42,10 @@ Type `/bmad:core:workflows:party-mode` (or `*party-mode` from any agent), and su
|
||||
# OR from any agent context
|
||||
*party-mode
|
||||
|
||||
# Super Hack
|
||||
|
||||
/bmad:core:workflows:party-mode and include also in the party Santa Clause and Einstein
|
||||
|
||||
# During party
|
||||
Ask questions, respond to agents, direct the conversation
|
||||
|
||||
@@ -103,116 +103,6 @@ _(Ideas cross-pollinate and evolve)_
|
||||
|
||||
_(Multiple perspectives reveal the right answer)_
|
||||
|
||||
---
|
||||
|
||||
## When NOT to Use Party Mode
|
||||
|
||||
**Skip party mode for:**
|
||||
|
||||
- Simple implementation questions → Use DEV agent
|
||||
- Document review → Use Technical Writer
|
||||
- Workflow status checks → Use any agent + `*workflow-status`
|
||||
- Single-domain questions → Use specialist agent
|
||||
|
||||
**Use party mode for:**
|
||||
|
||||
- Multi-perspective decisions
|
||||
- Creative collaboration
|
||||
- Post-mortems and retrospectives
|
||||
- Sprint planning sessions
|
||||
- Complex problem-solving
|
||||
|
||||
---
|
||||
|
||||
## Agent Customization
|
||||
|
||||
Party mode uses agents from `_bmad/[module]/agents/*.md` - these already include any customizations you applied during install.
|
||||
|
||||
**To customize agents for party mode:**
|
||||
|
||||
1. Create customization file: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
2. Run `npx bmad-method install` to rebuild agents
|
||||
3. Customizations now active in party mode
|
||||
|
||||
Example customization:
|
||||
|
||||
```yaml
|
||||
agent:
|
||||
persona:
|
||||
principles:
|
||||
- 'HIPAA compliance is non-negotiable'
|
||||
- 'Patient safety over feature velocity'
|
||||
```
|
||||
|
||||
See [Agents Guide](./agents-guide.md#agent-customization) for details.
|
||||
|
||||
---
|
||||
|
||||
## BMM Workflows That Use Party Mode
|
||||
|
||||
**Current:**
|
||||
|
||||
- `epic-retrospective` - Post-epic team retrospective powered by party mode
|
||||
- Sprint planning discussions (informal party mode usage)
|
||||
|
||||
**Future:**
|
||||
|
||||
- Advanced elicitation workflows will officially integrate party mode
|
||||
- Multi-agent requirement validation
|
||||
- Collaborative technical reviews
|
||||
|
||||
---
|
||||
|
||||
## Available Agents
|
||||
|
||||
Party mode can include **19+ agents** from all installed modules:
|
||||
|
||||
**BMM (12 agents):** PM, Analyst, Architect, SM, DEV, TEA, UX Designer, Technical Writer, Game Designer, Game Developer, Game Architect
|
||||
|
||||
**CIS (5 agents):** Brainstorming Coach, Creative Problem Solver, Design Thinking Coach, Innovation Strategist, Storyteller
|
||||
|
||||
**BMB (1 agent):** BMad Builder
|
||||
|
||||
**Core (1 agent):** BMad Master (orchestrator)
|
||||
|
||||
**Custom:** Any agents you've created
|
||||
|
||||
---
|
||||
|
||||
## Tips
|
||||
|
||||
**Get better results:**
|
||||
|
||||
- Be specific with your topic/question
|
||||
- Provide context (project type, constraints, goals)
|
||||
- Direct specific agents when you want their expertise
|
||||
- Make decisions - party mode informs, you decide
|
||||
- Time box discussions (15-30 minutes is usually plenty)
|
||||
|
||||
**Examples of good opening questions:**
|
||||
|
||||
- "We need to decide between REST and GraphQL for our mobile API. Project is a B2B SaaS with 50 enterprise clients."
|
||||
- "Our last sprint failed spectacularly. Let's discuss what went wrong with authentication implementation."
|
||||
- "Brainstorm: how can we make our game's tutorial feel rewarding instead of tedious?"
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Same agents responding every time?**
|
||||
Vary your questions or explicitly request other perspectives: "Game Designer, your thoughts?"
|
||||
|
||||
**Discussion going in circles?**
|
||||
BMad Master will summarize and redirect, or you can make a decision and move on.
|
||||
|
||||
**Too many agents talking?**
|
||||
Make your topic more specific - BMad Master picks 2-3 agents based on relevance.
|
||||
|
||||
**Agents not using customizations?**
|
||||
Make sure you ran `npx bmad-method install` after creating customization files.
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
@@ -371,8 +371,6 @@ Checks:
|
||||
|
||||
**Total time:** 1-3 hours (mostly implementation)
|
||||
|
||||
---
|
||||
|
||||
## Integration with Phase 4 Workflows
|
||||
|
||||
Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
@@ -395,8 +393,6 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
- ✅ Uses tech-spec.md as comprehensive context
|
||||
- ✅ Implements following detected conventions
|
||||
|
||||
---
|
||||
|
||||
## Comparison: Quick Spec vs Full BMM
|
||||
|
||||
| Aspect | Quick Flow Track | BMad Method/Enterprise Tracks |
|
||||
@@ -411,7 +407,6 @@ Quick Spec Flow works seamlessly with all Phase 4 implementation workflows:
|
||||
| **Brownfield** | Auto-analyzes and conforms | Manual documentation required |
|
||||
| **Conventions** | Auto-detects and confirms | Document in PRD/Architecture |
|
||||
|
||||
---
|
||||
|
||||
## When to Graduate from Quick Flow to BMad Method
|
||||
|
||||
@@ -426,8 +421,6 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
💡 **Tip:** You can always run `workflow-init` later to transition from Quick Flow to BMad Method!
|
||||
|
||||
---
|
||||
|
||||
## Quick Spec Flow - Key Benefits
|
||||
|
||||
### 🚀 **Speed**
|
||||
@@ -465,8 +458,6 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
- No scope creep
|
||||
- Fast iteration
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
@@ -478,12 +469,12 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
```bash
|
||||
# For a quick bug fix or small change:
|
||||
# 1. Load PM agent
|
||||
# 1. Load Quick Dev Solo agent
|
||||
# 2. Say: "I want to [describe your change]"
|
||||
# 3. PM will ask if you want to run tech-spec
|
||||
# 3. Agent will ask if you want to run tech-spec
|
||||
# 4. Answer questions about your change
|
||||
# 5. Get tech-spec + story
|
||||
# 6. Load DEV agent and implement!
|
||||
# 6. Reload a fresh context with the solo agent and implement!
|
||||
|
||||
# For a small feature with multiple stories:
|
||||
# Same as above, but get epic + 2-3 stories
|
||||
@@ -492,14 +483,7 @@ Start with Quick Flow, but switch to BMad Method when:
|
||||
|
||||
### No workflow-init Required!
|
||||
|
||||
Quick Spec Flow is **fully standalone**:
|
||||
|
||||
- Detects if it's a single change or multi-story feature
|
||||
- Asks for greenfield vs brownfield
|
||||
- Works without status file tracking
|
||||
- Perfect for rapid prototyping
|
||||
|
||||
---
|
||||
Quick Spec Flow is **fully standalone**
|
||||
|
||||
## FAQ
|
||||
|
||||
@@ -43,10 +43,7 @@ The interactive installer will guide you through setup and create a `_bmad/` fol
|
||||
|
||||
### Step 1: Initialize Your Workflow
|
||||
|
||||
1. **Load the Analyst agent** in your IDE - See your IDE-specific instructions in [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for how to activate agents:
|
||||
- [Claude Code](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/ide-info/claude-code.md)
|
||||
- [VS Code/Cursor/Windsurf](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) - Check your IDE folder
|
||||
- Other IDEs also supported
|
||||
1. **Load the Analyst agent** in your IDE - Generally this is done by typing `/<workflow or agent name - allow autocomplete to find the right command>` - if you are unsure, you can just start with /bmad and see all that is available, sorted by agents and workflows.
|
||||
2. **Wait for the agent's menu** to appear
|
||||
3. **Tell the agent**: "Run workflow-init" or type "\*workflow-init" or select the menu item number
|
||||
|
||||
@@ -113,7 +110,7 @@ The next TRULY REQUIRED step is:
|
||||
|
||||
When an agent tells you to run a workflow (like `prd`):
|
||||
|
||||
1. **Start a new chat** with the specified agent (e.g., PM) - See [docs/ide-info](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/docs/ide-info) for your IDE's specific instructions
|
||||
1. **Start a new chat** with the specified agent
|
||||
2. **Wait for the menu** to appear
|
||||
3. **Tell the agent** to run it using any of these formats:
|
||||
- Type the shorthand: `*prd`
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
last-redoc-date: 2025-11-05
|
||||
---
|
||||
|
||||
# Test Architect (TEA) Agent Guide
|
||||
|
||||
## Overview
|
||||
@@ -259,17 +255,17 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||
- 🔄 Phase 4: `*test-design` - Focus on regression hotspots and brownfield risks
|
||||
- 🔄 Phase 4: Story Review - May include `*nfr-assess` if not done earlier
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| ---------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
|
||||
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
|
||||
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
||||
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
|
||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| --------------------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Documentation**: Prerequisite ➕ | - | Analyst `*document-project` (if undocumented) | Comprehensive project documentation |
|
||||
| **Phase 1**: Discovery | - | Analyst/PM/Architect rerun planning workflows | Updated planning artifacts in `{output_folder}` |
|
||||
| **Phase 2**: Planning | Run ➕ `*trace` (baseline coverage) | PM `*prd` (creates PRD with FRs/NFRs) | PRD with FRs/NFRs, ➕ coverage baseline |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint status file with all epics and stories |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (regression hotspots) | Review epic scope and brownfield risks | `test-design-epic-N.md` with brownfield risk assessment and mitigation |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd` before dev, then `*automate` after | SM `*create-story`, DEV implements | Tests, story implementation |
|
||||
| **Phase 4**: Story Review | Apply `*test-review` (optional), re-run `*trace`, ➕ `*nfr-assess` if needed | Resolve gaps, update docs/tests | Quality report, refreshed coverage matrix, NFR report |
|
||||
| **Phase 4**: Release Gate | (Optional) `*test-review` for final audit, Run `*trace` (Phase 2) | Capture sign-offs, share release notes | Quality audit, Gate YAML + release summary |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
@@ -309,15 +305,15 @@ These cheat sheets map TEA workflows to the **BMad Method and Enterprise tracks*
|
||||
- 🔄 Phase 4: `*test-design` - Enterprise focus (compliance, security architecture alignment)
|
||||
- 📦 Release Gate - Archive artifacts and compliance evidence for audits
|
||||
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| -------------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief |
|
||||
| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics |
|
||||
| Workflow Stage | Test Architect | Dev / Team | Outputs |
|
||||
| -------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| **Phase 1**: Discovery | - | Analyst ➕ `*research`, `*product-brief` | Domain research, compliance analysis, product brief |
|
||||
| **Phase 2**: Planning | Run ➕ `*nfr-assess` | PM `*prd` (creates PRD with FRs/NFRs), UX `*create-ux-design` | Enterprise PRD with FRs/NFRs, UX design, ➕ NFR documentation |
|
||||
| **Phase 3**: Solutioning | Run `*framework`, `*ci` AFTER architecture and epic creation | Architect `*architecture`, `*create-epics-and-stories`, `*implementation-readiness` | Architecture, epics/stories, test framework, CI pipeline |
|
||||
| **Phase 4**: Sprint Start | - | SM `*sprint-planning` | Sprint plan with all epics |
|
||||
| **Phase 4**: Epic Planning | Run `*test-design` for THIS epic 🔄 (compliance focus) | Review epic scope and compliance requirements | `test-design-epic-N.md` with security/performance/compliance focus |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices |
|
||||
| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail |
|
||||
| **Phase 4**: Story Dev | (Optional) `*atdd`, `*automate`, `*test-review`, `*trace` per story | SM `*create-story`, DEV implements | Tests, fixtures, quality reports, coverage matrices |
|
||||
| **Phase 4**: Release Gate | Final `*test-review` audit, Run `*trace` (Phase 2), 📦 archive artifacts | Capture sign-offs, 📦 compliance evidence | Quality audit, updated assessments, gate YAML, 📦 audit trail |
|
||||
|
||||
<details>
|
||||
<summary>Execution Notes</summary>
|
||||
3
docs/modules/bmm-bmad-method/troubleshooting.md
Normal file
3
docs/modules/bmm-bmad-method/troubleshooting.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# BMM Troubleshooting Guide
|
||||
|
||||
Common issues and solutions for the BMad Method Module will be listed here as needed.
|
||||
@@ -0,0 +1,71 @@
|
||||
# Document Project Workflow - Technical Reference
|
||||
|
||||
**Module:** BMM (BMAD Method Module)
|
||||
|
||||
## Purpose
|
||||
|
||||
Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development. Generates a master index and multiple documentation files tailored to project structure and type.
|
||||
|
||||
## How to Invoke
|
||||
```bash
|
||||
/bmad:bmm:workflows:document-project
|
||||
```
|
||||
---
|
||||
|
||||
## Scan Levels
|
||||
|
||||
Choose the right scan depth for your needs:
|
||||
|
||||
### 1. Quick Scan (Default)
|
||||
|
||||
**What it does:** Pattern-based analysis without reading source files
|
||||
**Reads:** Config files, package manifests, directory structure, README
|
||||
**Use when:**
|
||||
|
||||
- You need a fast project overview
|
||||
- Initial understanding of project structure
|
||||
- Planning next steps before deeper analysis
|
||||
|
||||
**Does NOT read:** Source code files (`_.js`, `_.ts`, `_.py`, `_.go`, etc.)
|
||||
|
||||
### 2. Deep Scan
|
||||
|
||||
**What it does:** Reads files in critical directories based on project type
|
||||
**Reads:** Files in critical paths defined by documentation requirements
|
||||
**Use when:**
|
||||
|
||||
- Creating comprehensive documentation for brownfield PRD
|
||||
- Need detailed analysis of key areas
|
||||
- Want balance between depth and speed
|
||||
|
||||
**Example:** For a web app, reads controllers/, models/, components/, but not every utility file
|
||||
|
||||
### 3. Exhaustive Scan
|
||||
|
||||
**What it does:** Reads ALL source files in project
|
||||
**Reads:** Every source file (excludes node_modules, dist, build, .git)
|
||||
**Use when:**
|
||||
|
||||
- Complete project analysis needed
|
||||
- Migration planning requires full understanding
|
||||
- Detailed audit of entire codebase
|
||||
- Deep technical debt assessment
|
||||
|
||||
**Note:** Deep-dive mode ALWAYS uses exhaustive scan (no choice)
|
||||
|
||||
---
|
||||
|
||||
## Resumability
|
||||
|
||||
The workflow can be interrupted and resumed without losing progress:
|
||||
|
||||
- **State Tracking:** Progress saved in `project-scan-report.json`
|
||||
- **Auto-Detection:** Workflow detects incomplete runs (<24 hours old)
|
||||
- **Resume Prompt:** Choose to resume or start fresh
|
||||
- **Step-by-Step:** Resume from exact step where interrupted
|
||||
- **Archiving:** Old state files automatically archived
|
||||
|
||||
**Related Documentation:**
|
||||
|
||||
- [Brownfield Development Guide](./brownfield-guide.md)
|
||||
- [Implementation Workflows](./workflows-implementation.md)
|
||||
@@ -19,7 +19,6 @@ Phase 1 Analysis consists of three categories of optional workflows:
|
||||
### Discovery & Ideation (Optional)
|
||||
|
||||
- **brainstorm-project** - Multi-track solution exploration for software projects
|
||||
- **brainstorm-game** - Game concept generation (coming soon)
|
||||
|
||||
### Research & Validation (Optional)
|
||||
|
||||
@@ -54,19 +53,10 @@ These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` w
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Unclear technical approach with business objectives
|
||||
- Multiple solution paths need evaluation
|
||||
- Hidden assumptions need discovery
|
||||
- Innovation beyond obvious solutions
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Architecture proposals with trade-off analysis
|
||||
- Value framework (prioritized features)
|
||||
- Risk analysis (dependencies, challenges)
|
||||
- Strategic recommendation with rationale
|
||||
|
||||
**Example:** "We need a customer dashboard" → Options: Monolith SSR (faster), Microservices SPA (scalable), Hybrid (balanced) with recommendation.
|
||||
- Very vague or seed kernal of an idea that needs exploration
|
||||
- Consider alternatives or enhancements to an idea
|
||||
- See your idea from different angles and viewpoints
|
||||
- No idea what you want to build, but want to find some inspiration
|
||||
|
||||
---
|
||||
|
||||
@@ -111,11 +101,6 @@ These workflows feed into Phase 2 (Planning) workflows, particularly the `prd` w
|
||||
- Transitioning from exploration to strategy
|
||||
- Need executive-level product documentation
|
||||
|
||||
**Modes:**
|
||||
|
||||
- **Interactive Mode** (Recommended): Step-by-step collaborative development with probing questions
|
||||
- **YOLO Mode**: AI generates complete draft from context, then iterative refinement
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- Executive summary
|
||||
@@ -179,32 +164,6 @@ Analysis outputs feed directly into Planning:
|
||||
|
||||
Planning workflows automatically load these documents if they exist in the output folder.
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Don't Over-Invest in Analysis
|
||||
|
||||
Analysis is optional. If requirements are clear, skip to Phase 2 (Planning).
|
||||
|
||||
### 2. Iterate Between Workflows
|
||||
|
||||
Common pattern: brainstorm → research (validate) → brief (synthesize)
|
||||
|
||||
### 3. Document Assumptions
|
||||
|
||||
Analysis surfaces and validates assumptions. Document them explicitly for planning to challenge.
|
||||
|
||||
### 4. Keep It Strategic
|
||||
|
||||
Focus on "what" and "why", not "how". Leave implementation for Planning and Solutioning.
|
||||
|
||||
### 5. Involve Stakeholders
|
||||
|
||||
Use analysis workflows to align stakeholders before committing to detailed planning.
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Greenfield Software (Full Analysis)
|
||||
@@ -233,34 +192,8 @@ Use analysis workflows to align stakeholders before committing to detailed plann
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Next phase
|
||||
- [Phase 3: Solutioning Workflows](./workflows-solutioning.md)
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md)
|
||||
- [Phase 2: Planning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-planning.md) - Next phase
|
||||
- [Phase 3: Solutioning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-solutioning.md)
|
||||
- [Phase 4: Implementation Workflows](../../../../docs/modules/bmm-bmad-method/workflows-implementation.md)
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding project complexity
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Q: Do I need to run all analysis workflows?**
|
||||
A: No! Analysis is entirely optional. Use only workflows that help you think through your problem.
|
||||
|
||||
**Q: Which workflow should I start with?**
|
||||
A: If unsure, start with `research` (market type) to validate viability, then move to `product-brief`.
|
||||
|
||||
**Q: Can I skip straight to Planning?**
|
||||
A: Yes! If you know what you're building and why, skip Phase 1 entirely and start with Phase 2 (prd/tech-spec).
|
||||
|
||||
**Q: How long should Analysis take?**
|
||||
A: Typically hours to 1-2 days. If taking longer, you may be over-analyzing. Move to Planning.
|
||||
|
||||
**Q: What if I discover problems during Analysis?**
|
||||
A: That's the point! Analysis helps you fail fast and pivot before heavy planning investment.
|
||||
|
||||
**Q: Should brownfield projects do Analysis?**
|
||||
A: Usually no. Start with `document-project` (Documentation prerequisite), then skip to Planning (Phase 2).
|
||||
|
||||
---
|
||||
|
||||
_Phase 1 Analysis - Optional strategic thinking before commitment._
|
||||
- [Agents Guide](../../../../docs/modules/bmm-bmad-method/agents-guide.md) - Complete agent reference
|
||||
89
docs/modules/bmm-bmad-method/workflows-planning.md
Normal file
89
docs/modules/bmm-bmad-method/workflows-planning.md
Normal file
@@ -0,0 +1,89 @@
|
||||
# BMM Planning Workflows (Phase 2)
|
||||
|
||||
## Phase 2 Planning Workflow Overview
|
||||
|
||||
|
||||
## Quick Reference
|
||||
|
||||
| Workflow | Agent | Track | Purpose |
|
||||
| -------------------- | ----------- | ----------------------- | ------------------------------------- |
|
||||
| **prd** | PM | BMad Method, Enterprise | Strategic PRD with FRs/NFRs |
|
||||
| **create-ux-design** | UX Designer | BMad Method, Enterprise | Optional UX specification (after PRD) |
|
||||
|
||||
### prd (Product Requirements Document)
|
||||
|
||||
**Purpose:** Strategic PRD with Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for software products (BMad Method track).
|
||||
|
||||
**Agent:** PM (with Architect and Analyst support)
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- Medium to large feature sets
|
||||
- Multi-screen user experiences
|
||||
- Complex business logic
|
||||
- Multiple system integrations
|
||||
- Phased delivery required
|
||||
|
||||
**Scale-Adaptive Structure:**
|
||||
|
||||
- **Light:** Focused FRs/NFRs, simplified analysis (10-15 pages)
|
||||
- **Standard:** Comprehensive FRs/NFRs, thorough analysis (20-30 pages)
|
||||
- **Comprehensive:** Extensive FRs/NFRs, multi-phase, stakeholder analysis (30-50+ pages)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- PRD.md (complete requirements with FRs and NFRs)
|
||||
|
||||
**Note:** V6 improvement - PRD focuses on WHAT to build (requirements). Epic+Stories are created AFTER architecture via `create-epics-and-stories` workflow for better quality.
|
||||
|
||||
**Integration:** Feeds into Architecture (Phase 3)
|
||||
|
||||
**Example:** E-commerce checkout → PRD with 15 FRs (user account, cart management, payment flow) and 8 NFRs (performance, security, scalability).
|
||||
|
||||
---
|
||||
|
||||
### create-ux-design (UX Design)
|
||||
|
||||
**Purpose:** UX specification for projects where user experience is the primary differentiator (BMad Method track).
|
||||
|
||||
**Agent:** UX Designer
|
||||
|
||||
**When to Use:**
|
||||
|
||||
- UX is primary competitive advantage
|
||||
- Complex user workflows needing design thinking
|
||||
- Innovative interaction patterns
|
||||
- Design system creation
|
||||
- Accessibility-critical experiences
|
||||
|
||||
**Collaborative Approach:**
|
||||
|
||||
1. Visual exploration (generate multiple options)
|
||||
2. Informed decisions (evaluate with user needs)
|
||||
3. Collaborative design (refine iteratively)
|
||||
4. Living documentation (evolves with project)
|
||||
|
||||
**Key Outputs:**
|
||||
|
||||
- ux-spec.md (complete UX specification)
|
||||
- User journeys
|
||||
- Wireframes and mockups
|
||||
- Interaction specifications
|
||||
- Design system (components, patterns, tokens)
|
||||
- Epic breakdown (UX stories)
|
||||
|
||||
**Integration:** Feeds PRD or updates epics, then Architecture (Phase 3)
|
||||
|
||||
**Example:** Dashboard redesign → Card-based layout with split-pane toggle, 5 card components, 12 color tokens, responsive grid, 3 epics (Layout, Visualization, Accessibility).
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Do Product Brief from Phase 1 to kickstart the PRD for better results
|
||||
|
||||
### 2. Focus on "What" Not "How"
|
||||
|
||||
Planning defines **what** to build and **why**. Leave **how** (technical design) to Phase 3 (Solutioning).
|
||||
|
||||
### 3. Document-Project First for Brownfield
|
||||
|
||||
Always run `document-project` before planning brownfield projects. AI agents need existing codebase context and will make a large quality difference. If you are adding a small addition to an existing project, you might want to consider instead after using document-project to use the quick flow solo dev process instead.
|
||||
@@ -434,7 +434,7 @@ Architecture documents are living. Update them as you learn during implementatio
|
||||
|
||||
**Key Difference:** Enterprise adds optional extended workflows AFTER architecture but BEFORE create-epics-and-stories. Everything else is identical to BMad Method.
|
||||
|
||||
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](./test-architecture.md) for TEA's full lifecycle integration.
|
||||
**Note:** TEA (Test Architect) operates across all phases and validates architecture testability but is not a Phase 3-specific workflow. See [Test Architecture Guide](../../../../docs/modules/bmm-bmad-method/test-architecture.md) for TEA's full lifecycle integration.
|
||||
|
||||
---
|
||||
|
||||
@@ -471,10 +471,10 @@ Architecture documents are living. Update them as you learn during implementatio
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Phase 2: Planning Workflows](./workflows-planning.md) - Previous phase
|
||||
- [Phase 4: Implementation Workflows](./workflows-implementation.md) - Next phase
|
||||
- [Phase 2: Planning Workflows](../../../../docs/modules/bmm-bmad-method/workflows-planning.md) - Previous phase
|
||||
- [Phase 4: Implementation Workflows](../../../../docs/modules/bmm-bmad-method/workflows-implementation.md) - Next phase
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Understanding tracks
|
||||
- [Agents Guide](./agents-guide.md) - Complete agent reference
|
||||
- [Agents Guide](../../../../docs/modules/bmm-bmad-method/agents-guide.md) - Complete agent reference
|
||||
|
||||
---
|
||||
|
||||
105
docs/modules/core/advanced-elicitation.md
Normal file
105
docs/modules/core/advanced-elicitation.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Advanced Elicitation
|
||||
|
||||
**Push the LLM to rethink its work through 50+ reasoning methods—essentially, LLM brainstorming.**
|
||||
|
||||
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- After a workflow generates a section of content and you want to explore alternatives
|
||||
- When the LLM's initial output seems adequate but you suspect there's more depth available
|
||||
- For high-stakes content where multiple perspectives would strengthen the result
|
||||
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
|
||||
- When you want the LLM to "think again" but with structured reasoning methods
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Context Analysis
|
||||
The LLM analyzes the current content, understanding its type, complexity, stakeholder needs, risk level, and creative potential.
|
||||
|
||||
### 2. Smart Method Selection
|
||||
Based on context, 5 methods are intelligently selected from a library of 50+ techniques and presented to you:
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | ---------------------------------------- |
|
||||
| **1-5** | Apply the selected method to the content |
|
||||
| **[r] Reshuffle** | Get 5 new methods selected randomly |
|
||||
| **[a] List All** | Browse the complete method library |
|
||||
| **[x] Proceed** | Continue with enhanced content |
|
||||
|
||||
### 3. Method Execution & Iteration
|
||||
- The selected method is applied to the current content
|
||||
- Improvements are shown for your review
|
||||
- You choose whether to apply changes or discard them
|
||||
- The menu re-appears for additional elicitations
|
||||
- Each method builds on previous enhancements
|
||||
|
||||
### 4. Party Mode Integration (Optional)
|
||||
If Party Mode is active, BMAD agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
|
||||
|
||||
---
|
||||
|
||||
## Method Categories
|
||||
|
||||
| Category | Focus | Example Methods |
|
||||
| ----------------- | ----------------------------------- | -------------------------------------------------------------- |
|
||||
| **Core** | Foundational reasoning techniques | First Principles Analysis, 5 Whys, Socratic Questioning |
|
||||
| **Collaboration** | Multiple perspectives and synthesis | Stakeholder Round Table, Expert Panel Review, Debate Club |
|
||||
| **Advanced** | Complex reasoning frameworks | Tree of Thoughts, Graph of Thoughts, Self-Consistency |
|
||||
| **Competitive** | Adversarial stress-testing | Red Team vs Blue Team, Shark Tank Pitch, Code Review Gauntlet |
|
||||
| **Technical** | Architecture and code quality | Decision Records, Rubber Duck Debugging, Algorithm Olympics |
|
||||
| **Creative** | Innovation and lateral thinking | SCAMPER, Reverse Engineering, Random Input Stimulus |
|
||||
| **Research** | Evidence-based analysis | Literature Review Personas, Thesis Defense, Comparative Matrix |
|
||||
| **Risk** | Risk identification and mitigation | Pre-mortem Analysis, Failure Mode Analysis, Chaos Monkey |
|
||||
| **Learning** | Understanding verification | Feynman Technique, Active Recall Testing |
|
||||
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
|
||||
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
|
||||
- **Smart context selection** — Methods chosen based on content type, complexity, and stakeholder needs
|
||||
- **Iterative enhancement** — Each method builds on previous improvements
|
||||
- **User control** — Accept or discard each enhancement before proceeding
|
||||
- **Party Mode integration** — Agents can participate when Party Mode is active
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
|
||||
|
||||
| Parameter | Description |
|
||||
| ---------------------- | --------------------------------------------------------- |
|
||||
| **Content to enhance** | The current section content that was just generated |
|
||||
| **Context type** | The kind of content being created (spec, code, doc, etc.) |
|
||||
| **Enhancement goals** | What the calling workflow wants to improve |
|
||||
|
||||
### Integration Flow
|
||||
|
||||
When called from a workflow:
|
||||
1. Receives the current section content that was just generated
|
||||
2. Applies elicitation methods iteratively to enhance that content
|
||||
3. Returns the enhanced version when user selects 'x' to proceed
|
||||
4. The enhanced content replaces the original section in the output document
|
||||
|
||||
### Example
|
||||
|
||||
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
|
||||
|
||||
---
|
||||
|
||||
## Advanced Elicitation vs. Brainstorming
|
||||
|
||||
| | **Advanced Elicitation** | **Brainstorming** |
|
||||
| ------------ | ------------------------------------------------- | --------------------------------------------- |
|
||||
| **Source** | LLM generates ideas through structured reasoning | User provides ideas, AI coaches them out |
|
||||
| **Purpose** | Rethink and improve LLM's own output | Unlock user's creativity |
|
||||
| **Methods** | 50+ reasoning and analysis techniques | 60+ ideation and creativity techniques |
|
||||
| **Best for** | Enhancing generated content, finding alternatives | Breaking through blocks, generating new ideas |
|
||||
100
docs/modules/core/brainstorming.md
Normal file
100
docs/modules/core/brainstorming.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Brainstorming
|
||||
|
||||
**Facilitate structured creative sessions using 60+ proven ideation techniques.**
|
||||
|
||||
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner—using proven techniques to draw out ideas and insights that are already within you.
|
||||
|
||||
**Important:** Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Breaking through creative blocks on a specific challenge
|
||||
- Generating innovative ideas for products, features, or solutions
|
||||
- Exploring a problem from completely new angles
|
||||
- Systematically developing ideas from raw concepts to actionable plans
|
||||
- Team ideation (with collaborative techniques) or personal creative exploration
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Session Setup
|
||||
Define your topic, goals, and any constraints.
|
||||
|
||||
### 2. Choose Your Approach
|
||||
|
||||
| Approach | Description |
|
||||
|----------|-------------|
|
||||
| **User-Selected** | Browse the full technique library and pick what appeals to you |
|
||||
| **AI-Recommended** | Get customized technique suggestions based on your goals |
|
||||
| **Random Selection** | Discover unexpected methods through serendipitous technique combinations |
|
||||
| **Progressive Flow** | Journey systematically from expansive exploration to focused action planning |
|
||||
|
||||
### 3. Interactive Facilitation
|
||||
Work through techniques with true collaborative coaching. The AI asks probing questions, builds on your ideas, and helps you think deeper—but your ideas are the source.
|
||||
|
||||
### 4. Idea Organization
|
||||
All your generated ideas are organized into themes and prioritized.
|
||||
|
||||
### 5. Action Planning
|
||||
Top ideas get concrete next steps, resource requirements, and success metrics.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
A comprehensive session document that captures the entire journey:
|
||||
|
||||
- Topic, goals, and session parameters
|
||||
- Each technique used and how it was applied
|
||||
- Your contributions and the ideas you generated
|
||||
- Thematic organization connecting related insights
|
||||
- Prioritized ideas with action plans
|
||||
- Session highlights and key breakthroughs
|
||||
|
||||
This document becomes a permanent record of your creative process—valuable for future reference, sharing with stakeholders, or continuing the session later.
|
||||
|
||||
---
|
||||
|
||||
## Technique Categories
|
||||
|
||||
| Category | Focus |
|
||||
|----------|-------|
|
||||
| **Collaborative** | Team dynamics and inclusive participation |
|
||||
| **Creative** | Breakthrough thinking and paradigm shifts |
|
||||
| **Deep** | Root cause analysis and strategic insight |
|
||||
| **Structured** | Organized frameworks and systematic exploration |
|
||||
| **Theatrical** | Playful, radical perspectives |
|
||||
| **Wild** | Boundary-pushing, extreme thinking |
|
||||
| **Biomimetic** | Nature-inspired solutions |
|
||||
| **Quantum** | Quantum principles for innovation |
|
||||
| **Cultural** | Traditional knowledge and cross-cultural approaches |
|
||||
| **Introspective Delight** | Inner wisdom and authentic exploration |
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
|
||||
- **On-demand loading** — Techniques loaded from a comprehensive library as needed
|
||||
- **Session preservation** — Every step, insight, and action plan is documented
|
||||
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| **Topic focus** | What the brainstorming should help discover or solve |
|
||||
| **Guardrails** | Constraints, boundaries, or must-avoid areas |
|
||||
| **Output goals** | What the final output needs to accomplish for the calling workflow |
|
||||
| **Context files** | Project-specific guidance to inform technique selection |
|
||||
|
||||
### Example
|
||||
|
||||
When creating a new module in the BMad Builder workflow, Brainstorming can be invoked with guardrails around the module's purpose and a goal to discover key features, user needs, or architectural considerations. The session becomes focused on producing exactly what the module creation workflow needs.
|
||||
64
docs/modules/core/core-tasks.md
Normal file
64
docs/modules/core/core-tasks.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Core Tasks
|
||||
|
||||
Core Tasks are reusable task definitions that can be invoked by any BMAD module, workflow, or agent. These tasks provide standardized functionality for common operations.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Index Docs](#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](#shard-document) — Split large documents into sections
|
||||
|
||||
---
|
||||
|
||||
## Index Docs
|
||||
|
||||
**Generates or updates an index.md file documenting all documents in a specified directory.**
|
||||
|
||||
This task scans a target directory, reads file contents to understand their purpose, and creates a well-organized index with accurate descriptions. Files are grouped by type, purpose, or subdirectory, and descriptions are generated from actual content rather than guessing from filenames.
|
||||
|
||||
**Use it when:** You need to create navigable documentation for a folder of markdown files, or you want to maintain an updated index as content evolves.
|
||||
|
||||
**How it works:**
|
||||
1. Scan the target directory for files and subdirectories
|
||||
2. Group content by type, purpose, or location
|
||||
3. Read each file to generate brief (3-10 word) descriptions based on actual content
|
||||
4. Create or update index.md with organized listings using relative paths
|
||||
|
||||
**Output format:** A markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
||||
|
||||
---
|
||||
|
||||
## Adversarial Review (General)
|
||||
|
||||
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
||||
|
||||
This task applies adversarial thinking to content review—approaching the material with the assumption that problems exist. It's designed to find what's missing, not just what's wrong, and produces at least ten specific findings. The reviewer adopts a professional but skeptical tone, looking for gaps, inconsistencies, oversights, and areas that need clarification.
|
||||
|
||||
**Use it when:** You need a critical eye on code diffs, specifications, user stories, documentation, or any artifact before finalizing. It's particularly valuable before merging code, releasing documentation, or considering a specification complete.
|
||||
|
||||
**How it works:**
|
||||
1. Load the content to review (diff, branch, uncommitted changes, document, etc.)
|
||||
2. Perform adversarial analysis with extreme skepticism—assume problems exist
|
||||
3. Find at least ten issues to fix or improve
|
||||
4. Output findings as a markdown list
|
||||
|
||||
**Note:** This task is designed to run in a separate subagent/process with read access to the project but no prior context, ensuring an unbiased review.
|
||||
|
||||
---
|
||||
|
||||
## Shard Document
|
||||
|
||||
**Splits large markdown documents into smaller, organized files based on level 2 (##) sections.**
|
||||
|
||||
Uses the `@kayvan/markdown-tree-parser` tool to automatically break down large documents into a folder structure. Each level 2 heading becomes a separate file, and an index.md is generated to tie everything together. This makes large documents more maintainable and allows for easier navigation and updates to individual sections.
|
||||
|
||||
**Use it when:** A markdown file has grown too large to effectively work with, or you want to break a monolithic document into manageable sections that can be edited independently.
|
||||
|
||||
**How it works:**
|
||||
1. Confirm source document path and verify it's a markdown file
|
||||
2. Determine destination folder (defaults to same location as source, folder named after document)
|
||||
3. Execute the sharding command using npx @kayvan/markdown-tree-parser
|
||||
4. Verify output files and index.md were created
|
||||
5. Handle the original document—delete, move to archive, or keep with warning
|
||||
|
||||
**Handling the original:** After sharding, the task prompts you to delete, archive, or keep the original document. Deleting or archiving is recommended to avoid confusion and ensure updates happen in the sharded files only.
|
||||
30
docs/modules/core/core-workflows.md
Normal file
30
docs/modules/core/core-workflows.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Core Workflows
|
||||
|
||||
Core Workflows are domain-agnostic workflows that can be utilized by any BMAD-compliant module, workflow, or agent. These workflows are installed by default and available at any time.
|
||||
|
||||
## Available Core Workflows
|
||||
|
||||
### [Party Mode](party-mode.md)
|
||||
|
||||
Orchestrate dynamic multi-agent conversations with your entire BMAD team. Engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
||||
|
||||
### [Brainstorming](brainstorming.md)
|
||||
|
||||
Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights that are already within you.
|
||||
|
||||
### [Advanced Elicitation](advanced-elicitation.md)
|
||||
|
||||
Push the LLM to rethink its work through 50+ reasoning methods—the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated, essentially "LLM brainstorming" to find better approaches and uncover improvements.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Core Workflows are designed to be invoked and configured by other modules. When called from another workflow, they accept contextual parameters to customize the session:
|
||||
|
||||
- **Topic focus** — Direct the session toward a specific domain or question
|
||||
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
|
||||
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
|
||||
- **Output goals** — Define what the final output needs to accomplish
|
||||
|
||||
This allows modules to leverage these workflows' capabilities while maintaining focus on their specific domain and objectives.
|
||||
133
docs/modules/core/document-sharding-guide.md
Normal file
133
docs/modules/core/document-sharding-guide.md
Normal file
@@ -0,0 +1,133 @@
|
||||
# Document Sharding Guide
|
||||
|
||||
Comprehensive guide to BMad Method's document sharding system for managing large planning and architecture documents.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Document Sharding Guide](#document-sharding-guide)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [What is Document Sharding?](#what-is-document-sharding)
|
||||
- [Architecture](#architecture)
|
||||
- [When to Use Sharding](#when-to-use-sharding)
|
||||
- [Ideal Candidates](#ideal-candidates)
|
||||
- [How Sharding Works](#how-sharding-works)
|
||||
- [Sharding Process](#sharding-process)
|
||||
- [Workflow Discovery](#workflow-discovery)
|
||||
- [Using the Shard-Doc Tool](#using-the-shard-doc-tool)
|
||||
- [CLI Command](#cli-command)
|
||||
- [Interactive Process](#interactive-process)
|
||||
- [What Gets Created](#what-gets-created)
|
||||
- [Workflow Support](#workflow-support)
|
||||
- [Universal Support](#universal-support)
|
||||
|
||||
## What is Document Sharding?
|
||||
|
||||
Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`). This enables:
|
||||
|
||||
- **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
|
||||
|
||||
```
|
||||
Before Sharding:
|
||||
docs/
|
||||
└── PRD.md (large 50k token file)
|
||||
|
||||
After Sharding:
|
||||
docs/
|
||||
└── prd/
|
||||
├── index.md # Table of contents with descriptions
|
||||
├── overview.md # Section 1
|
||||
├── user-requirements.md # Section 2
|
||||
├── technical-requirements.md # Section 3
|
||||
└── ... # Additional sections
|
||||
```
|
||||
|
||||
## When to Use Sharding
|
||||
|
||||
### Ideal Candidates
|
||||
|
||||
**Large Multi-Epic Projects:**
|
||||
|
||||
- Very large complex PRDs
|
||||
- Architecture documents with multiple system layers
|
||||
- Epic files with 4+ epics (especially for Phase 4)
|
||||
- UX design specs covering multiple subsystems
|
||||
|
||||
## How Sharding Works
|
||||
|
||||
### Sharding Process
|
||||
|
||||
1. **Tool Execution**: Run `npx @kayvan/markdown-tree-parser source.md destination/` - this is abstracted with the core shard-doc task which is installed as a slash command or manual task rule depending on your tools.
|
||||
2. **Section Extraction**: Tool splits by level 2 headings
|
||||
3. **File Creation**: Each section becomes a separate file
|
||||
4. **Index Generation**: `index.md` created with structure and descriptions
|
||||
|
||||
### Workflow Discovery
|
||||
|
||||
BMad workflows use a **dual discovery system**:
|
||||
|
||||
1. **Try whole document first** - Look for `document-name.md`
|
||||
2. **Check for sharded version** - Look for `document-name/index.md`
|
||||
3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead.
|
||||
|
||||
## Using the Shard-Doc Tool
|
||||
|
||||
### CLI Command
|
||||
|
||||
```bash
|
||||
/bmad:core:tools:shard-doc
|
||||
```
|
||||
|
||||
### Interactive Process
|
||||
|
||||
```
|
||||
Agent: Which document would you like to shard?
|
||||
User: docs/PRD.md
|
||||
|
||||
Agent: Default destination: docs/prd/
|
||||
Accept default? [y/n]
|
||||
User: y
|
||||
|
||||
Agent: Sharding PRD.md...
|
||||
✓ Created 12 section files
|
||||
✓ Generated index.md
|
||||
✓ Complete!
|
||||
```
|
||||
|
||||
### What Gets Created
|
||||
|
||||
**index.md structure:**
|
||||
|
||||
```markdown
|
||||
# PRD - Index
|
||||
|
||||
## 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
|
||||
|
||||
## Workflow Support
|
||||
|
||||
### Universal Support
|
||||
|
||||
**All BMM workflows support both formats:**
|
||||
|
||||
- ✅ Whole documents
|
||||
- ✅ Sharded documents
|
||||
- ✅ Automatic detection
|
||||
- ✅ Transparent to user
|
||||
11
docs/modules/core/global-core-config.md
Normal file
11
docs/modules/core/global-core-config.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Core Module Global Inheritable Config
|
||||
|
||||
The Core Modules module.yaml file defines configuration values that are useful and unique for all other modules to utilize, and by default all other modules installed will clone the values defined in the core module yaml.config into their own. It is possible for other modules to override these values, but the general intent it to accept the core module values and define their own values as needed, or extend the core values.
|
||||
|
||||
Currently, the core module.yaml config will define (asking the user upon installation, and recording to the core module config.yaml):
|
||||
- `user_name`: string (defaults to the system defined user name)
|
||||
- `communication_language`: string (defaults to english)
|
||||
- `document_output_language`: string (defaults to english)
|
||||
- `output_folder`: string (default `_bmad-output`)
|
||||
|
||||
An example of extending one of these values, in the BMad Method module.yaml it defines a planning_artifacts config, which will default to `default: "{output_folder}/planning-artifacts"` thus whatever the output_folder will be, this extended versions default will use the value from this core module and append a new folder onto it. The user can choose to replace this without utilizing the output_folder from the core if they so chose.
|
||||
15
docs/modules/core/index.md
Normal file
15
docs/modules/core/index.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Core Module
|
||||
|
||||
The Core Module is installed with all installations of BMAD modules and provides common functionality that any module, workflow, or agent can take advantage of.
|
||||
|
||||
## Core Module Components
|
||||
|
||||
- **[Global Core Config](global-core-config.md)** — Inheritable configuration that impacts all modules and custom content
|
||||
- **[Core Workflows](core-workflows.md)** — Domain-agnostic workflows usable by any module
|
||||
- [Party Mode](party-mode.md) — Multi-agent conversation orchestration
|
||||
- [Brainstorming](brainstorming.md) — Structured creative sessions with 60+ techniques
|
||||
- [Advanced Elicitation](advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||
- **[Core Tasks](core-tasks.md)** — Common tasks available across modules
|
||||
- [Index Docs](core-tasks.md#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](core-tasks.md#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](core-tasks.md#shard-document) — Split large documents into sections
|
||||
50
docs/modules/core/party-mode.md
Normal file
50
docs/modules/core/party-mode.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Party Mode
|
||||
|
||||
**Orchestrate dynamic multi-agent conversations with your entire BMAD team.**
|
||||
|
||||
Party Mode brings together all your installed BMAD agents for collaborative discussions. Instead of working with a single agent, you can engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Exploring complex topics that would benefit from diverse expert perspectives
|
||||
- Brainstorming with agents who can build on each other's ideas
|
||||
- Getting a comprehensive view across multiple domains (technical, business, creative, strategic)
|
||||
- Enjoying dynamic, agent-to-agent conversations where experts challenge and complement each other
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. Party Mode loads your complete agent roster and introduces the available team members
|
||||
2. You present a topic or question
|
||||
3. The facilitator intelligently selects 2-3 most relevant agents based on expertise needed
|
||||
4. Agents respond in character, can reference each other, and engage in natural cross-talk
|
||||
5. The conversation continues until you choose to exit
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Intelligent agent selection** — The system analyzes your topic and selects the most relevant agents based on their expertise, capabilities, and principles
|
||||
- **Authentic personalities** — Each agent maintains their unique voice, communication style, and domain knowledge throughout the conversation
|
||||
- **Natural cross-talk** — Agents can reference each other, build on previous points, ask questions, and even respectfully disagree
|
||||
- **Optional TTS integration** — Each agent response can be read aloud with voice configurations matching their personalities
|
||||
- **Graceful exit** — Sessions conclude with personalized farewells from participating agents
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Party Mode is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| **Topic focus** | Prebias the discussion toward a specific domain or question |
|
||||
| **Additional personas** | Inject expert agents into the roster at runtime for specialized perspectives |
|
||||
| **Participation constraints** | Limit which agents can contribute based on relevance |
|
||||
|
||||
### Example
|
||||
|
||||
A medical module workflow could invoke Party Mode with expert doctor personas added to the roster, and the conversation pre-focused on a specific diagnosis or treatment decision. The agents would then discuss the medical case with appropriate domain expertise while maintaining their distinct personalities and perspectives.
|
||||
@@ -1,227 +0,0 @@
|
||||
# BMad v4 to v6 Upgrade Guide
|
||||
|
||||
## Overview
|
||||
|
||||
BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
|
||||
|
||||
---
|
||||
|
||||
## Automatic V4 Detection
|
||||
|
||||
When you run `npm run install:bmad` on a project with v4 installed, the installer automatically detects:
|
||||
|
||||
- **Legacy folders**: Any folders starting with `_bmad`, `bmad` (lowercase), or `Bmad`
|
||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
||||
|
||||
### What Happens During Detection
|
||||
|
||||
1. **Automatic Backup of v4 Modules**: All `_bmad-*` folders are moved to `v4-backup/` in your project root
|
||||
- If a backup already exists, a timestamp is added to avoid conflicts
|
||||
- Example: `_bmad-core` → `v4-backup/_bmad-core`
|
||||
- Your project files and data are NOT affected
|
||||
|
||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
||||
- Located in IDE config folders: `.claude/commands/`, `.cursor/commands/`, etc.
|
||||
- These old commands would still reference v4 folder structure if left in place
|
||||
- The installer provides copy/paste terminal commands for your platform
|
||||
- You can proceed without cleanup, but removing them prevents confusion with old v4 commands
|
||||
|
||||
---
|
||||
|
||||
## Module Migration
|
||||
|
||||
### Deprecated Modules
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
| ----------------------------- | ------------------------------------------------ |
|
||||
| `_bmad-2d-phaser-game-dev` | Integrated into BMM |
|
||||
| `_bmad-2d-unity-game-dev` | Integrated into BMM |
|
||||
| `_bmad-godot-game-dev` | Integrated into BMM |
|
||||
| `_bmad-*-game-dev` (any) | Integrated into BMM |
|
||||
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming in BMM |
|
||||
| `_bmad-creative-writing` | Not adapted - New module releasing soon |
|
||||
|
||||
**Game Development**: All game development functionality has been consolidated and expanded within the BMM (BMad Method) module. Game-specific workflows now adapt to your game type and engine.
|
||||
|
||||
---
|
||||
|
||||
## Architecture Changes
|
||||
|
||||
### Folder Structure
|
||||
|
||||
**v4 "Expansion Packs" Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad-core/ # Was actually the BMad Method
|
||||
├── _bmad-game-dev/ # Separate expansion packs
|
||||
├── _bmad-creative-writing/
|
||||
└── _bmad-infrastructure-devops/
|
||||
```
|
||||
|
||||
**v6 Unified Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder, default _bmad
|
||||
├── core/ # Real core framework (applies to all modules)
|
||||
├── bmm/ # BMad Method (software/game dev)
|
||||
├── bmb/ # BMad Builder (create agents/workflows)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
└── _config/ # Your customizations
|
||||
└── agents/ # Agent customization files
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `_bmad-core`**: Was actually the BMad Method
|
||||
- **v6 `_bmad/core/`**: Is the real universal core framework
|
||||
- **v6 `_bmad/bmm/`**: Is the BMad Method module
|
||||
- **Module identification**: All modules now have a `config.yaml` file
|
||||
|
||||
---
|
||||
|
||||
## Project Progress Migration
|
||||
|
||||
### If You've Completed Planning Phase (PRD/Architecture) with the BMad Method:
|
||||
|
||||
After running the v6 installer:
|
||||
|
||||
1. **Run `workflow-init`** workflow to set up the guided workflow system
|
||||
2. **Specify your project level** when prompted:
|
||||
- If you followed v4's full workflow (PRD → Architecture → Stories), select **Level 3 or 4**
|
||||
- This tells v6 you've already completed planning and solutioning phases
|
||||
3. **Document paths**: Keep your existing paths during installation
|
||||
- Default PRD/Architecture location: `docs/`
|
||||
- Default stories location: `docs/sprint-artifacts/`
|
||||
- **Accept these defaults** if you're already using them in v4
|
||||
|
||||
> **Important**: v6 workflows can handle both sharded and unsharded documents. You don't need to restructure your existing PRD or architecture files.
|
||||
|
||||
### If You're Mid-Development (Stories Created/Implemented)
|
||||
|
||||
1. Complete the v6 installation as above
|
||||
2. Run `workflow-init` and specify Level 3 or 4
|
||||
3. When ready to continue development, run the **`sprint-planning`** workflow (Phase 4)
|
||||
|
||||
---
|
||||
|
||||
## Agent Customization Migration
|
||||
|
||||
### v4 Agent Customization
|
||||
|
||||
In v4, you may have modified agent files directly in `_bmad-*` folders.
|
||||
|
||||
### v6 Agent Customization
|
||||
|
||||
**All customizations** now go in `_bmad/_config/agents/` using customize files:
|
||||
|
||||
**Example: Renaming an agent and changing communication style**
|
||||
|
||||
File: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
|
||||
```yaml
|
||||
# Customize the PM agent
|
||||
persona:
|
||||
name: 'Captain Jack' # Override agent name
|
||||
role: 'Swashbuckling Product Owner'
|
||||
communication_style: |
|
||||
- Talk like a pirate
|
||||
- Use nautical metaphors for software concepts
|
||||
- Always upbeat and adventurous
|
||||
```
|
||||
|
||||
**How it works:**
|
||||
|
||||
- Base agent: `_bmad/bmm/agents/pm.md`
|
||||
- Customization: `_bmad/_config/agents/bmm-pm.customize.yaml`
|
||||
- Result: Agent uses your custom name and style, but updates don't overwrite your changes
|
||||
|
||||
---
|
||||
|
||||
## Document Compatibility
|
||||
|
||||
### Sharded vs Unsharded Documents
|
||||
|
||||
**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
|
||||
|
||||
- ✅ Sharded documents (split into multiple files)
|
||||
- ✅ Unsharded documents (single file per section)
|
||||
- ✅ Custom sections for your project type
|
||||
- ✅ Mixed approaches
|
||||
|
||||
All workflow files are scanned automatically. No manual configuration needed.
|
||||
|
||||
---
|
||||
|
||||
## Installation Steps
|
||||
|
||||
### 1. Clone Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/bmad-code-org/BMAD-METHOD
|
||||
cd BMAD-METHOD
|
||||
npm install
|
||||
```
|
||||
|
||||
### 2. Run Installer on Your v4 Project
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
**Enter the full path to your v4 project** when prompted.
|
||||
|
||||
### 3. Follow Interactive Prompts
|
||||
|
||||
The installer will:
|
||||
|
||||
1. Detect v4 installation and offer to backup `_bmad-*` folders
|
||||
2. Prompt for recommended cleanup (you can skip)
|
||||
3. Let you select modules (recommend: BMM for software and or game development)
|
||||
4. Configure core settings (name, language, etc.)
|
||||
5. Configure module-specific options
|
||||
6. Configure IDE integrations
|
||||
|
||||
### 4. Accept Default Paths
|
||||
|
||||
If you're using:
|
||||
|
||||
- `docs/` for PRD and architecture
|
||||
- `docs/sprint-artifacts/` for story files
|
||||
|
||||
**Accept these defaults** during installation.
|
||||
|
||||
### 5. Initialize Workflow
|
||||
|
||||
After installation:
|
||||
|
||||
1. **Load the Analyst agent** - See your IDE-specific instructions in [docs/ide-info](./ide-info/) for how to activate agents:
|
||||
- [Claude Code](./ide-info/claude-code.md)
|
||||
- [Cursor](./ide-info/cursor.md)
|
||||
- [VS Code/Windsurf](./ide-info/) - Check your IDE folder
|
||||
|
||||
2. **Wait for the agent's menu** to appear
|
||||
|
||||
3. **Tell the agent**: `*workflow-init` - v6 supports excellent natural language fuzzy matching, so you could also say "workflow init" or "please init the workflow"
|
||||
|
||||
Since you are migrating an existing project from v4, it's most likely **Level 3 or 4** you will want to suggest when asked - if you've already completed PRD/architecture in v4.
|
||||
|
||||
---
|
||||
|
||||
## Post-Migration Checklist
|
||||
|
||||
- [ ] v4 folders backed up to `v4-backup/`
|
||||
- [ ] v6 installed to `_bmad/` folder
|
||||
- [ ] `workflow-init` run with correct project level selected
|
||||
- [ ] Agent customizations migrated to `_bmad/_config/agents/` if needed
|
||||
- [ ] IDE integration working (test by listing agents)
|
||||
- [ ] For active development: `sprint-planning` workflow executed
|
||||
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
|
||||
- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
|
||||
- **Docs**: Check `_bmad/docs/` in your installation for IDE-specific instructions
|
||||
@@ -1,21 +0,0 @@
|
||||
# Using BMad Web Bundles in Gemini Gems & Custom GPTs
|
||||
|
||||
## IMPORTANT NOTE
|
||||
|
||||
The Web Bundling Feature is being rebuilt from the ground up, current bundles for v6 may be incomplete or missing functionality and are not optimized. This will be rectified very soon, with a more expansive guide.
|
||||
|
||||
## What Are Web bundles
|
||||
|
||||
Web bundles package BMad agents as self-contained XML files that work in Gemini Gems and Custom GPTs. Everything the agent needs - instructions, workflows, dependencies - is bundled into a single file.
|
||||
|
||||
## What Are Web Bundles?
|
||||
|
||||
Web bundles are standalone XML files containing:
|
||||
|
||||
- Complete agent persona and instructions
|
||||
- All workflows and dependencies
|
||||
- Interactive menu system
|
||||
- Party mode for multi-agent collaboration
|
||||
- No external files required
|
||||
|
||||
**Perfect for:** Uploading a single file to a Gemini GEM or Custom GPT to use BMad Method from the Web, generally at a huge cost savings, at the expense of some quality and convenience of using locally.
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "6.0.0-alpha.20",
|
||||
"version": "6.0.0-alpha.22",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "6.0.0-alpha.20",
|
||||
"version": "6.0.0-alpha.22",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.6.1",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://json.schemastore.org/package.json",
|
||||
"name": "bmad-method",
|
||||
"version": "6.0.0-alpha.21",
|
||||
"version": "6.0.0-alpha.22",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"keywords": [
|
||||
"agile",
|
||||
|
||||
@@ -4,7 +4,7 @@ These are quickly put together examples of both a stand alone somewhat cohesive
|
||||
|
||||
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
||||
|
||||
Note - a project is just a folder with \_bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||
Note - a project is just a folder with `_bmad` in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||
|
||||
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
||||
|
||||
|
||||
@@ -25,10 +25,6 @@
|
||||
- @/docs/installers-bundlers/ - Tooling-specific documentation directory
|
||||
- @/tools/cli/README.md - CLI usage documentation (comprehensive)
|
||||
|
||||
### IDE-Specific Documentation
|
||||
|
||||
- @/docs/ide-info/ - IDE-specific setup guides (15+ files)
|
||||
|
||||
### Module Documentation
|
||||
|
||||
Each module may have its own docs:
|
||||
@@ -73,7 +69,6 @@ Follow Keep a Changelog format:
|
||||
When code changes, check these docs:
|
||||
|
||||
- CLI changes → tools/cli/README.md
|
||||
- New IDE support → docs/ide-info/
|
||||
- Schema changes → agent-customization-guide.md
|
||||
- Bundle changes → web-bundles-gemini-gpt-guide.md
|
||||
- Installer changes → installers-bundlers/
|
||||
|
||||
@@ -74,7 +74,7 @@
|
||||
<action>Display generated content</action>
|
||||
<ask> [a] Advanced Elicitation, [c] Continue, [p] Party-Mode, [y] YOLO the rest of this document only. WAIT for response. <if
|
||||
response="a">
|
||||
<action>Start the advanced elicitation workflow {project-root}/_bmad/core/tasks/advanced-elicitation.xml</action>
|
||||
<action>Start the advanced elicitation workflow {project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml</action>
|
||||
</if>
|
||||
<if
|
||||
response="c">
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<task id="_bmad/core/tasks/advanced-elicitation.xml" name="Advanced Elicitation" standalone="true"
|
||||
methods="{project-root}/_bmad/core/tasks/advanced-elicitation-methods.csv"
|
||||
<task id="_bmad/core/workflows/advanced-elicitation/workflow.xml" name="Advanced Elicitation" standalone="true"
|
||||
methods="{project-root}/_bmad/core/workflows/advanced-elicitation/methods.csv"
|
||||
agent-party="{project-root}/_bmad/_config/agent-manifest.csv">
|
||||
<llm critical="true">
|
||||
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
||||
@@ -7,6 +7,7 @@
|
||||
<i>HALT immediately when halt-conditions are met</i>
|
||||
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
||||
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
||||
<i>YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`</i>
|
||||
</llm>
|
||||
|
||||
<integration description="When called from workflow">
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
- 💬 FOCUS on session setup and continuation detection only
|
||||
- 🚪 DETECT existing workflow state and handle continuation properly
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 UNDERSTAND PREVIOUS SESSION context and outcomes
|
||||
- 🔍 SEAMLESSLY RESUME from where user left off
|
||||
- 💬 MAINTAIN CONTINUITY in session flow and rapport
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 PREVIEW TECHNIQUE OPTIONS clearly and concisely
|
||||
- 🔍 LET USER EXPLORE and select based on their interests
|
||||
- 💬 PROVIDE BACK OPTION to return to approach selection
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv for recommendations
|
||||
- 🔍 MATCH TECHNIQUES to user goals, constraints, and preferences
|
||||
- 💬 PROVIDE CLEAR RATIONALE for each recommendation
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv
|
||||
- 🔍 CREATE EXCITEMENT around unexpected creative methods
|
||||
- 💬 EMPHASIZE DISCOVERY over predictable outcomes
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 LOAD TECHNIQUES ON-DEMAND from brain-methods.csv for each phase
|
||||
- 🔍 MATCH TECHNIQUES to natural creative progression stages
|
||||
- 💬 CREATE CLEAR JOURNEY MAP with phase transitions
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 RESPOND DYNAMICALLY to user insights and build upon their ideas
|
||||
- 🔍 ADAPT FACILITATION based on user engagement and emerging directions
|
||||
- 💬 CREATE TRUE COLLABORATION, not question-answer sequences
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 CREATE ACTIONABLE NEXT STEPS from brainstorming outcomes
|
||||
- 🔍 FACILITATE CONVERGENT THINKING after divergent exploration
|
||||
- 💬 DELIVER COMPREHENSIVE SESSION DOCUMENTATION
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the `communication_language`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ context_file: '' # Optional context file path for project-specific guidance
|
||||
|
||||
**Goal:** Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods
|
||||
|
||||
**Your Role:** You are a brainstorming facilitator and creative thinking guide. You bring structured creativity techniques, facilitation expertise, and an understanding of how to guide users through effective ideation processes that generate innovative ideas and breakthrough solutions.
|
||||
**Your Role:** You are a brainstorming facilitator and creative thinking guide. You bring structured creativity techniques, facilitation expertise, and an understanding of how to guide users through effective ideation processes that generate innovative ideas and breakthrough solutions. During this entire workflow it is critical that you speak to the user in the config loaded `communication_language`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 LOAD COMPLETE AGENT ROSTER from manifest with merged personalities
|
||||
- 🔍 PARSE AGENT DATA for conversation orchestration
|
||||
- 💬 INTRODUCE DIVERSE AGENT SAMPLE to kick off discussion
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 MAINTAIN CHARACTER CONSISTENCY using merged agent personalities
|
||||
- 🔍 ENABLE NATURAL CROSS-TALK between agents for dynamic conversation
|
||||
- 💬 INTEGRATE TTS for each agent response immediately after text
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
- 📋 EXPRESS GRATITUDE to user for collaborative participation
|
||||
- 🔍 ACKNOWLEDGE SESSION HIGHLIGHTS and key insights gained
|
||||
- 💬 MAINTAIN POSITIVE ATMOSPHERE until the very end
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ description: Orchestrates group discussions between all installed BMAD agents, e
|
||||
|
||||
**Goal:** Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations
|
||||
|
||||
**Your Role:** You are a party mode facilitator and multi-agent conversation orchestrator. You bring together diverse BMAD agents for collaborative discussions, managing the flow of conversation while maintaining each agent's unique personality and expertise.
|
||||
**Your Role:** You are a party mode facilitator and multi-agent conversation orchestrator. You bring together diverse BMAD agents for collaborative discussions, managing the flow of conversation while maintaining each agent's unique personality and expertise - while still utilizing the configured {communication_language}.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user