Skip to content

Commit 3ec004f

Browse files
Brian MadisonBrian Madison
authored andcommitted
minor doc updates
1 parent ddc8006 commit 3ec004f

3 files changed

Lines changed: 60 additions & 249 deletions

File tree

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: "Agents"
33
---
44

5-
Agents are AI assistants that help you accomplish tasks. Each agent has a unique personality, specialized capabilities, and an interactive menu.
5+
BMad Agents are AI Persona files that your agent can adopt to better help you accomplish tasks, communicate with or enjoy. Each agent has a unique personality, specialized capabilities, and an interactive help menu.
6+
7+
Additionally some agents can optionally have their own file system based memory, making them capable of remembering vast amounts of information that is relevant. This can open up many interesting use cases for you to explore.
68

79
## Agent Types
810

@@ -29,19 +31,18 @@ Simple agents are complete in a single file. They excel at well-defined tasks an
2931
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.
3032

3133
**Best for:**
32-
- Domain specialists (security architect, game designer, product manager)
33-
- Tasks requiring persistent memory
34-
- Complex workflows with multiple stages
35-
- Projects that grow over time
34+
- Domain specialists (design, legal, therapy, companion)
35+
- Agents with built in commands defined in separate files that only they will utilize - these are gemerally more complex than the simple one or two line prompts for simple agent custom menu items
36+
- Note: These commands will be launched by loading the agent - another option is to create a simple agent and skills separately.
3637

37-
**Example:** A game architect that remembers your design decisions, maintains consistency across sprints, and coordinates with other specialists.
38+
**Example:** An accounting expert that has specialized workflows to guide you through tax preparation, but also remembers work you have done together before, and remembers details about you.
3839

3940
## Key Differences
4041

4142
| Feature | Simple | Expert |
4243
| ---------------- | -------------- | -------------------------- |
4344
| **Files** | Single file | Agent + sidecar folder |
44-
| **Memory** | Session only | Persistent across sessions |
45+
| **Memory** | Usually no | Persistent across sessions |
4546
| **Capabilities** | Focused scope | Multi-domain, extensible |
4647
| **Setup** | Zero config | Sidecar initialization |
4748
| **Best Use** | Specific tasks | Ongoing projects |
@@ -60,10 +61,10 @@ All agents share these building blocks:
6061
- Skills, tools, and knowledge the agent can apply
6162
- Mapped to specific menu commands
6263

63-
### Menu
64+
### Menu Items
6465
- Interactive command list
6566
- Triggers, descriptions, and handlers
66-
- Auto-includes help and exit options
67+
- Auto-includes help, chat, bmad-help and exit options
6768

6869
### Critical Actions (optional)
6970
- Instructions that execute before the agent starts
@@ -75,23 +76,6 @@ All agents share these building blocks:
7576
Choose **Simple** for focused, one-off tasks with no memory needs. Choose **Expert** when you need persistent context and complex workflows.
7677
:::
7778

78-
**Choose Simple when:**
79-
- You need a task done quickly and reliably
80-
- The scope is well-defined and won't change much
81-
- You don't need the agent to remember things between sessions
82-
83-
**Choose Expert when:**
84-
- You're building something complex over time
85-
- The agent needs to maintain context (project history, decisions)
86-
- You want the agent to coordinate workflows or other agents
87-
- Domain expertise requires specialized knowledge bases
88-
8979
## Creating Custom Agents
9080

