Skip to content

Commit 9951736

Browse files
Brian MadisonBrian Madison
authored andcommitted
some early doc updates
1 parent 3ec004f commit 9951736

8 files changed

Lines changed: 186 additions & 369 deletions

docs/explanation/custom-content-types.md

Lines changed: 35 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -2,128 +2,79 @@
22
title: "Custom Content"
33
---
44

5-
BMad supports several categories of custom content that extend the platform's capabilities from simple personal agents to full-featured professional modules.
5+
BMad supports several categories of custom content that extend the platform's capabilities. This ranges from simple personal agents to full-featured professional modules.
66

7-
:::tip[Recommended Approach]
8-
Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content.
9-
:::
7+
## Overview
108

11-
This flexibility enables:
9+
This flexibility lets you:
1210

13-
- Extensions and add-ons for existing modules (BMad Method, Creative Intelligence Suite)
11+
- Extensions and add-ons for existing modules
1412
- Completely new modules, workflows, templates, and agents outside software engineering
1513
- Professional services tools
16-
- Entertainment and educational content
17-
- Science and engineering workflows
18-
- Productivity and self-help solutions
1914
- Role-specific augmentation for virtually any profession
2015

21-
## Categories
16+
:::tip[Recommended Approach]
17+
Use the BMad Builder (BoMB) Module for guided workflows and expertise when creating custom content.
18+
:::
19+
20+
## Module Categories
2221

