mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
agent create workflow overhaul to use data files efficiently. updated and created separate user guides for the create agent workflow along with general concept docs of what an agent and workflow are in regards to0 bmad generally.
This commit is contained in:
Brian Madison
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.
|
||||
@@ -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.
|
||||
@@ -1,5 +1,13 @@
|
||||
# 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
|
||||
@@ -52,8 +60,9 @@ your-project/
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature
|
||||
2. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology
|
||||
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
|
||||
|
||||
@@ -120,7 +120,7 @@ persona:
|
||||
- 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/agent-customization-guide.md)
|
||||
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.
|
||||
|
||||
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,3 +0,0 @@
|
||||
# Workflow Customization Guide
|
||||
|
||||
Coming Soon...
|
||||
111
docs/index.md
111
docs/index.md
@@ -1,91 +1,95 @@
|
||||
# BMad Documentation Index
|
||||
# BMAD Documentation
|
||||
|
||||
## Core Documentation
|
||||
Complete documentation for the BMAD Method.
|
||||
|
||||
### Project-Level Docs (Root)
|
||||
## Getting Started
|
||||
|
||||
- **[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
|
||||
### New to BMAD?
|
||||
Start with the core concepts to understand how BMAD works:
|
||||
|
||||
### Installation & Setup
|
||||
- **[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
|
||||
|
||||
- **[Quick Installation](./installing-bmad.md)** - Add BMad official and custom modules to a project folder.
|
||||
- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
|
||||
- **[Document Sharding Guide](modules/core/document-sharding-guide.md)** - Split large documents
|
||||
- **[Bundle Distribution Setup](../tools/docs/BUNDLE_DISTRIBUTION_SETUP.md)** - (temporarily non-functional) Maintainer guide for bundle auto-publishing
|
||||
### Upgrading from v4?
|
||||
- **[v4 to v6 Upgrade Guide](./bmad-core-concepts/installing/upgrading.md)** - Migration path for v4 users
|
||||
|
||||
---
|
||||
|
||||
## Module Documentation
|
||||
|
||||
### Core Module Global Entities
|
||||
|
||||
- **[Core Module Index](./modules/core/index)** — Shared functionality available to all modules
|
||||
- [Global Core Config](./modules/core/global-core-config.md) — Inheritable configuration impacting all modules and custom content
|
||||
- [Core Workflows](./modules/core/core-workflows.md) — Domain-agnostic workflows usable by any module
|
||||
- [Party Mode](./modules/core/party-mode.md) — Multi-agent conversation orchestration
|
||||
- [Brainstorming](./modules/core/brainstorming.md) — Structured creative sessions with 60+ techniques
|
||||
- [Advanced Elicitation](./modules/core/advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||
- [Core Tasks](./modules/core/core-tasks.md) — Common tasks available across modules
|
||||
- [Index Docs](./modules/core/core-tasks.md#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](./modules/core/core-tasks.md#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](./modules/core/core-tasks.md#shard-document) — Split large documents into sections
|
||||
|
||||
### BMad Method (BMM) - Software & Game Development
|
||||
### BMAD Method (BMM) - Software & Game Development
|
||||
|
||||
The flagship module for agile AI-driven development.
|
||||
|
||||
- **[BMM Module Index](./modules/bmm-bmad-method/index)** - Module overview, agents, and complete documentation index
|
||||
- [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Step-by-step guide to building your first project
|
||||
- **[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**
|
||||
- **[Test Architect Guide](./modules/bmm-bmad-method/test-architecture)** - Testing strategy and quality assurance
|
||||
- **[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-bmad-builder/index)** - Module overview and capabilities
|
||||
- **[Custom Content Guide](./modules/bmb-bmad-builder/custom-content)** - Design custom agents, workflows, and modules
|
||||
- **[How to Install Custom Agents, Workflows and Modules](./modules/bmb-bmad-builder/custom-content-installation.md)** - Share and Install Custom Creations
|
||||
- **[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
|
||||
|
||||
- **[CIS Docs](./modules/cis-creative-intelligence-suite/index.md)**
|
||||
- **[CIS Documentation](./modules/cis-creative-intelligence-suite/index)**
|
||||
|
||||
#### Bmad Game Dev (BMGD)
|
||||
### BMAD Game Dev (BMGD)
|
||||
|
||||
- [Main Game Dev Module Docs Index](./modules/bmgd-bmad-game-dev/index.md)
|
||||
- **[BMGD Documentation](./modules/bmgd-bmad-game-dev/index)** - Game development workflows
|
||||
|
||||
AI-powered creative thinking and brainstorming.
|
||||
---
|
||||
|
||||
- **[CIS Module README](./modules/cis-creative-intelligence-suite/index)** - Module overview and workflows
|
||||
## Core Module
|
||||
|
||||
### Global Core Entities
|
||||
|
||||
- **[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
|
||||
|
||||
### Custom Agents, Workflow and Modules
|
||||
- **[Custom Content Installation](modules/bmb-bmad-builder/custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
|
||||
- [Agent Customization Guide](./bmad-customization/agent-customization-guide.md) - Customize agent behavior and responses
|
||||
- [Workflow Customization Guide](./bmad-customization/workflow-customization-guide.md) - Customize and Optimize workflows with step replacement and hooks (Capability Coming Soon)
|
||||
### Customization
|
||||
|
||||
- **[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
|
||||
|
||||
### 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-bmad-method/quick-start) - Get hands-on
|
||||
3. [BMM Module README](./modules/bmm-bmad-method/) - Understand agents
|
||||
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-bmad-method/quick-start) - Get hands-on
|
||||
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
|
||||
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
|
||||
|
||||
@@ -95,14 +99,13 @@ AI-powered creative thinking and brainstorming.
|
||||
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-bmad-builder/index) - Understand capabilities
|
||||
2. [BMB Custom Content Types](./modules/bmb-bmad-builder/custom-content.md) - Understand the different types and whats possible
|
||||
3. [BMB Content Installation](./modules/bmb-bmad-builder/custom-content-installation.md) - How to bundle install use and share
|
||||
4. More Docs coming soon....
|
||||
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)
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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 found for v6 may be incomplete or missing functionality and are not optimized.
|
||||
|
||||
## 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 Are Web Bundles?
|
||||
|
||||
Web bundles are standalone 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.
|
||||
Reference in New Issue
Block a user