Skip to content

Commit b46409e

Browse files
Brian MadisonBrian Madison
authored andcommitted
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.
1 parent 8cffd09 commit b46409e

37 files changed

+3901
-1473
lines changed

docs/bmad-core-concepts/agents.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Agents
2+
3+
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
4+
5+
## Agent Types
6+
7+
BMAD has two primary agent types, designed for different use cases:
8+
9+
### Simple Agents
10+
11+
**Self-contained, focused, ready to use.**
12+
13+
Simple agents are complete in a single file. They excel at well-defined tasks and require minimal setup.
14+
15+
**Best for:**
16+
- Single-purpose assistants (code review, documentation, commit messages)
17+
- Quick deployment
18+
- Projects that don't require persistent memory
19+
- Getting started fast
20+
21+
**Example:** A commit message agent that reads your git diff and generates conventional commits.
22+
23+
### Expert Agents
24+
25+
**Powerful, memory-equipped, domain specialists.**
26+
27+
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.
28+
29+
**Best for:**
30+
- Domain specialists (security architect, game designer, product manager)
31+
- Tasks requiring persistent memory
32+
- Complex workflows with multiple stages
33+
- Projects that grow over time
34+
35+
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
36+
37+
## Key Differences
38+
39+
| Feature | Simple | Expert |
40+
| ---------------- | -------------- | -------------------------- |
41+
| **Files** | Single file | Agent + sidecar folder |
42+
| **Memory** | Session only | Persistent across sessions |
43+
| **Capabilities** | Focused scope | Multi-domain, extensible |
44+
| **Setup** | Zero config | Sidecar initialization |
45+
| **Best Use** | Specific tasks | Ongoing projects |
46+
47+
## Agent Components
48+
49+
All agents share these building blocks:
50+
51+
### Persona
52+
- **Role** - What the agent does (expertise domain)
53+
- **Identity** - Who the agent is (personality, character)
54+
- **Communication Style** - How the agent speaks (tone, voice)
55+
- **Principles** - Why the agent acts (values, decision framework)
56+
57+
### Capabilities
58+
- Skills, tools, and knowledge the agent can apply
59+
- Mapped to specific menu commands
60+
61+
### Menu
62+
- Interactive command list
63+
- Triggers, descriptions, and handlers
64+
- Auto-includes help and exit options
65+
66+
### Critical Actions (optional)
67+
- Instructions that execute before the agent starts
68+
- Enable autonomous behaviors (e.g., "check git status before changes")
69+
70+
## Which Should You Use?
71+
72+
**Choose Simple when:**
73+
- You need a task done quickly and reliably
74+
- The scope is well-defined and won't change much
75+
- You don't need the agent to remember things between sessions
76+
77+
**Choose Expert when:**
78+
- You're building something complex over time
79+
- The agent needs to maintain context (project history, decisions)
80+
- You want the agent to coordinate workflows or other agents
81+
- Domain expertise requires specialized knowledge bases
82+
83+
## Creating Custom Agents
84+
85+
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.
86+
87+
## Customizing Existing Agents
88+
89+
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.
90+
91+
---
92+
93+
**Next:** Learn about [Workflows](./workflows.md) to see how agents accomplish complex tasks.

docs/bmad-customization/agent-customization-guide.md renamed to docs/bmad-core-concepts/bmad-customization/agents.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,8 @@ memories:
203203

204204
## Next Steps
205205

