mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-01-30 04:32:02 +00:00
advanced elicitation moved to workflows folder. core module extensive documentation added.
This commit is contained in:
3
docs/bmad-customization/workflow-customization-guide.md
Normal file
3
docs/bmad-customization/workflow-customization-guide.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Workflow Customization Guide
|
||||
|
||||
Coming Soon...
|
||||
@@ -1,18 +1,6 @@
|
||||
# BMad Documentation Index
|
||||
|
||||
## 🎯 Getting Started (Start Here!)
|
||||
|
||||
**New users:** Start with one of these based on your situation:
|
||||
|
||||
| Your Situation | Start Here | Then Read |
|
||||
| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| **Brand new to BMad** | [Quick Start Guide](bmm/quick-start) | [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) |
|
||||
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](./modules/bmm/quick-start) |
|
||||
| **Brownfield project** | [Brownfield Guide](./modules/bmm/brownfield-guide) | [Quick Start Guide](./modules/bmm/quick-start) |
|
||||
|
||||
---
|
||||
|
||||
## 📋 Core Documentation
|
||||
## Core Documentation
|
||||
|
||||
### Project-Level Docs (Root)
|
||||
|
||||
@@ -22,13 +10,25 @@
|
||||
|
||||
### Installation & Setup
|
||||
|
||||
- **[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](./document-sharding-guide.md)** - Split large documents for 90%+ token savings
|
||||
- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents
|
||||
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - (temporarily non-functional) Maintainer guide for bundle auto-publishing
|
||||
|
||||
---
|
||||
## Module Documentation
|
||||
|
||||
## 🏗️ 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
|
||||
|
||||
@@ -47,25 +47,24 @@ The flagship module for agile AI-driven development.
|
||||
|
||||
Build your own agents, workflows, and modules.
|
||||
|
||||
- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents
|
||||
- **[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
|
||||
|
||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||
|
||||
AI-powered creative thinking and brainstorming.
|
||||
|
||||
- **[CIS Module README](./modules/cis/)** - Module overview and workflows
|
||||
- **[CIS Module README](./modules/cis-creative-intelligence-suite/index)** - Module overview and workflows
|
||||
|
||||
## 🔧 Advanced Topics
|
||||
## 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)
|
||||
|
||||
- **[Custom Content Installation](./custom-content-installation.md)** - Install and personalize agents, workflows and modules with the default bmad-method installer!
|
||||
- [Agent Customization Guide](./agent-customization-guide.md) - Customize agent behavior and responses
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Recommended Reading Paths
|
||||
## Recommended Reading Paths
|
||||
|
||||
### Path 1: Brand New to BMad (Software Project)
|
||||
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
# Installation
|
||||
|
||||
Get BMAD Method running in your project in under 2 minutes.
|
||||
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
@@ -10,9 +8,11 @@ npx bmad-method install
|
||||
|
||||
This interactive installer will:
|
||||
|
||||
1. Detect your IDE (Claude Code, Cursor, VS Code, etc.)
|
||||
2. Let you choose which modules to install
|
||||
3. Configure agents and workflows for your project
|
||||
1. Let you choose a location to install to
|
||||
2. Let you choose which Agentic LLM Tools you would like to use (Such as Claude Code, Cursor, Windsurf, etc...)
|
||||
3. Let you choose which official modules to install (BMad Method, Creative Intelligence suite, BMad Builder)
|
||||
4. Let you choose any custom local modules, workflows or agents to install
|
||||
5. Let you configure each module or quickly accept the default recommended settings for each selected model
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
This guide explains how to create and install custom BMAD content including agents, workflows, and modules. Custom content extends BMAD's functionality with specialized tools and workflows that can be shared across projects or teams.
|
||||
|
||||
For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
|
||||
For detailed information about the different types of custom content available, see [Custom Content](modules/bmb-bmad-builder/custom-content.md).
|
||||
|
||||
You can find example custom modules in the `samples/sample-custom-modules/` folder of the repository. Download either of the sample folders to try them out.
|
||||
|
||||
55
docs/modules/bmb-bmad-builder/index.md
Normal file
55
docs/modules/bmb-bmad-builder/index.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# BMB Module Documentation
|
||||
|
||||
Reference documentation for building BMAD agents and workflows.
|
||||
|
||||
## Agent Architecture
|
||||
|
||||
Comprehensive guides for each agent type (choose based on use case):
|
||||
|
||||
- [Understanding Agent Types](./understanding-agent-types.md) - **START HERE** - Architecture vs capability, "The Same Agent, Three Ways"
|
||||
- [Simple Agent Architecture](./simple-agent-architecture.md) - Self-contained, optimized, personality-driven
|
||||
- [Expert Agent Architecture](./expert-agent-architecture.md) - Memory, sidecar files, domain restrictions
|
||||
- Module Agent Architecture _(TODO)_ - Workflow integration, professional tools
|
||||
|
||||
## Agent Design Patterns
|
||||
|
||||
- [Agent Menu Patterns](./agent-menu-patterns.md) - Menu handlers, triggers, prompts, organization
|
||||
- [Agent Compilation](./agent-compilation.md) - What compiler auto-injects (AVOID DUPLICATION)
|
||||
|
||||
## Reference Examples
|
||||
|
||||
Production-ready examples in [bmb/reference/agents/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents):
|
||||
|
||||
**Simple Agents** ([simple-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/simple-examples))
|
||||
|
||||
- [commit-poet.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml) - Commit message artisan with style customization
|
||||
|
||||
**Expert Agents** ([expert-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples))
|
||||
|
||||
- [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper) - Personal journal companion with memory and pattern recognition
|
||||
|
||||
**Module Agents** ([module-examples/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/module-examples))
|
||||
|
||||
- [security-engineer.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml) - BMM security specialist with threat modeling
|
||||
- [trend-analyst.agent.yaml](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/trend-analyst.agent.yaml) - CIS trend intelligence expert
|
||||
|
||||
## Installation Guide
|
||||
|
||||
For installing standalone simple and expert agents, see:
|
||||
|
||||
- [Custom Agent Installation](/docs/modules/bmb-bmad-builder/custom-content-installation.md)
|
||||
|
||||
## Key Concepts
|
||||
|
||||
### YAML to XML Compilation
|
||||
|
||||
Agents are authored in YAML with Handlebars templating. The compiler auto-injects:
|
||||
|
||||
1. **Frontmatter** - Name and description from metadata
|
||||
2. **Activation Block** - Steps, menu handlers, rules (YOU don't write this)
|
||||
3. **Menu Enhancement** - `*help` and `*exit` commands added automatically
|
||||
4. **Trigger Prefixing** - Your triggers auto-prefixed with `*`
|
||||
|
||||
**Critical:** See [Agent Compilation](./agent-compilation.md) to avoid duplicating auto-injected content.
|
||||
|
||||
Source: `tools/cli/lib/agent/compiler.js`
|
||||
149
docs/modules/cis-creative-intelligence-suite/index.md
Normal file
149
docs/modules/cis-creative-intelligence-suite/index.md
Normal file
@@ -0,0 +1,149 @@
|
||||
# CIS - Creative Intelligence Suite
|
||||
|
||||
AI-powered creative facilitation transforming strategic thinking through expert coaching across five specialized domains.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Core Capabilities](#core-capabilities)
|
||||
- [Specialized Agents](#specialized-agents)
|
||||
- [Interactive Workflows](#interactive-workflows)
|
||||
- [Quick Start](#quick-start)
|
||||
- [Key Differentiators](#key-differentiators)
|
||||
- [Configuration](#configuration)
|
||||
|
||||
## Core Capabilities
|
||||
|
||||
CIS provides structured creative methodologies through distinctive agent personas who act as master facilitators, drawing out insights through strategic questioning rather than generating solutions directly.
|
||||
|
||||
## Specialized Agents
|
||||
|
||||
- **Carson** - Brainstorming Specialist (energetic facilitator)
|
||||
- **Maya** - Design Thinking Maestro (jazz-like improviser)
|
||||
- **Dr. Quinn** - Problem Solver (detective-scientist hybrid)
|
||||
- **Victor** - Innovation Oracle (bold strategic precision)
|
||||
- **Sophia** - Master Storyteller (whimsical narrator)
|
||||
|
||||
## Interactive Workflows
|
||||
|
||||
[View all workflows →](../workflows/README.md)
|
||||
|
||||
**5 Workflows** with **150+ Creative Techniques:**
|
||||
|
||||
### Brainstorming
|
||||
|
||||
36 techniques across 7 categories for ideation
|
||||
|
||||
- Divergent/convergent thinking
|
||||
- Lateral connections
|
||||
- Forced associations
|
||||
|
||||
### Design Thinking
|
||||
|
||||
Complete 5-phase human-centered process
|
||||
|
||||
- Empathize → Define → Ideate → Prototype → Test
|
||||
- User journey mapping
|
||||
- Rapid iteration
|
||||
|
||||
### Problem Solving
|
||||
|
||||
Systematic root cause analysis
|
||||
|
||||
- 5 Whys, Fishbone diagrams
|
||||
- Solution generation
|
||||
- Impact assessment
|
||||
|
||||
### Innovation Strategy
|
||||
|
||||
Business model disruption
|
||||
|
||||
- Blue Ocean Strategy
|
||||
- Jobs-to-be-Done
|
||||
- Disruptive innovation patterns
|
||||
|
||||
### Storytelling
|
||||
|
||||
25 narrative frameworks
|
||||
|
||||
- Hero's Journey
|
||||
- Story circles
|
||||
- Compelling pitch structures
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Direct Workflow
|
||||
|
||||
```bash
|
||||
# Start interactive session
|
||||
workflow brainstorming
|
||||
|
||||
# With context document
|
||||
workflow design-thinking --data /path/to/context.md
|
||||
```
|
||||
|
||||
### Agent-Facilitated
|
||||
|
||||
```bash
|
||||
# Load agent
|
||||
agent cis/brainstorming-coach
|
||||
|
||||
# Start workflow
|
||||
> *brainstorm
|
||||
```
|
||||
|
||||
## Key Differentiators
|
||||
|
||||
- **Facilitation Over Generation** - Guides discovery through questions
|
||||
- **Energy-Aware Sessions** - Adapts to engagement levels
|
||||
- **Context Integration** - Domain-specific guidance support
|
||||
- **Persona-Driven** - Unique communication styles
|
||||
- **Rich Method Libraries** - 150+ proven techniques
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `/_bmad/cis/config.yaml`:
|
||||
|
||||
```yaml
|
||||
output_folder: ./creative-outputs
|
||||
user_name: Your Name
|
||||
communication_language: english
|
||||
```
|
||||
|
||||
## Module Structure
|
||||
|
||||
```
|
||||
cis/
|
||||
├── agents/ # 5 specialized facilitators
|
||||
├── workflows/ # 5 interactive processes
|
||||
│ ├── brainstorming/
|
||||
│ ├── design-thinking/
|
||||
│ ├── innovation-strategy/
|
||||
│ ├── problem-solving/
|
||||
│ └── storytelling/
|
||||
├── tasks/ # Supporting operations
|
||||
└── teams/ # Agent collaborations
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
CIS workflows integrate with:
|
||||
|
||||
- **BMM** - Powers project brainstorming
|
||||
- **BMB** - Creative module design
|
||||
- **Custom Modules** - Shared creative resource
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Set clear objectives** before starting sessions
|
||||
2. **Provide context documents** for domain relevance
|
||||
3. **Trust the process** - Let facilitation guide you
|
||||
4. **Take breaks** when energy flags
|
||||
5. **Document insights** as they emerge
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
||||
|
||||
---
|
||||
|
||||
Part of BMad Method v6.0 - Transform creative potential through expert AI facilitation.
|
||||
105
docs/modules/core/advanced-elicitation.md
Normal file
105
docs/modules/core/advanced-elicitation.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Advanced Elicitation
|
||||
|
||||
**Push the LLM to rethink its work through 50+ reasoning methods—essentially, LLM brainstorming.**
|
||||
|
||||
Advanced Elicitation is the inverse of Brainstorming. Instead of pulling ideas out of you, the LLM applies sophisticated reasoning techniques to re-examine and enhance content it has just generated. It's the LLM brainstorming with itself to find better approaches, uncover hidden issues, and discover improvements it missed on the first pass.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- After a workflow generates a section of content and you want to explore alternatives
|
||||
- When the LLM's initial output seems adequate but you suspect there's more depth available
|
||||
- For high-stakes content where multiple perspectives would strengthen the result
|
||||
- To stress-test assumptions, explore edge cases, or find weaknesses in generated plans
|
||||
- When you want the LLM to "think again" but with structured reasoning methods
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Context Analysis
|
||||
The LLM analyzes the current content, understanding its type, complexity, stakeholder needs, risk level, and creative potential.
|
||||
|
||||
### 2. Smart Method Selection
|
||||
Based on context, 5 methods are intelligently selected from a library of 50+ techniques and presented to you:
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | ---------------------------------------- |
|
||||
| **1-5** | Apply the selected method to the content |
|
||||
| **[r] Reshuffle** | Get 5 new methods selected randomly |
|
||||
| **[a] List All** | Browse the complete method library |
|
||||
| **[x] Proceed** | Continue with enhanced content |
|
||||
|
||||
### 3. Method Execution & Iteration
|
||||
- The selected method is applied to the current content
|
||||
- Improvements are shown for your review
|
||||
- You choose whether to apply changes or discard them
|
||||
- The menu re-appears for additional elicitations
|
||||
- Each method builds on previous enhancements
|
||||
|
||||
### 4. Party Mode Integration (Optional)
|
||||
If Party Mode is active, BMAD agents participate randomly in the elicitation process, adding their unique perspectives to the methods.
|
||||
|
||||
---
|
||||
|
||||
## Method Categories
|
||||
|
||||
| Category | Focus | Example Methods |
|
||||
| ----------------- | ----------------------------------- | -------------------------------------------------------------- |
|
||||
| **Core** | Foundational reasoning techniques | First Principles Analysis, 5 Whys, Socratic Questioning |
|
||||
| **Collaboration** | Multiple perspectives and synthesis | Stakeholder Round Table, Expert Panel Review, Debate Club |
|
||||
| **Advanced** | Complex reasoning frameworks | Tree of Thoughts, Graph of Thoughts, Self-Consistency |
|
||||
| **Competitive** | Adversarial stress-testing | Red Team vs Blue Team, Shark Tank Pitch, Code Review Gauntlet |
|
||||
| **Technical** | Architecture and code quality | Decision Records, Rubber Duck Debugging, Algorithm Olympics |
|
||||
| **Creative** | Innovation and lateral thinking | SCAMPER, Reverse Engineering, Random Input Stimulus |
|
||||
| **Research** | Evidence-based analysis | Literature Review Personas, Thesis Defense, Comparative Matrix |
|
||||
| **Risk** | Risk identification and mitigation | Pre-mortem Analysis, Failure Mode Analysis, Chaos Monkey |
|
||||
| **Learning** | Understanding verification | Feynman Technique, Active Recall Testing |
|
||||
| **Philosophical** | Conceptual clarity | Occam's Razor, Ethical Dilemmas |
|
||||
| **Retrospective** | Reflection and lessons | Hindsight Reflection, Lessons Learned Extraction |
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **50+ reasoning methods** — Spanning core logic to advanced multi-step reasoning frameworks
|
||||
- **Smart context selection** — Methods chosen based on content type, complexity, and stakeholder needs
|
||||
- **Iterative enhancement** — Each method builds on previous improvements
|
||||
- **User control** — Accept or discard each enhancement before proceeding
|
||||
- **Party Mode integration** — Agents can participate when Party Mode is active
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Advanced Elicitation is a core workflow designed to be invoked by other workflows during content generation:
|
||||
|
||||
| Parameter | Description |
|
||||
| ---------------------- | --------------------------------------------------------- |
|
||||
| **Content to enhance** | The current section content that was just generated |
|
||||
| **Context type** | The kind of content being created (spec, code, doc, etc.) |
|
||||
| **Enhancement goals** | What the calling workflow wants to improve |
|
||||
|
||||
### Integration Flow
|
||||
|
||||
When called from a workflow:
|
||||
1. Receives the current section content that was just generated
|
||||
2. Applies elicitation methods iteratively to enhance that content
|
||||
3. Returns the enhanced version when user selects 'x' to proceed
|
||||
4. The enhanced content replaces the original section in the output document
|
||||
|
||||
### Example
|
||||
|
||||
A specification generation workflow could invoke Advanced Elicitation after producing each major section (requirements, architecture, implementation plan). The workflow would pass the generated section, and Advanced Elicitation would offer methods like "Stakeholder Round Table" to gather diverse perspectives on requirements, or "Red Team vs Blue Team" to stress-test the architecture for vulnerabilities.
|
||||
|
||||
---
|
||||
|
||||
## Advanced Elicitation vs. Brainstorming
|
||||
|
||||
| | **Advanced Elicitation** | **Brainstorming** |
|
||||
| ------------ | ------------------------------------------------- | --------------------------------------------- |
|
||||
| **Source** | LLM generates ideas through structured reasoning | User provides ideas, AI coaches them out |
|
||||
| **Purpose** | Rethink and improve LLM's own output | Unlock user's creativity |
|
||||
| **Methods** | 50+ reasoning and analysis techniques | 60+ ideation and creativity techniques |
|
||||
| **Best for** | Enhancing generated content, finding alternatives | Breaking through blocks, generating new ideas |
|
||||
100
docs/modules/core/brainstorming.md
Normal file
100
docs/modules/core/brainstorming.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Brainstorming
|
||||
|
||||
**Facilitate structured creative sessions using 60+ proven ideation techniques.**
|
||||
|
||||
The Brainstorming workflow is an interactive facilitation system that helps you unlock your own creativity. The AI acts as coach, guide, and creative partner—using proven techniques to draw out ideas and insights that are already within you.
|
||||
|
||||
**Important:** Every idea comes from you. The workflow creates the conditions for your best thinking to emerge through guided exploration, but you are the source.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Breaking through creative blocks on a specific challenge
|
||||
- Generating innovative ideas for products, features, or solutions
|
||||
- Exploring a problem from completely new angles
|
||||
- Systematically developing ideas from raw concepts to actionable plans
|
||||
- Team ideation (with collaborative techniques) or personal creative exploration
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
### 1. Session Setup
|
||||
Define your topic, goals, and any constraints.
|
||||
|
||||
### 2. Choose Your Approach
|
||||
|
||||
| Approach | Description |
|
||||
|----------|-------------|
|
||||
| **User-Selected** | Browse the full technique library and pick what appeals to you |
|
||||
| **AI-Recommended** | Get customized technique suggestions based on your goals |
|
||||
| **Random Selection** | Discover unexpected methods through serendipitous technique combinations |
|
||||
| **Progressive Flow** | Journey systematically from expansive exploration to focused action planning |
|
||||
|
||||
### 3. Interactive Facilitation
|
||||
Work through techniques with true collaborative coaching. The AI asks probing questions, builds on your ideas, and helps you think deeper—but your ideas are the source.
|
||||
|
||||
### 4. Idea Organization
|
||||
All your generated ideas are organized into themes and prioritized.
|
||||
|
||||
### 5. Action Planning
|
||||
Top ideas get concrete next steps, resource requirements, and success metrics.
|
||||
|
||||
---
|
||||
|
||||
## What You Get
|
||||
|
||||
A comprehensive session document that captures the entire journey:
|
||||
|
||||
- Topic, goals, and session parameters
|
||||
- Each technique used and how it was applied
|
||||
- Your contributions and the ideas you generated
|
||||
- Thematic organization connecting related insights
|
||||
- Prioritized ideas with action plans
|
||||
- Session highlights and key breakthroughs
|
||||
|
||||
This document becomes a permanent record of your creative process—valuable for future reference, sharing with stakeholders, or continuing the session later.
|
||||
|
||||
---
|
||||
|
||||
## Technique Categories
|
||||
|
||||
| Category | Focus |
|
||||
|----------|-------|
|
||||
| **Collaborative** | Team dynamics and inclusive participation |
|
||||
| **Creative** | Breakthrough thinking and paradigm shifts |
|
||||
| **Deep** | Root cause analysis and strategic insight |
|
||||
| **Structured** | Organized frameworks and systematic exploration |
|
||||
| **Theatrical** | Playful, radical perspectives |
|
||||
| **Wild** | Boundary-pushing, extreme thinking |
|
||||
| **Biomimetic** | Nature-inspired solutions |
|
||||
| **Quantum** | Quantum principles for innovation |
|
||||
| **Cultural** | Traditional knowledge and cross-cultural approaches |
|
||||
| **Introspective Delight** | Inner wisdom and authentic exploration |
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Interactive coaching** — Pulls ideas *out* of you, doesn't generate them for you
|
||||
- **On-demand loading** — Techniques loaded from a comprehensive library as needed
|
||||
- **Session preservation** — Every step, insight, and action plan is documented
|
||||
- **Continuation support** — Pause sessions and return later, or extend with additional techniques
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Brainstorming is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| **Topic focus** | What the brainstorming should help discover or solve |
|
||||
| **Guardrails** | Constraints, boundaries, or must-avoid areas |
|
||||
| **Output goals** | What the final output needs to accomplish for the calling workflow |
|
||||
| **Context files** | Project-specific guidance to inform technique selection |
|
||||
|
||||
### Example
|
||||
|
||||
When creating a new module in the BMad Builder workflow, Brainstorming can be invoked with guardrails around the module's purpose and a goal to discover key features, user needs, or architectural considerations. The session becomes focused on producing exactly what the module creation workflow needs.
|
||||
64
docs/modules/core/core-tasks.md
Normal file
64
docs/modules/core/core-tasks.md
Normal file
@@ -0,0 +1,64 @@
|
||||
# Core Tasks
|
||||
|
||||
Core Tasks are reusable task definitions that can be invoked by any BMAD module, workflow, or agent. These tasks provide standardized functionality for common operations.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Index Docs](#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](#shard-document) — Split large documents into sections
|
||||
|
||||
---
|
||||
|
||||
## Index Docs
|
||||
|
||||
**Generates or updates an index.md file documenting all documents in a specified directory.**
|
||||
|
||||
This task scans a target directory, reads file contents to understand their purpose, and creates a well-organized index with accurate descriptions. Files are grouped by type, purpose, or subdirectory, and descriptions are generated from actual content rather than guessing from filenames.
|
||||
|
||||
**Use it when:** You need to create navigable documentation for a folder of markdown files, or you want to maintain an updated index as content evolves.
|
||||
|
||||
**How it works:**
|
||||
1. Scan the target directory for files and subdirectories
|
||||
2. Group content by type, purpose, or location
|
||||
3. Read each file to generate brief (3-10 word) descriptions based on actual content
|
||||
4. Create or update index.md with organized listings using relative paths
|
||||
|
||||
**Output format:** A markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
||||
|
||||
---
|
||||
|
||||
## Adversarial Review (General)
|
||||
|
||||
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
||||
|
||||
This task applies adversarial thinking to content review—approaching the material with the assumption that problems exist. It's designed to find what's missing, not just what's wrong, and produces at least ten specific findings. The reviewer adopts a professional but skeptical tone, looking for gaps, inconsistencies, oversights, and areas that need clarification.
|
||||
|
||||
**Use it when:** You need a critical eye on code diffs, specifications, user stories, documentation, or any artifact before finalizing. It's particularly valuable before merging code, releasing documentation, or considering a specification complete.
|
||||
|
||||
**How it works:**
|
||||
1. Load the content to review (diff, branch, uncommitted changes, document, etc.)
|
||||
2. Perform adversarial analysis with extreme skepticism—assume problems exist
|
||||
3. Find at least ten issues to fix or improve
|
||||
4. Output findings as a markdown list
|
||||
|
||||
**Note:** This task is designed to run in a separate subagent/process with read access to the project but no prior context, ensuring an unbiased review.
|
||||
|
||||
---
|
||||
|
||||
## Shard Document
|
||||
|
||||
**Splits large markdown documents into smaller, organized files based on level 2 (##) sections.**
|
||||
|
||||
Uses the `@kayvan/markdown-tree-parser` tool to automatically break down large documents into a folder structure. Each level 2 heading becomes a separate file, and an index.md is generated to tie everything together. This makes large documents more maintainable and allows for easier navigation and updates to individual sections.
|
||||
|
||||
**Use it when:** A markdown file has grown too large to effectively work with, or you want to break a monolithic document into manageable sections that can be edited independently.
|
||||
|
||||
**How it works:**
|
||||
1. Confirm source document path and verify it's a markdown file
|
||||
2. Determine destination folder (defaults to same location as source, folder named after document)
|
||||
3. Execute the sharding command using npx @kayvan/markdown-tree-parser
|
||||
4. Verify output files and index.md were created
|
||||
5. Handle the original document—delete, move to archive, or keep with warning
|
||||
|
||||
**Handling the original:** After sharding, the task prompts you to delete, archive, or keep the original document. Deleting or archiving is recommended to avoid confusion and ensure updates happen in the sharded files only.
|
||||
30
docs/modules/core/core-workflows.md
Normal file
30
docs/modules/core/core-workflows.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# Core Workflows
|
||||
|
||||
Core Workflows are domain-agnostic workflows that can be utilized by any BMAD-compliant module, workflow, or agent. These workflows are installed by default and available at any time.
|
||||
|
||||
## Available Core Workflows
|
||||
|
||||
### [Party Mode](party-mode.md)
|
||||
|
||||
Orchestrate dynamic multi-agent conversations with your entire BMAD team. Engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
||||
|
||||
### [Brainstorming](brainstorming.md)
|
||||
|
||||
Facilitate structured creative sessions using 60+ proven ideation techniques. The AI acts as coach and guide, using proven creativity methods to draw out ideas and insights that are already within you.
|
||||
|
||||
### [Advanced Elicitation](advanced-elicitation.md)
|
||||
|
||||
Push the LLM to rethink its work through 50+ reasoning methods—the inverse of brainstorming. The LLM applies sophisticated techniques to re-examine and enhance content it has just generated, essentially "LLM brainstorming" to find better approaches and uncover improvements.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Core Workflows are designed to be invoked and configured by other modules. When called from another workflow, they accept contextual parameters to customize the session:
|
||||
|
||||
- **Topic focus** — Direct the session toward a specific domain or question
|
||||
- **Additional personas** (Party Mode) — Inject expert agents into the roster at runtime
|
||||
- **Guardrails** (Brainstorming) — Set constraints and boundaries for ideation
|
||||
- **Output goals** — Define what the final output needs to accomplish
|
||||
|
||||
This allows modules to leverage these workflows' capabilities while maintaining focus on their specific domain and objectives.
|
||||
11
docs/modules/core/global-core-config.md
Normal file
11
docs/modules/core/global-core-config.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Core Module Global Inheritable Config
|
||||
|
||||
The Core Modules module.yaml file defines configuration values that are useful and unique for all other modules to utilize, and by default all other modules installed will clone the values defined in the core module yaml.config into their own. It is possible for other modules to override these values, but the general intent it to accept the core module values and define their own values as needed, or extend the core values.
|
||||
|
||||
Currently, the core module.yaml config will define (asking the user upon installation, and recording to the core module config.yaml):
|
||||
- `user_name`: string (defaults to the system defined user name)
|
||||
- `communication_language`: string (defaults to english)
|
||||
- `document_output_language`: string (defaults to english)
|
||||
- `output_folder`: string (default `_bmad-output`)
|
||||
|
||||
An example of extending one of these values, in the BMad Method module.yaml it defines a planning_artifacts config, which will default to `default: "{output_folder}/planning-artifacts"` thus whatever the output_folder will be, this extended versions default will use the value from this core module and append a new folder onto it. The user can choose to replace this without utilizing the output_folder from the core if they so chose.
|
||||
15
docs/modules/core/index.md
Normal file
15
docs/modules/core/index.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Core Module
|
||||
|
||||
The Core Module is installed with all installations of BMAD modules and provides common functionality that any module, workflow, or agent can take advantage of.
|
||||
|
||||
## Core Module Components
|
||||
|
||||
- **[Global Core Config](global-core-config.md)** — Inheritable configuration that impacts all modules and custom content
|
||||
- **[Core Workflows](core-workflows.md)** — Domain-agnostic workflows usable by any module
|
||||
- [Party Mode](party-mode.md) — Multi-agent conversation orchestration
|
||||
- [Brainstorming](brainstorming.md) — Structured creative sessions with 60+ techniques
|
||||
- [Advanced Elicitation](advanced-elicitation.md) — LLM rethinking with 50+ reasoning methods
|
||||
- **[Core Tasks](core-tasks.md)** — Common tasks available across modules
|
||||
- [Index Docs](core-tasks.md#index-docs) — Generate directory index files
|
||||
- [Adversarial Review](core-tasks.md#adversarial-review-general) — Critical content review
|
||||
- [Shard Document](core-tasks.md#shard-document) — Split large documents into sections
|
||||
50
docs/modules/core/party-mode.md
Normal file
50
docs/modules/core/party-mode.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Party Mode
|
||||
|
||||
**Orchestrate dynamic multi-agent conversations with your entire BMAD team.**
|
||||
|
||||
Party Mode brings together all your installed BMAD agents for collaborative discussions. Instead of working with a single agent, you can engage with multiple specialized perspectives simultaneously—each agent maintaining their unique personality, expertise, and communication style.
|
||||
|
||||
---
|
||||
|
||||
## When to Use It
|
||||
|
||||
- Exploring complex topics that would benefit from diverse expert perspectives
|
||||
- Brainstorming with agents who can build on each other's ideas
|
||||
- Getting a comprehensive view across multiple domains (technical, business, creative, strategic)
|
||||
- Enjoying dynamic, agent-to-agent conversations where experts challenge and complement each other
|
||||
|
||||
---
|
||||
|
||||
## How It Works
|
||||
|
||||
1. Party Mode loads your complete agent roster and introduces the available team members
|
||||
2. You present a topic or question
|
||||
3. The facilitator intelligently selects 2-3 most relevant agents based on expertise needed
|
||||
4. Agents respond in character, can reference each other, and engage in natural cross-talk
|
||||
5. The conversation continues until you choose to exit
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Intelligent agent selection** — The system analyzes your topic and selects the most relevant agents based on their expertise, capabilities, and principles
|
||||
- **Authentic personalities** — Each agent maintains their unique voice, communication style, and domain knowledge throughout the conversation
|
||||
- **Natural cross-talk** — Agents can reference each other, build on previous points, ask questions, and even respectfully disagree
|
||||
- **Optional TTS integration** — Each agent response can be read aloud with voice configurations matching their personalities
|
||||
- **Graceful exit** — Sessions conclude with personalized farewells from participating agents
|
||||
|
||||
---
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
Party Mode is a core workflow designed to be invoked and configured by other modules. When called from another workflow, it accepts contextual parameters:
|
||||
|
||||
| Parameter | Description |
|
||||
|-----------|-------------|
|
||||
| **Topic focus** | Prebias the discussion toward a specific domain or question |
|
||||
| **Additional personas** | Inject expert agents into the roster at runtime for specialized perspectives |
|
||||
| **Participation constraints** | Limit which agents can contribute based on relevance |
|
||||
|
||||
### Example
|
||||
|
||||
A medical module workflow could invoke Party Mode with expert doctor personas added to the roster, and the conversation pre-focused on a specific diagnosis or treatment decision. The agents would then discuss the medical case with appropriate domain expertise while maintaining their distinct personalities and perspectives.
|
||||
@@ -10,15 +10,13 @@ BMad v6 represents a complete ground-up rewrite with significant architectural c
|
||||
|
||||
When you run `npm run install:bmad` on a project, the installer automatically detects:
|
||||
|
||||
- **Legacy folders**: Any folders starting with `bmad-core` or `bmad-core`
|
||||
- **Legacy v4 installation folder**: `.bmad-method`
|
||||
- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
|
||||
|
||||
### What Happens During Detection
|
||||
|
||||
1. **Automatic Backup of v4 Modules**: All `.bmad-core` folders are moved to `v4-backup/` in your project root
|
||||
- If a backup already exists, a timestamp is added to avoid conflicts
|
||||
- Example: `.bmad-core` → `v4-backup/_bmad-core`
|
||||
- Your project files and data are NOT affected
|
||||
1. **Automatic Detection of v4 Modules**
|
||||
1. Installer will suggest removal or backup of your .bmad-method folder. You can choose to exit the installer and handle this cleanup, or allow the install to continue. Technically you can have both v4 and v6 installed, but it is not recommended. All BMad content and modules will be installed under a .bmad folder, fully segregated.
|
||||
|
||||
2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
|
||||
- Located in IDE config folders, for example claude: `.claude/commands/BMad/agents`, `.claude/commands/BMad/tasks`, etc.
|
||||
@@ -27,7 +25,7 @@ When you run `npm run install:bmad` on a project, the installer automatically de
|
||||
|
||||
## Module Migration
|
||||
|
||||
### Deprecated Modules
|
||||
### Deprecated Modules from v4
|
||||
|
||||
| v4 Module | v6 Status |
|
||||
| ----------------------------- | ---------------------------------------------- |
|
||||
@@ -38,6 +36,7 @@ When you run `npm run install:bmad` on a project, the installer automatically de
|
||||
| `_bmad-infrastructure-devops` | Deprecated - New core devops agent coming soon |
|
||||
| `_bmad-creative-writing` | Not adapted - New v6 module coming soon |
|
||||
|
||||
Aside from .bmad-method - if you have any of these others installed also, again its recommended to remove them and use the V6 equivalents, but its also fine if you decide to keep both. But it is not recommended to use both on the same project long term.
|
||||
|
||||
## Architecture Changes
|
||||
|
||||
@@ -47,29 +46,30 @@ When you run `npm run install:bmad` on a project, the installer automatically de
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad-core/ # Was actually the BMad Method
|
||||
├── _bmad-game-dev/ # Separate expansion packs
|
||||
├── _bmad-creative-writing/
|
||||
└── _bmad-infrastructure-devops/
|
||||
├── .bmad-method/
|
||||
├── .bmad-game-dev/
|
||||
├── .bmad-creative-writing/
|
||||
└── .bmad-infrastructure-devops/
|
||||
```
|
||||
|
||||
**v6 Unified Structure:**
|
||||
|
||||
```
|
||||
your-project/
|
||||
└── _bmad/ # Single installation folder, default _bmad
|
||||
└── _config/ # Your customizations
|
||||
| └── agents/ # Agent customization files
|
||||
└── _bmad/ # Single installation folder is _bmad
|
||||
└── _config/ # Your customizations
|
||||
| └── agents/ # Agent customization files
|
||||
├── core/ # Real core framework (applies to all modules)
|
||||
├── bmm/ # BMad Method (software/game dev)
|
||||
├── bmb/ # BMad Builder (create agents/workflows)
|
||||
├── cis/ # Creative Intelligence Suite
|
||||
├── _bmad_output # Default bmad output folder (was doc folder in v4)
|
||||
|
||||
```
|
||||
|
||||
### Key Concept Changes
|
||||
|
||||
- **v4 `_bmad-core`**: Was actually the BMad Method
|
||||
- **v4 `_bmad-core and _bmad-method`**: Was actually the BMad Method
|
||||
- **v6 `_bmad/core/`**: Is the real universal core framework
|
||||
- **v6 `_bmad/bmm/`**: Is the BMad Method module
|
||||
- **Module identification**: All modules now have a `config.yaml` file once installed at the root of the modules installed folder
|
||||
@@ -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](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/agent-customization-guide.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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user