23-
- [Categories](#categories)
24-
- [Custom Stand-Alone Modules](#custom-stand-alone-modules)
25-
- [Custom Add-On Modules](#custom-add-on-modules)
26-
- [Custom Global Modules](#custom-global-modules)
27-
- [Custom Agents](#custom-agents)
28-
- [BMad Tiny Agents](#bmad-tiny-agents)
29-
- [Simple and Expert Agents](#simple-and-expert-agents)
30-
- [Custom Workflows](#custom-workflows)
22+
BMad supports three types of custom modules, plus standalone agents and workflows:
3123

32-
## Custom Stand-Alone Modules
24+
- **Custom Stand-Alone Modules**: Independent systems that work on their own
25+
- **Custom Add-On Modules**: Extensions that enhance another module
26+
- **Custom Global Modules**: Cross-cutting functionality for all installed content
3327

34-
Custom modules range from simple collections of related agents, workflows, and tools designed to work independently, to complex, expansive systems like the BMad Method or even larger applications.
28+
### Custom Stand-Alone Modules
3529

36-
Custom modules are [installable](/docs/how-to/installation/install-custom-modules.md) using the standard BMad method and support advanced features:
30+
Custom modules range from simple collections of related agents, workflows, and tools to complex systems like the BMad Method or even larger applications.
3731

38-
- Optional user information collection during installation/updates
32+
Custom modules are [installable](/docs/how-to/install-custom-modules.md) using the standard BMad method and support advanced features:
33+
34+
- Optional user information collection during installation and updates
3935
- Versioning and upgrade paths
4036
- Custom installer functions with IDE-specific post-installation handling (custom hooks, subagents, or vendor-specific tools)
4137
- Ability to bundle specific tools such as MCP, skills, execution libraries, and code
4238

43-
## Custom Add-On Modules
44-
45-
Custom Add-On Modules contain specific agents, tools, or workflows that expand, modify, or customize another module but cannot exist or install independently. These add-ons provide enhanced functionality while leveraging the base module's existing capabilities.
39+
### Custom Add-On Modules
4640

47-
Examples include:
41+
Custom add-on modules contain specific agents, tools, or workflows that expand, modify, or customize another module. They cannot be installed or used independently. These add-ons provide enhanced functionality by using the base module's existing capabilities.
4842

49-
- Alternative implementation workflows for BMad Method agents
50-
- Framework-specific support for particular use cases
51-
- Game development expansions that add new genre-specific capabilities without reinventing existing functionality
43+
Examples include the core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities.
5244

5345
Add-on modules can include:
5446

5547
- Custom agents with awareness of the target module
5648
- Access to existing module workflows
57-
- Tool-specific features such as rulesets, hooks, subprocess prompts, subagents, and more
58-
59-
## Custom Global Modules
60-
61-
Similar to Custom Stand-Alone Modules, but designed to add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem.
62-
63-
Examples include:
64-
65-
- The core module, which is always installed and provides all agents with party mode and advanced elicitation capabilities
66-
- Installation and update tools that work with any BMad method configuration
49+
- Tool-specific features such as rulesets, hooks, subprocess prompts, and subagents
6750

68-
Upcoming standards will document best practices for building global content that affects installed modules through:
51+
### Custom Global Modules
6952

70-
- Custom content injections
71-
- Agent customization auto-injection
72-
- Tooling installers
53+
Global modules are similar to stand-alone modules, but they add functionality that applies across all installed content. These modules provide cross-cutting capabilities that enhance the entire BMad ecosystem.
7354

74-
## Custom Agents
55+
Examples include installation and update tools that work with any BMad method configuration.
7556

76-
Custom Agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions.
57+
## Building Blocks
7758

78-
### BMad Tiny Agents
59+
### Custom Agents
7960

80-
Personal agents designed for highly specific needs that may not be suitable for sharing. For example, a team management agent living in an Obsidian vault that helps with:
81-
82-
- Team coordination and management
83-
- Understanding team details and requirements
84-
- Tracking specific tasks with designated tools
85-
86-
These are simple, standalone files that can be scoped to focus on specific data or paths when integrated into an information vault or repository.
87-
88-
### Simple and Expert Agents
89-
90-
The distinction between simple and expert agents lies in their structure:
91-
92-
**Simple Agent:**
93-
94-
- Single file containing all prompts and configuration
95-
- Self-contained and straightforward
96-
97-
**Expert Agent:**
98-
99-
- Similar to simple agents but includes a sidecar folder
100-
- Sidecar folder contains additional resources: custom prompt files, scripts, templates, and memory files
101-
- When installed, the sidecar folder (`[agentname]-sidecar`) is placed in the user memory location
102-
- has metadata type: expert
103-
104-
:::note[Key Distinction]
105-
The key distinction is the presence of a sidecar folder. As web and consumer agent tools evolve to support common memory mechanisms, storage formats, and MCP, the writable memory files will adapt to support these evolving standards.
106-
:::
107-
108-
Custom agents can be:
61+
Custom agents can be designed and built for various use cases, from one-off specialized agents to more generic standalone solutions. Custom agents can be:
10962

11063
- Used within custom modules
11164
- Designed as standalone tools
112-
- Integrated with existing workflows and systems, if this is to be the case, should also include a module: <module name> if a specific module is intended for it to require working with
65+
- Integrated with existing workflows and modules
11366

114-
## Custom Workflows
67+
### Custom Workflows
11568

116-
Workflows are powerful, progressively loading sequence engines capable of performing tasks ranging from simple to complex, including:
69+
Workflows range from simple single-file prompts to progressively loading sequence engines that can perform tasks including:
11770

118-
- User engagements
71+
- User facilitation and engagement
11972
- Business processes
12073
- Content generation (code, documentation, or other output formats)
74+
- Utility functions and processes
12175

122-
A custom workflow created outside of a larger module can still be distributed and used without associated agents through:
123-
124-
- Slash commands
125-
- Manual command/prompt execution when supported by tools
76+
A custom workflow created outside of a larger module can still be distributed and used without associated agents through slash commands.
12677

12778
:::tip[Core Concept]
128-
At its core, a custom workflow is a single or series of prompts designed to achieve a specific outcome.
79+
At its core, a custom workflow is a single prompt or series of prompts made to achieve a specific outcome. It is installed as a command or a skill.
12980
:::

docs/explanation/customize-workflows.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,3 @@ Workflow customization will allow you to:
1818
- **Add Hooks** - Inject custom behavior before/after workflow steps
1919
- **Extend Workflows** - Create new workflows based on existing ones
2020
- **Override Behavior** - Customize workflow logic for your project's needs
21-
22-
## For Now
23-
24-
While workflow customization is in development, you can:
25-
26-
- **Create Custom Workflows** - Use the BMad Builder to create entirely new workflows
27-
- **Customize Agents** - Modify agent behavior using [Agent Customization](/docs/how-to/customization/customize-agents.md)
28-
- **Provide Feedback** - Share your workflow customization needs with the community
29-
30-
**In the meantime:** Learn how to [create custom workflows](/docs/explanation/bmad-builder/index.md) from scratch.

0 commit comments

Comments
 (0)