206-
- **[BMM Agents Guide](./modules/bmm/agents-guide)** - Learn about the BMad Method agents
207-
- **[BMB Create Agent Workflow](./modules/bmb/agents/index)** - Build completely custom agents
208-
- **[BMM Complete Documentation](./modules/bmm/index)** - Full BMad Method reference
206+
- **[Learn about Agents](../agents.md)** - Understand Simple vs Expert agents
207+
- **[Agent Creation Guide](../../modules/bmb-bmad-builder/agent-creation-guide.md)** - Build completely custom agents
208+
- **[BMM Complete Documentation](../../modules/bmm-bmad-method/index)** - Full BMad Method reference
209+
210+
[← Back to Customization](./index.md)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# BMAD Customization
2+
3+
Personalize agents and workflows to match your needs.
4+
5+
## Guides
6+
7+
| Guide | Description |
8+
|-------|-------------|
9+
| **[Agent Customization](./agents.md)** | Modify agent behavior without editing core files |
10+
| **[Workflow Customization](./workflows.md)** | Customize and optimize workflows |
11+
12+
## Overview
13+
14+
BMAD provides two main customization approaches:
15+
16+
### Agent Customization
17+
Modify any agent's persona, name, capabilities, or menu items using `.customize.yaml` files in `_bmad/_config/agents/`. Your customizations persist through updates.
18+
19+
### Workflow Customization
20+
Replace or extend workflow steps to create tailored processes. (Coming soon)
21+
22+
---
23+
24+
**Next:** Read the [Agent Customization Guide](./agents.md) to start personalizing your agents.
25+
26+
[← Back to Core Concepts](../index.md)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Workflow Customization Guide
2+
3+
Customize and optimize workflows with step replacement and hooks.
4+
5+
## Status
6+
7+
> **Coming Soon:** Workflow customization is an upcoming capability. This guide will be updated when the feature is available.
8+
9+
## What to Expect
10+
11+
Workflow customization will allow you to:
12+
13+
- **Replace Steps** - Swap out specific workflow steps with custom implementations
14+
- **Add Hooks** - Inject custom behavior before/after workflow steps
15+
- **Extend Workflows** - Create new workflows based on existing ones
16+
- **Override Behavior** - Customize workflow logic for your project's needs
17+
18+
## For Now
19+
20+
While workflow customization is in development, you can:
21+
22+
- **Create Custom Workflows** - Use the BMAD Builder to create entirely new workflows
23+
- **Customize Agents** - Modify agent behavior using [Agent Customization](./agents.md)
24+
- **Provide Feedback** - Share your workflow customization needs with the community
25+
26+
---
27+
28+
**In the meantime:** Learn how to [create custom workflows](../../modules/bmb-bmad-builder/index) from scratch.
29+
30+
[← Back to Customization](./index.md)

docs/bmad-core-concepts/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# BMAD Core Concepts
2+
3+
Understanding the fundamental building blocks of the BMAD Method.
4+
5+
## The Essentials
6+
7+
| Concept | Description | Guide |
8+
|---------|-------------|-------|
9+
| **Agents** | AI assistants with personas, capabilities, and menus | [Agents Guide](./agents.md) |
10+
| **Workflows** | Structured processes for achieving specific outcomes | [Workflows Guide](./workflows.md) |
11+
| **Modules** | Packaged collections of agents and workflows | [Modules Guide](./modules.md) |
12+
13+
## Getting Started
14+
15+
### New to BMAD?
16+
Start here to understand what BMAD is and how it works:
17+
18+
1. **[Agents Guide](./agents.md)** - Learn about Simple and Expert agents
19+
2. **[Workflows Guide](./workflows.md)** - Understand how workflows orchestrate tasks
20+
3. **[Modules Guide](./modules.md)** - See how modules organize functionality
21+
22+
### Installing BMAD
23+
24+
- **[Installation Guide](./installing/)** - Set up BMAD in your project
25+
- **[Upgrading from v4](./installing/upgrading.md)** - Migrate from earlier versions
26+
27+
### Configuration
28+
29+
- **[BMAD Customization](./bmad-customization/)** - Personalize agents and workflows
30+
31+
### Advanced
32+
33+
- **[Web Bundles](./web-bundles/)** - Use BMAD in Gemini Gems and Custom GPTs
34+
35+
---
36+
37+
**Next:** Read the [Agents Guide](./agents.md) to understand the core building block of BMAD.

docs/installing-bmad.md renamed to docs/bmad-core-concepts/installing/index.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Installation
22

3+
Get BMAD up and running in your project.
4+
5+
## Upgrading?
6+
7+
If you're upgrading from v4, see the [Upgrade Guide](./upgrading.md).
8+
9+
---
10+
311
## Quick Install
412

