Skip to content

Commit 2d59d2e

Browse files
committed
Further docs cleanup: cut more redundancy, reorganize reference
- Delete what-to-build.md (duplicate of agent-or-module-decision) - Delete crafting-agent-principles.md (niche content) - Move workflow-patterns.md from explanation to reference (it's tables) - Delete custom-content-types.md and customize-workflows.md (redundant) - Delete communication-styles.md and workflow-schema.md from reference - Update all indexes to reflect changes
1 parent 01af6bf commit 2d59d2e

15 files changed

Lines changed: 22 additions & 520 deletions

docs/explanation/crafting-agent-principles.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/explanation/custom-content-types.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/explanation/customize-workflows.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

docs/explanation/facilitation-over-generation.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: "Facilitation Over Generation"
33
description: A facilitation-first approach to AI workflows
44
---
55

6-
BMad workflows facilitate discovery rather than generating solutions directly.
6+
BMad workflows are at their most powerful when they facilitate discovery rather than generating solutions directly. A prime example is the brainstorming workflow. If you have not tried it, it is work experiencing to see what true agent facilitation can feel like - putting the user in control and feeling like they are a partner with the LLM working together.
77

88
## Key Principles
99

1010
| Principle | Description |
1111
|-----------|-------------|
1212
| **Questions Over Answers** | Ask strategic questions, don't provide direct answers |
13-
| **Multi-Turn Conversation** | Ask 1-2 questions at a time, not laundry lists |
13+
| **Multi-Turn Conversation** | Ask 1-2 questions at a time, not laundry lists, its a conversation |
1414
| **Intent-Based Guidance** | Specify goals, not exact scripts |
1515
| **YOU Are the Expert** | You bring domain knowledge, workflow brings process |
1616

@@ -29,10 +29,6 @@ BMad workflows facilitate discovery rather than generating solutions directly.
2929
> "I need a UX design" → [Immediately generates complete specification]
3030
3131
**BMad Workflow:**
32-
> "I need a UX design" → "What documents do you have? What are the primary user goals? What makes your situation unique?"
32+
> "I need a UX design" → "What documents do you have? First lets understand what are the primary user goals? What makes your situation unique?" → user response → "Why is that X. Did you ever consider that Y and Z might?"
3333
34-
## Benefits
3534

36-
- **Deeper insights** connected to your actual knowledge
37-
- **Full ownership** of decisions
38-
- **More memorable** because you understand the "why"

docs/explanation/index.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,26 @@ Create custom agents, workflows, and modules for BMad.
99

1010
| Resource | Description |
1111
|----------|-------------|
12-
| **[Create a Custom Agent](/tutorials/create-custom-agent.md)** | Build your first AI agent |
13-
| **[Create Your First Workflow](/tutorials/create-your-first-workflow.md)** | Design structured workflows |
14-
| **[Create Your First Module](/tutorials/create-your-first-module.md)** | Package and publish modules |
12+
| **[Create a Custom Agent](/how-to/create-custom-agent.md)** | Build your first AI agent |
13+
| **[Create Your First Workflow](/how-to/create-your-first-workflow.md)** | Design structured workflows |
14+
| **[Bundle Your Creations](/how-to/bundle-your-creations.md)** | Package and install modules |
1515

1616
## Core Concepts
1717

1818
| Topic | Description |
1919
|-------|-------------|
20-
| **[What to Build](/explanation/what-to-build.md)** | Decide whether to build an agent, workflow, or module |
20+
| **[Agent or Module?](/how-to/agent-or-module-decision.md)** | Decide what to build first |
2121
| **[What Are Agents](/explanation/what-are-bmad-agents.md)** | AI personas with specialized capabilities |
2222
| **[What Are Workflows](/explanation/what-are-workflows.md)** | Structured step-by-step processes |
2323
| **[What Are Modules](/explanation/what-are-modules.md)** | Bundles of agents and workflows |
24-
| **[Custom Content Types](/explanation/custom-content-types.md)** | Content categories in BMad |
2524

2625
## Workflow Design
2726

2827
| Topic | Description |
2928
|-------|-------------|
30-
| **[Workflow Patterns](/explanation/workflow-patterns.md)** | Structure types, intent spectrum, and execution patterns |
31-
| **[Workflow Customization](/explanation/customize-workflows.md)** | Tri-modal structure and cross-mode integration |
29+
| **[Workflow Patterns](/reference/workflow-patterns.md)** | Structure types, intent spectrum, and execution patterns |
3230
| **[Plan for Iteration](/explanation/plan-for-workflows-skills-to-evolve.md)** | Iteration strategy for workflows |
3331

34-
## Agent Deep Dives
35-
36-
| Topic | Description |
37-
|-------|-------------|
38-
| **[Crafting Agent Principles](/explanation/crafting-agent-principles.md)** | Write effective principles that activate expert knowledge |
39-
4032
## Architecture & Process
4133

4234
| Topic | Description |

docs/explanation/module-building-architecture.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,4 @@ your-module/
4848
| Agents | `bmad-bmb-create-agent` |
4949
| Workflows | `bmad-bmb-create-workflow` |
5050

51-
**What gets created:** Full agent files, detailed workflow steps, actual functionality
52-
53-
## Common Confusions
54-
55-
| Confusion | Reality |
56-
|-----------|----------|
57-
| Module builder creates agents | Creates agent specs — you build actual agents |
58-
| Write prompts in the brief | Brief defines WHAT, prompts come later |
59-
| Module is done after scaffolding | Scaffolding creates structure, not content |
51+
**What gets created:** Full agent files, detailed workflow steps, actual functionality

docs/explanation/what-are-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Modules"
33
---
44

5-
Modules are bundles of agents, workflows, and configuration that solve specific problems.
5+
Modules are bundles of agents, workflows, and configuration that solve specific problems or serve a cohesive purpose. What makes modules unique from say generic skill plugin packs is that they integrate together with other modules and cohesively meld into the bmad help and recommendation engine and workflow sequencing!
66

77
## What Is a Module?
88

docs/explanation/what-to-build.md

Lines changed: 0 additions & 66 deletions
This file was deleted.

docs/reference/communication-styles.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/reference/global-config.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ Configuration values defined in Core that all modules inherit.
1717
## Inheritance
1818

1919
Modules can accept defaults, override values, or extend them using `{output_folder}`.
20+
21+
## Your New Module Config
22+
23+
You define new variables. So when your module is used, you have access to all core module values, and your own. If you also extend a module using the `extends-module` config in the module config, then you will additionally have access to those also from your custom workflow that is part of the module.

0 commit comments

Comments
 (0)