91-
BMad provides the **BMad Builder (BMB)** module for creating your own agents. See the [Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md) for step-by-step instructions.
92-
93-
94-
95-
## Customizing Existing Agents
96-
97-
You can modify any agent's behavior without editing core files. See [BMad Customization](/docs/how-to/customization/index.md) 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.
81+
See the [Agent Creation Guide](https://github.com/bmad-code-org/bmad-builder/blob/main/docs/tutorials/create-custom-agent.md) for step-by-step instructions on how to create your own agents and use them in the BMad Ecosystem.

docs/explanation/what-are-modules.md

Lines changed: 19 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,84 +2,37 @@
22
title: "Modules"
33
---
44

5-
Modules are organized collections of agents and workflows that solve specific problems or address particular domains.
5+
Modules are bundles of agents, workflows, and configuration that solve specific problems or address particular domains. Think of them like plugins or extensions—packaged capabilities you can install to extend what's possible.
66

7-
## What is a Module?
7+
## What Is a Module?
88

99
A module is a self-contained package that includes:
1010

11-
- **Agents** - Specialized AI assistants
12-
- **Workflows** - Step-by-step processes
13-
- **Configuration** - Module-specific settings
14-
- **Documentation** - Usage guides and reference
11+
- **Agents** Specialized AI assistants with specific roles
12+
- **Workflows** Step-by-step processes for accomplishing tasks
13+
- **Configuration** Module settings and variables
14+
- **Documentation** Usage guides and reference
1515

16-
## Official BMad Method and Builder Modules
16+
When you install a module, all its agents and workflows become available as commands.
17+
18+
## Official Modules
1719

1820
:::note[Core is Always Installed]
19-
The Core module is automatically included with every BMad installation. It provides the foundation that other modules build upon.
21+
The Core module comes with every BMad installation and provides the foundation other modules build upon.
2022
:::
2123

22-
### Core Module
23-
Always installed, provides shared functionality:
24-
- Global configuration
25-
- Core workflows (Party Mode, Advanced Elicitation, Brainstorming)
26-
- Common tasks (document indexing, sharding, review)
27-
28-
### BMad Method (BMM)
29-
Software and game development:
30-
- Project planning workflows
31-
- Implementation agents (Dev, PM, QA, Scrum Master)
32-
- Testing and architecture guidance
33-
34-
### BMad Builder (BMB)
35-
Create custom solutions:
36-
- Agent creation workflows
37-
- Workflow authoring tools
38-
- Module scaffolding
39-
40-
## Additional Official BMad Modules
41-
42-
These are officially maintained modules by BMad but have their own repo's and docs.
43-
These give a good idea also of what can be done with the BMad builder and creating your own custom modules.
44-
45-
### Creative Intelligence Suite (CIS)
46-
Innovation and creativity:
47-
- Creative thinking techniques
48-
- Innovation strategy workflows
49-
- Storytelling and ideation
50-
- [Available Here](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite)
51-
52-
### BMad Game Dev (BMGD)
53-
Game development specialization:
54-
- Game design workflows
55-
- Narrative development
56-
- Performance testing frameworks
57-
- [Available Here](https://github.com/bmad-code-org/bmad-module-game-dev-studio)
58-
59-
## Module Structure
60-
61-
Installed modules follow this structure:
62-
63-
```
64-
_bmad/
65-
├── core/ # Always present
66-
├── bmm/ # BMad Method (if installed)
67-
├── bmb/ # BMad Builder (if installed)
68-
├── cis/ # Creative Intelligence (if installed)
69-
└── bmgd/ # Game Dev (if installed)
70-
```
24+
| Module | Purpose |
25+
|--------|---------|
26+
| **Core** | Global configuration, common workflows (Brainstorming, Party Mode), shared tasks |
27+
| **BMM** (Method) | Software and game development—planning, implementation agents, architecture |
28+
| **BMB** (Builder) | Creating custom agents, workflows, and modules |
29+
| **CIS** (Creative Intelligence) | Innovation, creativity techniques, storytelling, ideation |
30+
| **BMGD** (Game Dev) | Game design workflows, narrative development, performance testing |
7131

7232
## Custom Modules
7333

74-
You can create your own modules containing:
75-
- Custom agents for your domain
76-
- Organizational workflows
77-
- Team-specific configurations
78-
79-
Custom modules are installed the same way as official modules.
34+
You can create your own modules for your domain—team-specific workflows, organizational agents, custom configurations. They install the same way as official modules.
8035

8136
## Installing Modules
8237

83-
During BMad installation, you choose which modules to install. You can also add or remove modules later by re-running the installer.
84-
85-
See [Installation Guide](/docs/how-to/installation/index.md) for details.
38+
Choose which modules to install during setup, or add/remove modules later by re-running the installer. See [Installation Guide](/docs/how-to/install-custom-modules.md) for details.

0 commit comments

Comments
 (0)