513
```bash
@@ -52,8 +60,9 @@ your-project/
5260

5361
## Next Steps
5462

55-
1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature
56-
2. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology
63+
1. **Read the [Quick Start Guide](../../modules/bmm-bmad-method/quick-start)** to build your first feature
64+
2. **Explore [Workflows](../../modules/bmm-bmad-method/index#-workflow-guides)** to understand the methodology
65+
3. **Learn about [Agents](../agents.md)** to understand BMAD's core building blocks
5766

5867
## Troubleshooting
5968

docs/v4-to-v6-upgrade.md renamed to docs/bmad-core-concepts/installing/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ persona:
120120
- Always upbeat and adventurous
121121
```
122122
123-
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)
123+
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)
124124
125125
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.
126126

docs/bmad-core-concepts/modules.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Modules
2+
3+
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
4+
5+
## What is a Module?
6+
7+
A module is a self-contained package that includes:
8+
9+
- **Agents** - Specialized AI assistants
10+
- **Workflows** - Step-by-step processes
11+
- **Configuration** - Module-specific settings
12+
- **Documentation** - Usage guides and reference
13+
14+
## Official Modules
15+
16+
### Core Module
17+
Always installed, provides shared functionality:
18+
- Global configuration
19+
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
20+
- Common tasks (document indexing, sharding, review)
21+
22+
### BMAD Method (BMM)
23+
Software and game development:
24+
- Project planning workflows
25+
- Implementation agents (Dev, PM, QA, Scrum Master)
26+
- Testing and architecture guidance
27+
28+
### BMAD Builder (BMB)
29+
Create custom solutions:
30+
- Agent creation workflows
31+
- Workflow authoring tools
32+
- Module scaffolding
33+
34+
### Creative Intelligence Suite (CIS)
35+
Innovation and creativity:
36+
- Creative thinking techniques
37+
- Innovation strategy workflows
38+
- Storytelling and ideation
39+
40+
### BMAD Game Dev (BMGD)
41+
Game development specialization:
42+
- Game design workflows
43+
- Narrative development
44+
- Performance testing frameworks
45+
46+
## Module Structure
47+
48+
Installed modules follow this structure:
49+
50+
```
51+
_bmad/
52+
├── core/ # Always present
53+
├── bmm/ # BMAD Method (if installed)
54+
├── bmb/ # BMAD Builder (if installed)
55+
├── cis/ # Creative Intelligence (if installed)
56+
└── bmgd/ # Game Dev (if installed)
57+
```
58+
59+
## Custom Modules
60+
61+
You can create your own modules containing:
62+
- Custom agents for your domain
63+
- Organizational workflows
64+
- Team-specific configurations
65+
66+
Custom modules are installed the same way as official modules.
67+
68+
## Installing Modules
69+
70+
During BMAD installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
71+
72+
See [Installation Guide](./installing/) for details.
73+
74+
---
75+
76+
**Next:** Read the [Installation Guide](./installing/) to set up BMAD with the modules you need.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Web Bundles
2+
3+
Use BMAD agents in Gemini Gems and Custom GPTs.
4+
5+
## Status
6+
7+
> **Note:** The Web Bundling Feature is being rebuilt from the ground up. Current v6 bundles may be incomplete or missing functionality.
8+
9+
## What Are Web Bundles?
10+
11+
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.
12+
13+
### What's Included
14+
15+
- Complete agent persona and instructions
16+
- All workflows and dependencies
17+
- Interactive menu system
18+
- Party mode for multi-agent collaboration
19+
- No external files required
20+
21+
### Use Cases
22+
23+
**Perfect for:**
24+
- Uploading a single file to a Gemini GEM or Custom GPT
25+
- Using BMAD Method from the Web
26+
- Cost savings (generally lower cost than local usage)
27+
- Quick sharing of agent configurations
28+
29+
**Trade-offs:**
30+
- Some quality reduction vs local usage
31+
- Less convenient than full local installation
32+
- Limited to agent capabilities (no workflow file access)
33+
34+
[← Back to Core Concepts](../index.md)

0 commit comments

Comments
 (0)