feat: add documentation website with Docusaurus build pipeline
This commit is contained in:
Alex Verkhovsky
parent
925b715d4f
commit
4b2535b058
|
|
@ -0,0 +1,72 @@
|
|||
name: Deploy Documentation
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- "docs/**"
|
||||
- "src/modules/*/docs/**"
|
||||
- "website/**"
|
||||
- "tools/build-docs.js"
|
||||
- ".github/workflows/docs.yaml"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: false
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "20"
|
||||
cache: "npm"
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Determine site URL
|
||||
id: site-url
|
||||
run: |
|
||||
if [ "${{ github.repository }}" = "bmad-code-org/BMAD-METHOD" ]; then
|
||||
echo "url=https://bmad-code-org.github.io/BMAD-METHOD" >> $GITHUB_OUTPUT
|
||||
else
|
||||
OWNER="${{ github.repository_owner }}"
|
||||
REPO="${{ github.event.repository.name }}"
|
||||
echo "url=https://${OWNER}.github.io/${REPO}" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Build documentation
|
||||
env:
|
||||
SITE_URL: ${{ steps.site-url.outputs.url }}
|
||||
run: npm run docs:build
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: build/site
|
||||
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
steps:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v4
|
||||
|
|
@ -75,3 +75,7 @@ _bmad
|
|||
.roo
|
||||
|
||||
bmad-custom-src/
|
||||
|
||||
# Docusaurus / Documentation Build
|
||||
.docusaurus/
|
||||
build/
|
||||
|
|
|
|||
|
|
@ -236,10 +236,8 @@ Each commit should represent one logical change:
|
|||
3. **Don't paste code in issues** - create a proper PR instead
|
||||
4. **Don't submit your whole project** - contribute specific improvements
|
||||
|
||||
## Code Style
|
||||
## Prompt & Agent Guidelines
|
||||
|
||||
- Follow the existing code style and conventions
|
||||
- Write clear comments for complex logic
|
||||
- Keep dev agents lean - they need context for coding, not documentation
|
||||
- Web/planning agents can be larger with more complex tasks
|
||||
- Everything is natural language (markdown) - no code in core framework
|
||||
|
|
|
|||
13
README.md
13
README.md
|
|
@ -26,8 +26,8 @@ The completely revamped **BMAD V6 installer** now includes built-in support for
|
|||
|
||||
- [**Custom Content Overview**](./docs/custom-content.md) - Discover all supported content types
|
||||
- [**Installation Guide**](./docs/custom-content-installation.md) - Learn to create and install custom content
|
||||
- [**Detail Content Docs**](./src/modules/bmb/docs/README.md) - Reference details for agents, modules, workflows and the bmad builder
|
||||
- [**2 Very simple Custom Modules of questionable quality**](./docs/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||
- [**Detail Content Docs**](./src/modules/bmb/docs/index.md) - Reference details for agents, modules, workflows and the bmad builder
|
||||
- [**2 Very simple Custom Modules of questionable quality**](./samples/sample-custom-modules/README.md) - if you want to download and try to install a custom shared module, get an idea of how to bundle and share your own, or create your own personal agents, workflows and modules.
|
||||
|
||||
</div>
|
||||
|
||||
|
|
@ -142,18 +142,17 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|||
- 12 specialized agents
|
||||
- 34 workflows across 4 phases
|
||||
- Scale-adaptive planning
|
||||
- [→ Documentation Hub](./src/modules/bmm/docs/README.md)
|
||||
- [→ Documentation Hub](./src/modules/bmm/docs/index.md)
|
||||
|
||||
- **BMad Builder (BMB)** - Create custom agents and workflows
|
||||
- Build anything from simple agents to complex modules
|
||||
- Create domain-specific solutions (legal, medical, finance, education)
|
||||
- [→ Builder Guide](src/modules/bmb/docs/README.md) marketplace
|
||||
- [→ Builder Guide](./src/modules/bmb/README.md)
|
||||
- [→ Builder Guide](./src/modules/bmb/docs/index.md)
|
||||
|
||||
- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving
|
||||
- Brainstorming, design thinking, storytelling
|
||||
- 5 creative facilitation workflows
|
||||
- [→ Creative Workflows](src/modules/cis/docs/README.md)
|
||||
- [→ Creative Workflows](./src/modules/cis/docs/index.md)
|
||||
|
||||
### Key Features
|
||||
|
||||
|
|
@ -168,7 +167,7 @@ Each agent brings deep expertise and can be customized to match your team's styl
|
|||
### Quick Links
|
||||
|
||||
- **[Quick Start Guide](./src/modules/bmm/docs/quick-start.md)** - 15-minute introduction
|
||||
- **[Complete BMM Documentation](./src/modules/bmm/docs/README.md)** - All guides and references
|
||||
- **[Complete BMM Documentation](./src/modules/bmm/docs/index.md)** - All guides and references
|
||||
- **[Agent Customization](./docs/agent-customization-guide.md)** - Personalize your agents
|
||||
- **[All Documentation](./docs/index.md)** - Complete documentation index
|
||||
|
||||
|
|
|
|||
|
|
@ -203,6 +203,6 @@ memories:
|
|||
|
||||
## Next Steps
|
||||
|
||||
- **[BMM Agents Guide](../src/modules/bmm/docs/agents-guide.md)** - Learn about the BMad Method agents
|
||||
- **[BMB Create Agent Workflow](../src/modules/bmb/workflows/create-agent/README.md)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](../src/modules/bmm/docs/README.md)** - Full BMad Method reference
|
||||
- **[BMM Agents Guide](./modules/bmm/agents-guide)** - Learn about the BMad Method agents
|
||||
- **[BMB Create Agent Workflow](./modules/bmb/agents/index)** - Build completely custom agents
|
||||
- **[BMM Complete Documentation](./modules/bmm/index)** - Full BMad Method reference
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ This guide explains how to create and install custom BMAD content including agen
|
|||
|
||||
For detailed information about the different types of custom content available, see [Custom Content](./custom-content.md).
|
||||
|
||||
If you download either of the folders within the [Sample Custom Modules](./sample-custom-modules/readme.md) folder
|
||||
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.
|
||||
|
||||
## Content Types Overview
|
||||
|
||||
|
|
|
|||
|
|
@ -441,8 +441,8 @@ input_file_patterns:
|
|||
## Related Documentation
|
||||
|
||||
- [shard-doc Tool](../src/core/tools/shard-doc.xml) - Tool implementation
|
||||
- [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Workflow overview
|
||||
- [Workflow Creation Guide](../src/modules/bmb/workflows/create-workflow/workflow-creation-guide.md) - Custom workflow patterns
|
||||
- [BMM Workflows Guide](./modules/bmm/index.md#-workflow-guides) - Workflow overview
|
||||
- [Workflow Creation Guide](./modules/bmb/workflows/index) - Custom workflow patterns
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,76 @@
|
|||
# Installation
|
||||
|
||||
Get BMAD Method running in your project in under 2 minutes.
|
||||
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
npx bmad-method@alpha 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
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Node.js** 18+ (for the installer)
|
||||
- **Git** (recommended for version control)
|
||||
- An **AI-powered IDE** or access to Claude/ChatGPT/Gemini
|
||||
|
||||
## Module Options
|
||||
|
||||
During installation, you'll choose which modules to install:
|
||||
|
||||
| Module | Description | Best For |
|
||||
| -------- | ---------------- | ---------------------------------------- |
|
||||
| **BMM** | BMAD Method Core | Software development projects |
|
||||
| **BMGD** | Game Development | Game projects with specialized workflows |
|
||||
| **BMB** | Builder | Creating custom agents and workflows |
|
||||
|
||||
## Post-Installation
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── _bmad/ # BMAD configuration and agents
|
||||
│ ├── bmm/ # Method module (if installed)
|
||||
│ ├── bmgd/ # Game dev module (if installed)
|
||||
│ └── config.yaml # Your project configuration
|
||||
├── .claude/ # IDE-specific setup (varies by IDE)
|
||||
└── ... your code
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. **Read the [Quick Start Guide](../modules/bmm/quick-start.md)** to build your first feature
|
||||
2. **Check your [IDE Guide](../ide-info/index.md)** for IDE-specific tips
|
||||
3. **Explore [Workflows](../modules/bmm/workflows-planning.md)** to understand the methodology
|
||||
|
||||
## Alternative: Web Bundles
|
||||
|
||||
Don't want to install? Use BMAD agents directly in:
|
||||
|
||||
- **Claude Projects** - Upload the web bundle
|
||||
- **ChatGPT** - Use custom GPT bundles
|
||||
- **Gemini** - Import agent prompts
|
||||
|
||||
See the [Web Bundles Guide](../web-bundles-gemini-gpt-guide.md) for details.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**"Command not found: npx"**
|
||||
: Install Node.js 18+ from [nodejs.org](https://nodejs.org)
|
||||
|
||||
**"Permission denied"**
|
||||
: Run with appropriate permissions or check your npm configuration
|
||||
|
||||
**IDE not detected**
|
||||
: The installer will prompt you to select your IDE manually
|
||||
|
||||
For more help, see [Troubleshooting](../modules/bmm/troubleshooting.md) or join our [Discord](https://discord.gg/bmad).
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# IDE Guides
|
||||
|
||||
BMAD Method works with any AI-powered development environment. Choose your IDE below for specific setup instructions and tips.
|
||||
|
||||
## All Supported IDEs
|
||||
|
||||
| IDE | Type | BMAD Support |
|
||||
| ----------------------------------- | ----------------- | --------------------- |
|
||||
| [Claude Code](claude-code.md) | CLI/Terminal | Native slash commands |
|
||||
| [Cursor](cursor.md) | Desktop Editor | Full agent support |
|
||||
| [VS Code / Windsurf](windsurf.md) | Desktop Editor | Extension-based |
|
||||
| [Cline](cline.md) | VS Code Extension | Full support |
|
||||
| [GitHub Copilot](github-copilot.md) | Extension | Workspace agents |
|
||||
| [Augment](auggie.md) | Extension | Agent loading |
|
||||
| [Codex](codex.md) | CLI | Prompt injection |
|
||||
| [Gemini](gemini.md) | Web/API | Web bundles |
|
||||
| [Roo](roo.md) | VS Code Extension | Mode support |
|
||||
| [Kilo](kilo.md) | Extension | Basic support |
|
||||
| [OpenCode](opencode.md) | Open Source | Full support |
|
||||
| [Qwen](qwen.md) | Web/API | Web bundles |
|
||||
| [Trae](trae.md) | Extension | Basic support |
|
||||
| [Crush](crush.md) | Desktop | Agent support |
|
||||
| [iFlow](iflow.md) | Extension | Prompt loading |
|
||||
| [Rovo Dev](rovo-dev.md) | Atlassian | Integration |
|
||||
|
|
@ -1,388 +1,22 @@
|
|||
# Rovo Dev IDE Integration
|
||||
# BMAD Method - Rovo Dev Instructions
|
||||
|
||||
This document describes how BMAD-METHOD integrates with [Atlassian Rovo Dev](https://www.atlassian.com/rovo-dev), an AI-powered software development assistant.
|
||||
## Activating Agents
|
||||
|
||||
## Overview
|
||||
BMAD agents are installed as subagents in `.rovodev/subagents/`.
|
||||
|
||||
Rovo Dev is designed to integrate deeply with developer workflows and organizational knowledge bases. When you install BMAD-METHOD in a Rovo Dev project, it automatically installs BMAD agents, workflows, tasks, and tools just like it does for other IDEs (Cursor, VS Code, etc.).
|
||||
### How to Use
|
||||
|
||||
BMAD-METHOD provides:
|
||||
1. **Open Project**: Subagents auto-load when project opens
|
||||
2. **Invoke Agent**: Type `@` and select agent (e.g., `@bmad-bmm-dev`, `@bmad-bmm-architect`)
|
||||
3. **Reference Files**: Check `.rovodev/workflows/` and `.rovodev/references/`
|
||||
|
||||
- **Agents**: Specialized subagents for various development tasks
|
||||
- **Workflows**: Multi-step workflow guides and coordinators
|
||||
- **Tasks & Tools**: Reference documentation for BMAD tasks and tools
|
||||
### Directory Structure
|
||||
|
||||
### What are Rovo Dev Subagents?
|
||||
- `.rovodev/subagents/` - BMAD agents
|
||||
- `.rovodev/workflows/` - Workflow guides
|
||||
- `.rovodev/references/` - Tasks and tools
|
||||
|
||||
Subagents are specialized agents that Rovo Dev can delegate tasks to. They are defined as Markdown files with YAML frontmatter stored in the `.rovodev/subagents/` directory. Rovo Dev automatically discovers these files and makes them available through the `@subagent-name` syntax.
|
||||
### Notes
|
||||
|
||||
## Installation and Setup
|
||||
|
||||
### Automatic Installation
|
||||
|
||||
When you run the BMAD-METHOD installer and select Rovo Dev as your IDE:
|
||||
|
||||
```bash
|
||||
bmad install
|
||||
```
|
||||
|
||||
The installer will:
|
||||
|
||||
1. Create a `.rovodev/subagents/` directory in your project (if it doesn't exist)
|
||||
2. Convert BMAD agents into Rovo Dev subagent format
|
||||
3. Write subagent files with the naming pattern: `bmad-<module>-<agent-name>.md`
|
||||
|
||||
### File Structure
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
project-root/
|
||||
├── .rovodev/
|
||||
│ ├── subagents/
|
||||
│ │ ├── bmad-core-code-reviewer.md
|
||||
│ │ ├── bmad-bmm-pm.md
|
||||
│ │ ├── bmad-bmm-dev.md
|
||||
│ │ └── ... (more agents from selected modules)
|
||||
│ ├── workflows/
|
||||
│ │ ├── bmad-brainstorming.md
|
||||
│ │ ├── bmad-prd-creation.md
|
||||
│ │ └── ... (workflow guides)
|
||||
│ ├── references/
|
||||
│ │ ├── bmad-task-core-code-review.md
|
||||
│ │ ├── bmad-tool-core-analysis.md
|
||||
│ │ └── ... (task/tool references)
|
||||
│ ├── config.yml (Rovo Dev configuration)
|
||||
│ ├── prompts.yml (Optional: reusable prompts)
|
||||
│ └── ...
|
||||
├── _bmad/ (BMAD installation directory)
|
||||
└── ...
|
||||
```
|
||||
|
||||
**Directory Structure Explanation:**
|
||||
|
||||
- **subagents/**: Agents discovered and used by Rovo Dev with `@agent-name` syntax
|
||||
- **workflows/**: Multi-step workflow guides and instructions
|
||||
- **references/**: Documentation for available tasks and tools in BMAD
|
||||
|
||||
## Subagent File Format
|
||||
|
||||
BMAD agents are converted to Rovo Dev subagent format, which uses Markdown with YAML frontmatter:
|
||||
|
||||
### Basic Structure
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: bmad-module-agent-name
|
||||
description: One sentence description of what this agent does
|
||||
tools:
|
||||
- bash
|
||||
- open_files
|
||||
- grep
|
||||
- expand_code_chunks
|
||||
model: anthropic.claude-3-5-sonnet-20241022-v2:0 # Optional
|
||||
load_memory: true # Optional
|
||||
---
|
||||
|
||||
You are a specialized agent for [specific task].
|
||||
|
||||
## Your Role
|
||||
|
||||
Describe the agent's role and responsibilities...
|
||||
|
||||
## Key Instructions
|
||||
|
||||
1. First instruction
|
||||
2. Second instruction
|
||||
3. Third instruction
|
||||
|
||||
## When to Use This Agent
|
||||
|
||||
Explain when and how to use this agent...
|
||||
```
|
||||
|
||||
### YAML Frontmatter Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | string | Yes | Unique identifier for the subagent (kebab-case, no spaces) |
|
||||
| `description` | string | Yes | One-line description of the subagent's purpose |
|
||||
| `tools` | array | No | List of tools the subagent can use. If not specified, uses parent agent's tools |
|
||||
| `model` | string | No | Specific LLM model for this subagent (e.g., `anthropic.claude-3-5-sonnet-20241022-v2:0`). If not specified, uses parent agent's model |
|
||||
| `load_memory` | boolean | No | Whether to load default memory files (AGENTS.md, AGENTS.local.md). Defaults to `true` |
|
||||
|
||||
### System Prompt
|
||||
|
||||
The content after the closing `---` is the subagent's system prompt. This defines:
|
||||
|
||||
- The agent's persona and role
|
||||
- Its capabilities and constraints
|
||||
- Step-by-step instructions for task execution
|
||||
- Examples of expected behavior
|
||||
|
||||
## Using BMAD Components in Rovo Dev
|
||||
|
||||
### Invoking a Subagent (Agent)
|
||||
|
||||
In Rovo Dev, you can invoke a BMAD agent as a subagent using the `@` syntax:
|
||||
|
||||
```
|
||||
@bmad-core-code-reviewer Please review this PR for potential issues
|
||||
@bmad-bmm-pm Help plan this feature release
|
||||
@bmad-bmm-dev Implement this feature
|
||||
```
|
||||
|
||||
### Accessing Workflows
|
||||
|
||||
Workflow guides are available in `.rovodev/workflows/` directory:
|
||||
|
||||
```
|
||||
@bmad-core-code-reviewer Use the brainstorming workflow from .rovodev/workflows/bmad-brainstorming.md
|
||||
```
|
||||
|
||||
Workflow files contain step-by-step instructions and can be referenced or copied into Rovo Dev for collaborative workflow execution.
|
||||
|
||||
### Accessing Tasks and Tools
|
||||
|
||||
Task and tool documentation is available in `.rovodev/references/` directory. These provide:
|
||||
|
||||
- Task execution instructions
|
||||
- Tool capabilities and usage
|
||||
- Integration examples
|
||||
- Parameter documentation
|
||||
|
||||
### Example Usage Scenarios
|
||||
|
||||
#### Code Review
|
||||
|
||||
```
|
||||
@bmad-core-code-reviewer Review the changes in src/components/Button.tsx
|
||||
for best practices, performance, and potential bugs
|
||||
```
|
||||
|
||||
#### Documentation
|
||||
|
||||
```
|
||||
@bmad-core-documentation-writer Generate API documentation for the new
|
||||
user authentication module
|
||||
```
|
||||
|
||||
#### Feature Design
|
||||
|
||||
```
|
||||
@bmad-module-feature-designer Design a solution for implementing
|
||||
dark mode support across the application
|
||||
```
|
||||
|
||||
## Customizing BMAD Subagents
|
||||
|
||||
You can customize BMAD subagents after installation by editing their files directly in `.rovodev/subagents/`.
|
||||
|
||||
### Example: Adding Tool Restrictions
|
||||
|
||||
By default, BMAD subagents inherit tools from the parent Rovo Dev agent. You can restrict which tools a specific subagent can use:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: bmad-core-code-reviewer
|
||||
description: Reviews code and suggests improvements
|
||||
tools:
|
||||
- open_files
|
||||
- expand_code_chunks
|
||||
- grep
|
||||
---
|
||||
```
|
||||
|
||||
### Example: Using a Specific Model
|
||||
|
||||
Some agents might benefit from using a different model. You can specify this:
|
||||
|
||||
```yaml
|
||||
---
|
||||
name: bmad-core-documentation-writer
|
||||
description: Writes clear and comprehensive documentation
|
||||
model: anthropic.claude-3-5-sonnet-20241022-v2:0
|
||||
---
|
||||
```
|
||||
|
||||
### Example: Enhancing the System Prompt
|
||||
|
||||
You can add additional context to a subagent's system prompt:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: bmad-core-code-reviewer
|
||||
description: Reviews code and suggests improvements
|
||||
---
|
||||
|
||||
You are a specialized code review agent for our project.
|
||||
|
||||
## Project Context
|
||||
|
||||
Our codebase uses:
|
||||
|
||||
- React 18 for frontend
|
||||
- Node.js 18+ for backend
|
||||
- TypeScript for type safety
|
||||
- Jest for testing
|
||||
|
||||
## Review Checklist
|
||||
|
||||
1. Type safety and TypeScript correctness
|
||||
2. React best practices and hooks usage
|
||||
3. Performance considerations
|
||||
4. Test coverage
|
||||
5. Documentation and comments
|
||||
|
||||
...rest of original system prompt...
|
||||
```
|
||||
|
||||
## Memory and Context
|
||||
|
||||
By default, BMAD subagents have `load_memory: true`, which means they will load memory files from your project:
|
||||
|
||||
- **Project-level**: `.rovodev/AGENTS.md` and `.rovodev/.agent.md`
|
||||
- **User-level**: `~/.rovodev/AGENTS.md` (global memory across all projects)
|
||||
|
||||
These files can contain:
|
||||
|
||||
- Project guidelines and conventions
|
||||
- Common patterns and best practices
|
||||
- Recent decisions and context
|
||||
- Custom instructions for all agents
|
||||
|
||||
### Creating Project Memory
|
||||
|
||||
Create `.rovodev/AGENTS.md` in your project:
|
||||
|
||||
```markdown
|
||||
# Project Guidelines
|
||||
|
||||
## Code Style
|
||||
|
||||
- Use 2-space indentation
|
||||
- Use camelCase for variables
|
||||
- Use PascalCase for classes
|
||||
|
||||
## Architecture
|
||||
|
||||
- Follow modular component structure
|
||||
- Use dependency injection for services
|
||||
- Implement proper error handling
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
- Minimum 80% code coverage
|
||||
- Write tests before implementation
|
||||
- Use descriptive test names
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Subagents Not Appearing in Rovo Dev
|
||||
|
||||
1. **Verify files exist**: Check that `.rovodev/subagents/bmad-*.md` files are present
|
||||
2. **Check Rovo Dev is reloaded**: Rovo Dev may cache agent definitions. Restart Rovo Dev or reload the project
|
||||
3. **Verify file format**: Ensure files have proper YAML frontmatter (between `---` markers)
|
||||
4. **Check file permissions**: Ensure files are readable by Rovo Dev
|
||||
|
||||
### Agent Name Conflicts
|
||||
|
||||
If you have custom subagents with the same names as BMAD agents, Rovo Dev will load both but may show a warning. Use unique prefixes for custom subagents to avoid conflicts.
|
||||
|
||||
### Tools Not Available
|
||||
|
||||
If a subagent's tools aren't working:
|
||||
|
||||
1. Verify the tool names match Rovo Dev's available tools
|
||||
2. Check that the parent Rovo Dev agent has access to those tools
|
||||
3. Ensure tool permissions are properly configured in `.rovodev/config.yml`
|
||||
|
||||
## Advanced: Tool Configuration
|
||||
|
||||
Rovo Dev agents have access to a set of tools for various tasks. Common tools available include:
|
||||
|
||||
- `bash`: Execute shell commands
|
||||
- `open_files`: View file contents
|
||||
- `grep`: Search across files
|
||||
- `expand_code_chunks`: View specific code sections
|
||||
- `find_and_replace_code`: Modify files
|
||||
- `create_file`: Create new files
|
||||
- `delete_file`: Delete files
|
||||
- `move_file`: Rename or move files
|
||||
|
||||
### MCP Servers
|
||||
|
||||
Rovo Dev can also connect to Model Context Protocol (MCP) servers, which provide additional tools and data sources:
|
||||
|
||||
- **Atlassian Integration**: Access to Jira, Confluence, and Bitbucket
|
||||
- **Code Analysis**: Custom code analysis and metrics
|
||||
- **External Services**: APIs and third-party integrations
|
||||
|
||||
Configure MCP servers in `~/.rovodev/mcp.json` or `.rovodev/mcp.json`.
|
||||
|
||||
## Integration with Other IDE Handlers
|
||||
|
||||
BMAD-METHOD supports multiple IDEs simultaneously. You can have both Rovo Dev and other IDE configurations (Cursor, VS Code, etc.) in the same project. Each IDE will have its own artifacts installed in separate directories.
|
||||
|
||||
For example:
|
||||
|
||||
- Rovo Dev agents: `.rovodev/subagents/bmad-*.md`
|
||||
- Cursor rules: `.cursor/rules/bmad/`
|
||||
- Claude Code: `.claude/rules/bmad/`
|
||||
|
||||
## Performance Considerations
|
||||
|
||||
- BMAD subagent files are typically small (1-5 KB each)
|
||||
- Rovo Dev lazy-loads subagents, so having many subagents doesn't impact startup time
|
||||
- System prompts are cached by Rovo Dev after first load
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Keep System Prompts Concise**: Shorter, well-structured prompts are more effective
|
||||
2. **Use Project Memory**: Leverage `.rovodev/AGENTS.md` for shared context
|
||||
3. **Customize Tool Restrictions**: Give subagents only the tools they need
|
||||
4. **Test Subagent Invocations**: Verify each subagent works as expected for your project
|
||||
5. **Version Control**: Commit `.rovodev/subagents/` to version control for team consistency
|
||||
6. **Document Custom Subagents**: Add comments explaining the purpose of customized subagents
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Rovo Dev Official Documentation](https://www.atlassian.com/rovo-dev)
|
||||
- [BMAD-METHOD Installation Guide](./installation.md)
|
||||
- [IDE Handler Architecture](./ide-handlers.md)
|
||||
- [Rovo Dev Configuration Reference](https://www.atlassian.com/rovo-dev/configuration)
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1: Code Review Workflow
|
||||
|
||||
```
|
||||
User: @bmad-core-code-reviewer Review src/auth/login.ts for security issues
|
||||
Rovo Dev → Subagent: Opens file, analyzes code, suggests improvements
|
||||
Subagent output: Security vulnerabilities found, recommendations provided
|
||||
```
|
||||
|
||||
### Example 2: Documentation Generation
|
||||
|
||||
```
|
||||
User: @bmad-core-documentation-writer Generate API docs for the new payment module
|
||||
Rovo Dev → Subagent: Analyzes code structure, generates documentation
|
||||
Subagent output: Markdown documentation with examples and API reference
|
||||
```
|
||||
|
||||
### Example 3: Architecture Design
|
||||
|
||||
```
|
||||
User: @bmad-module-feature-designer Design a caching strategy for the database layer
|
||||
Rovo Dev → Subagent: Reviews current architecture, proposes design
|
||||
Subagent output: Detailed architecture proposal with implementation plan
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
For issues or questions about:
|
||||
|
||||
- **Rovo Dev**: See [Atlassian Rovo Dev Documentation](https://www.atlassian.com/rovo-dev)
|
||||
- **BMAD-METHOD**: See [BMAD-METHOD README](../README.md)
|
||||
- **IDE Integration**: See [IDE Handler Guide](./ide-handlers.md)
|
||||
- Agents are automatically discovered by Rovo Dev
|
||||
- Subagents use YAML frontmatter for configuration
|
||||
|
|
|
|||
|
|
@ -9,10 +9,10 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
|
|||
**New users:** Start with one of these based on your situation:
|
||||
|
||||
| Your Situation | Start Here | Then Read |
|
||||
| ---------------------- | --------------------------------------------------------------- | ------------------------------------------------------------- |
|
||||
| **Brand new to BMad** | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) | [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) |
|
||||
| **Upgrading from v4** | [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) |
|
||||
| **Brownfield project** | [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) | [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) |
|
||||
| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------- |
|
||||
| **Brand new to BMad** | [Quick Start Guide](./modules/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) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -20,16 +20,14 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
|
|||
|
||||
### Project-Level Docs (Root)
|
||||
|
||||
- **[README.md](../README.md)** - Main project overview, feature summary, and module introductions
|
||||
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
|
||||
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history and breaking changes
|
||||
- **[CLAUDE.md](../CLAUDE.md)** - Claude Code specific guidelines for this project
|
||||
- **[README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md)** - Main project overview, feature summary, and module introductions
|
||||
- **[CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md)** - How to contribute, pull request guidelines, code style
|
||||
- **[CHANGELOG.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md)** - Version history and breaking changes
|
||||
|
||||
### Installation & Setup
|
||||
|
||||
- **[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
|
||||
- **[Web Bundles](./USING_WEB_BUNDLES.md)** - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation
|
||||
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - Maintainer guide for bundle auto-publishing
|
||||
|
||||
---
|
||||
|
|
@ -40,27 +38,27 @@ Complete map of all BMad Method v6 documentation with recommended reading paths.
|
|||
|
||||
The flagship module for agile AI-driven development.
|
||||
|
||||
- **[BMM Module README](../src/modules/bmm/README.md)** - Module overview, agents, and complete documentation index
|
||||
- **[BMM Documentation](../src/modules/bmm/docs/)** - All BMM-specific guides and references:
|
||||
- [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Step-by-step guide to building your first project
|
||||
- [Quick Spec Flow](../src/modules/bmm/docs/quick-spec-flow.md) - Rapid Level 0-1 development
|
||||
- [Scale Adaptive System](../src/modules/bmm/docs/scale-adaptive-system.md) - Understanding the 5-level system
|
||||
- [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Working with existing codebases
|
||||
- **[BMM Workflows Guide](../src/modules/bmm/workflows/README.md)** - **ESSENTIAL READING**
|
||||
- **[Test Architect Guide](../src/modules/bmm/testarch/README.md)** - Testing strategy and quality assurance
|
||||
- **[BMM Module README](./modules/bmm/)** - Module overview, agents, and complete documentation index
|
||||
- **[BMM Documentation](./modules/bmm/)** - All BMM-specific guides and references:
|
||||
- [Quick Start Guide](./modules/bmm/quick-start) - Step-by-step guide to building your first project
|
||||
- [Quick Spec Flow](./modules/bmm/quick-spec-flow) - Rapid Level 0-1 development
|
||||
- [Scale Adaptive System](./modules/bmm/scale-adaptive-system) - Understanding the 5-level system
|
||||
- [Brownfield Guide](./modules/bmm/brownfield-guide) - Working with existing codebases
|
||||
- **[BMM Workflows Guide](./modules/bmm/index#-workflow-guides)** - **ESSENTIAL READING**
|
||||
- **[Test Architect Guide](./modules/bmm/test-architecture)** - Testing strategy and quality assurance
|
||||
|
||||
### BMad Builder (BMB) - Create Custom Solutions
|
||||
|
||||
Build your own agents, workflows, and modules.
|
||||
|
||||
- **[BMB Module README](../src/modules/bmb/docs/README.md)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md)** - Design custom agents
|
||||
- **[BMB Module Overview](./modules/bmb/index)** - Module overview and capabilities
|
||||
- **[Agent Creation Guide](./modules/bmb/agents/index)** - Design custom agents
|
||||
|
||||
### Creative Intelligence Suite (CIS) - Innovation & Creativity
|
||||
|
||||
AI-powered creative thinking and brainstorming.
|
||||
|
||||
- **[CIS Module README](../src/modules/cis/docs/README.md)** - Module overview and workflows
|
||||
- **[CIS Module README](./modules/cis/)** - Module overview and workflows
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -101,52 +99,45 @@ Instructions for loading agents and running workflows in your development enviro
|
|||
- **[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
|
||||
|
||||
### Installation & Bundling
|
||||
|
||||
- [IDE Injections Reference](./installers-bundlers/ide-injections.md) - How agents are installed to IDEs
|
||||
- [Installers & Platforms Reference](./installers-bundlers/installers-modules-platforms-reference.md) - CLI tool and platform support
|
||||
- [Web Bundler Usage](./installers-bundlers/web-bundler-usage.md) - Creating web-compatible bundles
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Recommended Reading Paths
|
||||
|
||||
### Path 1: Brand New to BMad (Software Project)
|
||||
|
||||
1. [README.md](../README.md) - Understand the vision
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Get hands-on
|
||||
3. [BMM Module README](../src/modules/bmm/README.md) - Understand agents
|
||||
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
|
||||
1. [README.md](./project-readme) - Understand the vision
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
||||
3. [BMM Module README](./modules/bmm/) - Understand agents
|
||||
4. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
||||
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
||||
|
||||
### Path 2: Game Development Project
|
||||
|
||||
1. [README.md](../README.md) - Understand the vision
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Get hands-on
|
||||
3. [BMM Module README](../src/modules/bmm/README.md) - Game agents are included
|
||||
4. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Game workflows
|
||||
1. [README.md](./project-readme) - Understand the vision
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Get hands-on
|
||||
3. [BMM Module README](./modules/bmm/) - Game agents are included
|
||||
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
|
||||
5. [Your IDE guide](./ide-info/) - Optimize your workflow
|
||||
|
||||
### Path 3: Upgrading from v4
|
||||
|
||||
1. [v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md) - Understand what changed
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Reorient yourself
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Learn new v6 workflows
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Reorient yourself
|
||||
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Learn new v6 workflows
|
||||
|
||||
### Path 4: Working with Existing Codebase (Brownfield)
|
||||
|
||||
1. [Brownfield Guide](../src/modules/bmm/docs/brownfield-guide.md) - Approach for legacy code
|
||||
2. [Quick Start Guide](../src/modules/bmm/docs/quick-start.md) - Follow the process
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Master the methodology
|
||||
1. [Brownfield Guide](./modules/bmm/brownfield-guide) - Approach for legacy code
|
||||
2. [Quick Start Guide](./modules/bmm/quick-start) - Follow the process
|
||||
3. [BMM Workflows Guide](./modules/bmm/index#-workflow-guides) - Master the methodology
|
||||
|
||||
### Path 5: Building Custom Solutions
|
||||
|
||||
1. [BMB Module README](../src/modules/bmb/docs/README.md) - Understand capabilities
|
||||
2. [Agent Creation Guide](../src/modules/bmb/workflows/create-agent/README.md) - Create agents
|
||||
3. [BMM Workflows Guide](../src/modules/bmm/workflows/README.md) - Understand workflow structure
|
||||
1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
|
||||
2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
|
||||
3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure
|
||||
|
||||
### Path 6: Contributing to BMad
|
||||
|
||||
1. [CONTRIBUTING.md](../CONTRIBUTING.md) - Contribution guidelines
|
||||
1. [CONTRIBUTING.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CONTRIBUTING.md) - Contribution guidelines
|
||||
2. Relevant module README - Understand the area you're contributing to
|
||||
3. [Code Style section in CONTRIBUTING.md](../CONTRIBUTING.md#code-style) - Follow standards
|
||||
|
|
|
|||
|
|
@ -18,6 +18,10 @@ export default [
|
|||
'test/fixtures/**/*.yaml',
|
||||
'_bmad/**',
|
||||
'_bmad*/**',
|
||||
// Docusaurus build artifacts
|
||||
'.docusaurus/**',
|
||||
'build/**',
|
||||
'website/**',
|
||||
// Gitignored patterns
|
||||
'z*/**', // z-samples, z1, z2, etc.
|
||||
'.claude/**',
|
||||
|
|
@ -77,9 +81,9 @@ export default [
|
|||
},
|
||||
},
|
||||
|
||||
// CLI/CommonJS scripts under tools/** and test/**
|
||||
// CLI scripts under tools/** and test/**
|
||||
{
|
||||
files: ['tools/**/*.js', 'test/**/*.js'],
|
||||
files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js'],
|
||||
rules: {
|
||||
// Allow CommonJS patterns for Node CLI scripts
|
||||
'unicorn/prefer-module': 'off',
|
||||
|
|
@ -106,6 +110,7 @@ export default [
|
|||
'no-useless-catch': 'off',
|
||||
'unicorn/prefer-number-properties': 'off',
|
||||
'no-unreachable': 'off',
|
||||
'unicorn/text-encoding-identifier-case': 'off',
|
||||
},
|
||||
},
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
11
package.json
11
package.json
|
|
@ -26,6 +26,9 @@
|
|||
"scripts": {
|
||||
"bmad:install": "node tools/cli/bmad-cli.js install",
|
||||
"bundle": "node tools/cli/bundlers/bundle-web.js all",
|
||||
"docs:build": "node tools/build-docs.js",
|
||||
"docs:dev": "npm run docs:build && npm run docs:serve",
|
||||
"docs:serve": "docusaurus start --config website/docusaurus.config.js --host localhost",
|
||||
"flatten": "node tools/flattener/main.js",
|
||||
"format:check": "prettier --check \"**/*.{js,cjs,mjs,json,yaml}\"",
|
||||
"format:fix": "prettier --write \"**/*.{js,cjs,mjs,json,yaml}\"",
|
||||
|
|
@ -72,7 +75,7 @@
|
|||
"fs-extra": "^11.3.0",
|
||||
"glob": "^11.0.3",
|
||||
"ignore": "^7.0.5",
|
||||
"inquirer": "^9.3.8",
|
||||
"inquirer": "^8.2.6",
|
||||
"js-yaml": "^4.1.0",
|
||||
"ora": "^5.4.1",
|
||||
"semver": "^7.6.3",
|
||||
|
|
@ -81,7 +84,10 @@
|
|||
"yaml": "^2.7.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/core": "^3.6.0",
|
||||
"@docusaurus/preset-classic": "^3.6.0",
|
||||
"@eslint/js": "^9.33.0",
|
||||
"archiver": "^7.0.1",
|
||||
"c8": "^10.1.3",
|
||||
"eslint": "^9.33.0",
|
||||
"eslint-config-prettier": "^10.1.8",
|
||||
|
|
@ -94,6 +100,9 @@
|
|||
"markdownlint-cli2": "^0.19.1",
|
||||
"prettier": "^3.5.3",
|
||||
"prettier-plugin-packagejson": "^2.5.19",
|
||||
"prism-react-renderer": "^2.4.1",
|
||||
"react": "^18.3.1",
|
||||
"react-dom": "^18.3.1",
|
||||
"yaml-eslint-parser": "^1.2.3",
|
||||
"yaml-lint": "^1.7.0",
|
||||
"zod": "^4.1.12"
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ These are quickly put together examples of both a stand alone somewhat cohesive
|
|||
|
||||
To try these out, download either or both folders to your local machine, and run the normal bmad installer, and when asked about custom local content, say yes, and give the path to one of these two folders. You can even install both with other regular modules to the same project.
|
||||
|
||||
Note - a project is just a folder with .bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||
Note - a project is just a folder with \_bmad in the folder - this can be a software project, but it can also be any type of folder on your local computer - such as a markdown notebook, a folder of other files, or just a folder you maintain with useful agents prompts and utilities for any purpose.
|
||||
|
||||
Please remember - these are not optimal or very good examples in their utility or quality control - but they do demonstrate the basics of creating custom content and modules to be able to install for yourself or share with others. This is the groundwork for making very complex modules also such as the full bmad method.
|
||||
|
||||
|
|
@ -49,7 +49,8 @@
|
|||
- @/tools/cli/lib/xml-handler.js - XML processing
|
||||
- @/tools/cli/lib/yaml-format.js - YAML formatting
|
||||
- @/tools/cli/lib/file-ops.js - File operations
|
||||
- @/tools/cli/lib/agent/yaml-xml-builder.js - Agent YAML to XML compilation
|
||||
- @/tools/cli/lib/agent/compiler.js - Agent YAML to XML compilation
|
||||
- @/tools/cli/lib/agent/installer.js - Agent installation
|
||||
- @/tools/cli/lib/agent/template-engine.js - Template processing
|
||||
|
||||
## IDE Handler Registry (16 IDEs)
|
||||
|
|
@ -21,18 +21,14 @@ agent:
|
|||
- "ALWAYS communicate in {communication_language}"
|
||||
|
||||
menu:
|
||||
- trigger: "CH or fuzzy match on chat"
|
||||
action: "agent responds as expert based on its persona to converse"
|
||||
description: "[CH] Chat with the BMad Master"
|
||||
|
||||
- trigger: "LT or list-tasks or fuzzy match on list tasks"
|
||||
- trigger: "list-tasks"
|
||||
action: "list all tasks from {project-root}/_bmad/_config/task-manifest.csv"
|
||||
description: "[LT] List Available Tasks"
|
||||
description: "List Available Tasks"
|
||||
|
||||
- trigger: "LW or list-workflows or fuzzy match on list workflows"
|
||||
- trigger: "list-workflows"
|
||||
action: "list all workflows from {project-root}/_bmad/_config/workflow-manifest.csv"
|
||||
description: "[LW] List Workflows"
|
||||
description: "List Workflows"
|
||||
|
||||
- trigger: "PS or party-mode or fuzzy match on party mode"
|
||||
- trigger: "party-mode"
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Group chat with all agents"
|
||||
description: "Group chat with all agents"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,25 @@
|
|||
# BMB - BMad Builder Module
|
||||
|
||||
Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules.
|
||||
|
||||
## Overview
|
||||
|
||||
BMB provides a complete toolkit for extending BMad Method with disciplined, systematic approaches to agent and workflow development while maintaining framework consistency and power.
|
||||
|
||||
**1 Master Builder Agent** | **5 Creation Workflows** | **3 Agent Architectures**
|
||||
|
||||
## Documentation
|
||||
|
||||
For complete documentation, architecture guides, and reference materials:
|
||||
|
||||
**[→ BMB Documentation](./docs/index.md)**
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [Agent Creation Guide](./docs/agents/index.md) - Build custom agents
|
||||
- [Workflow Architecture](./docs/workflows/index.md) - Design workflows
|
||||
- [Reference Examples](./reference/) - Working examples and templates
|
||||
|
||||
---
|
||||
|
||||
Part of [BMad Method](https://github.com/bmadcode/bmad-method) v6.0
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
# Agent Building Expert Agent Definition
|
||||
# Specialized in creating, editing, and validating BMAD agents with best practices
|
||||
|
||||
agent:
|
||||
webskip: true
|
||||
metadata:
|
||||
id: "_bmad/bmb/agents/agent-building-expert.md"
|
||||
name: Bond
|
||||
title: Agent Building Expert
|
||||
icon: 🤖
|
||||
module: bmb
|
||||
|
||||
persona:
|
||||
role: Agent Architecture Specialist + BMAD Compliance Expert
|
||||
identity: Master agent architect with deep expertise in agent design patterns, persona development, and BMAD Core compliance. Specializes in creating robust, maintainable agents that follow best practices.
|
||||
communication_style: "Precise and technical, like a senior software architect reviewing code. Focuses on structure, compliance, and long-term maintainability. Uses agent-specific terminology and framework references."
|
||||
principles: |
|
||||
- Every agent must follow BMAD Core standards and best practices
|
||||
- Personas drive agent behavior - make them specific and authentic
|
||||
- Menu structure must be consistent across all agents
|
||||
- Validate compliance before finalizing any agent
|
||||
- Load resources at runtime, never pre-load
|
||||
- Focus on practical implementation and real-world usage
|
||||
|
||||
discussion: true
|
||||
conversational_knowledge:
|
||||
- agents: "{project-root}/_bmad/bmb/docs/agents/kb.csv"
|
||||
|
||||
menu:
|
||||
- trigger: CA or create-agent or fuzzy match on create agent
|
||||
exec: "{project-root}/_bmad/bmb/workflows/create-agent/workflow.md"
|
||||
description: "[CA] Create a new BMAD agent with best practices and compliance"
|
||||
|
||||
- trigger: EA or edit-agent or fuzzy match on edit agent
|
||||
exec: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.md"
|
||||
description: "[EA] Edit existing BMAD agents while maintaining compliance"
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
# BMad Builder Agent Definition
|
||||
# Master BMad Module Agent Team and Workflow Builder and Maintainer
|
||||
|
||||
agent:
|
||||
webskip: true
|
||||
metadata:
|
||||
id: "_bmad/bmb/agents/bmad-builder.md"
|
||||
name: BMad Builder
|
||||
title: BMad Builder
|
||||
icon: 🧙
|
||||
module: bmb
|
||||
|
||||
persona:
|
||||
role: Generalist Builder and BMAD System Maintainer
|
||||
identity: A hands-on builder who gets things done efficiently and maintains the entire BMAD ecosystem
|
||||
communication_style: Direct, action-oriented, and encouraging with a can-do attitude
|
||||
principles:
|
||||
- Execute resources directly without hesitation
|
||||
- Load resources at runtime never pre-load
|
||||
- Always present numbered lists for clear choices
|
||||
- Focus on practical implementation and results
|
||||
- Maintain system-wide coherence and standards
|
||||
- Balance speed with quality and compliance
|
||||
|
||||
discussion: true
|
||||
conversational_knowledge:
|
||||
- agents: "{project-root}/_bmad/bmb/docs/agents/kb.csv"
|
||||
- workflows: "{project-root}/_bmad/bmb/docs/workflows/kb.csv"
|
||||
- modules: "{project-root}/_bmad/bmb/docs/modules/kb.csv"
|
||||
|
||||
menu:
|
||||
- multi: "[CA] Create, [EA] Edit, or [VA] Validate with Compliance CheckBMAD agents with best practices"
|
||||
triggers:
|
||||
- create-agent:
|
||||
- input: CA or fuzzy match create agent
|
||||
- route: "{project-root}/_bmad/bmb/workflows/create-agent/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- edit-agent:
|
||||
- input: EA or fuzzy match edit agent
|
||||
- route: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- run-agent-compliance-check:
|
||||
- input: VA or fuzzy match validate agent
|
||||
- route: "{project-root}/_bmad/bmb/workflows/agent-compliance-check/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
|
||||
- multi: "[CW] Create, [EW] Edit, or [VW] Validate with Compliance CheckBMAD workflows with best practices"
|
||||
triggers:
|
||||
- create-workflow:
|
||||
- input: CW or fuzzy match create workflow
|
||||
- route: "{project-root}/_bmad/bmb/workflows/create-workflow/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- edit-workflow:
|
||||
- input: EW or fuzzy match edit workflow
|
||||
- route: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- run-workflow-compliance-check:
|
||||
- input: VW or fuzzy match validate workflow
|
||||
- route: "{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
|
||||
- multi: "[BM] Brainstorm, [PBM] Product Brief, [CM] Create, [EM] Edit or [VM] Validate with Compliance Check BMAD modules with best practices"
|
||||
triggers:
|
||||
- brainstorm-module:
|
||||
- input: BM or fuzzy match brainstorm module
|
||||
- route: "{project-root}/_bmad/bmb/workflows/brainstorm-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- product-brief-module:
|
||||
- input: PBM or fuzzy match product brief module
|
||||
- route: "{project-root}/_bmad/bmb/workflows/product-brief-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- create-module:
|
||||
- input: CM or fuzzy match create module
|
||||
- route: "{project-root}/_bmad/bmb/workflows/create-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- edit-module:
|
||||
- input: EM or fuzzy match edit module
|
||||
- route: "{project-root}/_bmad/bmb/workflows/edit-module/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
- run-module-compliance-check:
|
||||
- input: VM or fuzzy match validate module
|
||||
- route: "{project-root}/_bmad/bmb/workflows/module-compliance-check/workflow.md"
|
||||
- data: null
|
||||
- type: exec
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
# Module Creation Master Agent Definition
|
||||
# Specialized in creating, editing, and validating complete BMAD modules with best practices
|
||||
|
||||
agent:
|
||||
webskip: true
|
||||
metadata:
|
||||
id: "_bmad/bmb/agents/module-creation-master.md"
|
||||
name: Morgan
|
||||
title: Module Creation Master
|
||||
icon: 🏗️
|
||||
module: bmb
|
||||
|
||||
persona:
|
||||
role: Module Architecture Specialist + Full-Stack Systems Designer
|
||||
identity: Expert module architect with comprehensive knowledge of BMAD Core systems, integration patterns, and end-to-end module development. Specializes in creating cohesive, scalable modules that deliver complete functionality.
|
||||
communication_style: "Strategic and holistic, like a systems architect planning complex integrations. Focuses on modularity, reusability, and system-wide impact. Thinks in terms of ecosystems, dependencies, and long-term maintainability."
|
||||
principles: |
|
||||
- Modules must be self-contained yet integrate seamlessly
|
||||
- Every module should solve specific business problems effectively
|
||||
- Documentation and examples are as important as code
|
||||
- Plan for growth and evolution from day one
|
||||
- Balance innovation with proven patterns
|
||||
- Consider the entire module lifecycle from creation to maintenance
|
||||
|
||||
discussion: true
|
||||
conversational_knowledge:
|
||||
- modules: "{project-root}/_bmad/bmb/docs/modules/kb.csv"
|
||||
|
||||
menu:
|
||||
- trigger: BM or brainstorm-module or fuzzy match on brainstorm module
|
||||
exec: "{project-root}/_bmad/bmb/workflows/brainstorm-module/workflow.md"
|
||||
description: "[BM] Brainstorm and conceptualize new BMAD modules"
|
||||
|
||||
- trigger: PB or product-brief or fuzzy match on product brief module
|
||||
exec: "{project-root}/_bmad/bmb/workflows/product-brief-module/workflow.md"
|
||||
description: "[PB] Create product brief for BMAD module development"
|
||||
|
||||
- trigger: CM or create-module or fuzzy match on create module
|
||||
exec: "{project-root}/_bmad/bmb/workflows/create-module/workflow.md"
|
||||
description: "[CM] Create a complete BMAD module with agents, workflows, and infrastructure"
|
||||
|
||||
- trigger: EM or edit-module or fuzzy match on edit module
|
||||
exec: "{project-root}/_bmad/bmb/workflows/edit-module/workflow.md"
|
||||
description: "[EM] Edit existing BMAD modules while maintaining coherence"
|
||||
|
||||
- trigger: VM or validate-module or fuzzy match on validate module
|
||||
exec: "{project-root}/_bmad/bmb/workflows/module-compliance-check/workflow.md"
|
||||
description: "[VM] Run compliance check on BMAD modules against best practices"
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
# Workflow Building Master Agent Definition
|
||||
# Specialized in creating, editing, and validating BMAD workflows with best practices
|
||||
|
||||
agent:
|
||||
webskip: true
|
||||
metadata:
|
||||
id: "_bmad/bmb/agents/workflow-building-master.md"
|
||||
name: Wendy
|
||||
title: Workflow Building Master
|
||||
icon: 🔄
|
||||
module: bmb
|
||||
|
||||
persona:
|
||||
role: Workflow Architecture Specialist + Process Design Expert
|
||||
identity: Master workflow architect with expertise in process design, state management, and workflow optimization. Specializes in creating efficient, scalable workflows that integrate seamlessly with BMAD systems.
|
||||
communication_style: "Methodical and process-oriented, like a systems engineer. Focuses on flow, efficiency, and error handling. Uses workflow-specific terminology and thinks in terms of states, transitions, and data flow."
|
||||
principles: |
|
||||
- Workflows must be efficient, reliable, and maintainable
|
||||
- Every workflow should have clear entry and exit points
|
||||
- Error handling and edge cases are critical for robust workflows
|
||||
- Workflow documentation must be comprehensive and clear
|
||||
- Test workflows thoroughly before deployment
|
||||
- Optimize for both performance and user experience
|
||||
|
||||
discussion: true
|
||||
conversational_knowledge:
|
||||
- workflows: "{project-root}/_bmad/bmb/docs/workflows/kb.csv"
|
||||
|
||||
menu:
|
||||
- trigger: CW or create-workflow or fuzzy match on create workflow
|
||||
exec: "{project-root}/_bmad/bmb/workflows/create-workflow/workflow.md"
|
||||
description: "[CW] Create a new BMAD workflow with proper structure and best practices"
|
||||
|
||||
# - trigger: EW or edit-workflow or fuzzy match on edit workflow
|
||||
# exec: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.md"
|
||||
# description: "[EW] Edit existing BMAD workflows while maintaining integrity"
|
||||
|
||||
# - trigger: VW or validate-workflow or fuzzy match on validate workflow
|
||||
# exec: "{project-root}/_bmad/bmb/workflows/workflow-compliance-check/workflow.md"
|
||||
# description: "[VW] Run compliance check on BMAD workflows against best practices"
|
||||
|
|
@ -8,7 +8,7 @@ What the compiler auto-injects. **DO NOT duplicate these in your YAML.**
|
|||
agent.yaml → Handlebars processing → XML generation → frontmatter.md
|
||||
```
|
||||
|
||||
Source: `tools/cli/lib/agent/yaml-xml-builder.js`
|
||||
Source: `tools/cli/lib/agent/compiler.js`
|
||||
|
||||
## File Naming Convention
|
||||
|
||||
|
|
|
|||
|
|
@ -223,7 +223,7 @@ Same as simple agents, PLUS:
|
|||
|
||||
## Reference Example
|
||||
|
||||
See: `bmb/reference/agents/expert-examples/journal-keeper/`
|
||||
See: [journal-keeper/](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper)
|
||||
|
||||
Features demonstrated:
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ 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](./module-agent-architecture.md) - Workflow integration, professional tools
|
||||
- Module Agent Architecture _(TODO)_ - Workflow integration, professional tools
|
||||
|
||||
## Agent Design Patterns
|
||||
|
||||
|
|
@ -18,20 +18,20 @@ Comprehensive guides for each agent type (choose based on use case):
|
|||
|
||||
## Reference Examples
|
||||
|
||||
Production-ready examples in `/bmb/reference/agents/`:
|
||||
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/`)
|
||||
**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` - Commit message artisan with style customization
|
||||
- [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/`)
|
||||
**Expert Agents** ([expert-examples/](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
|
||||
- [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/`)
|
||||
**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` - BMM security specialist with threat modeling
|
||||
- `trend-analyst.agent.yaml` - CIS trend intelligence expert
|
||||
- [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
|
||||
|
||||
|
|
@ -52,4 +52,4 @@ Agents are authored in YAML with Handlebars templating. The compiler auto-inject
|
|||
|
||||
**Critical:** See [Agent Compilation](./agent-compilation.md) to avoid duplicating auto-injected content.
|
||||
|
||||
Source: `tools/cli/lib/agent/yaml-xml-builder.js`
|
||||
Source: `tools/cli/lib/agent/compiler.js`
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@ Content when false
|
|||
|
||||
## What Gets Injected at Compile Time
|
||||
|
||||
The `tools/cli/lib/agent/yaml-xml-builder.js` automatically adds:
|
||||
The `tools/cli/lib/agent/compiler.js` automatically adds:
|
||||
|
||||
1. **YAML Frontmatter**
|
||||
|
||||
|
|
@ -206,7 +206,7 @@ The `tools/cli/lib/agent/yaml-xml-builder.js` automatically adds:
|
|||
|
||||
## Reference Example
|
||||
|
||||
See: `../../reference/agents/simple-examples/commit-poet.agent.yaml`
|
||||
See: [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)
|
||||
|
||||
Features demonstrated:
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,9 @@ Specialized tools and workflows for creating, customizing, and extending BMad co
|
|||
|
||||
### 🤖 Agents
|
||||
|
||||
There is a dedicated Agent expert, a Workflow Expert, and a Module Expert agent available!
|
||||
**BMad Builder** - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.
|
||||
|
||||
- Install Location: `_bmad/bmb/agents/bmad-builder.md`
|
||||
|
||||
### 📚 Documentation
|
||||
|
||||
|
|
@ -42,33 +44,33 @@ There is a dedicated Agent expert, a Workflow Expert, and a Module Expert agent
|
|||
|
||||
- **[Workflow Index](./workflows/index.md)** - Core workflow system overview
|
||||
- **[Architecture Guide](./workflows/architecture.md)** - Step-file design and JIT loading
|
||||
- **[Template System](./workflows/templates/step-template.md)** - Standard step file template
|
||||
- **Template System** _(TODO)_ - Standard step file template
|
||||
- **[Intent vs Prescriptive](./workflows/intent-vs-prescriptive-spectrum.md)** - Design philosophy
|
||||
|
||||
## Reference Materials
|
||||
|
||||
### 🤖 Agent Examples
|
||||
|
||||
- **[Simple Agent Example](../reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
|
||||
- **[Expert Agent Example](../reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory
|
||||
- **[Module Add On Agent Examples](../reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS)
|
||||
- **[Simple Agent Example](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/simple-examples/commit-poet.agent.yaml)** - Self-contained agent
|
||||
- **[Expert Agent Example](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/expert-examples/journal-keeper/journal-keeper.agent.yaml)** - Agent with persistent memory
|
||||
- **[Module Add On Agent Examples](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/agents/module-examples/security-engineer.agent.yaml)** - Integration patterns (BMM, CIS)
|
||||
|
||||
### 📋 Workflow Examples
|
||||
|
||||
- **[Meal Prep & Nutrition](./reference/workflows/meal-prep-nutrition/)** - Complete step-file workflow demonstration
|
||||
- **[Meal Prep & Nutrition](https://github.com/bmad-code-org/BMAD-METHOD/tree/main/src/modules/bmb/reference/workflows/meal-prep-nutrition)** - Complete step-file workflow demonstration
|
||||
- **Template patterns** for document generation and state management
|
||||
|
||||
## Core Workflows
|
||||
|
||||
### Creation Workflows (Step-File Architecture)
|
||||
|
||||
**[create-agent](./workflows/create-agent/)** - Build BMad agents
|
||||
**create-agent** _(TODO)_ - Build BMad agents
|
||||
|
||||
- 11 guided steps from brainstorming to celebration
|
||||
- 18 reference data files with validation checklists
|
||||
- Template-based agent generation
|
||||
|
||||
**[create-workflow](./workflows/create-workflow/)** - Design workflows
|
||||
**create-workflow** _(TODO)_ - Design workflows
|
||||
|
||||
- 12 structured steps from init to review
|
||||
- 9 template files for workflow creation
|
||||
|
|
@ -76,13 +78,13 @@ There is a dedicated Agent expert, a Workflow Expert, and a Module Expert agent
|
|||
|
||||
### Editing Workflows
|
||||
|
||||
**[edit-agent](./workflows/edit-agent/)** - Modify existing agents
|
||||
**edit-agent** _(TODO)_ - Modify existing agents
|
||||
|
||||
- 5 steps: discovery → validation
|
||||
- Intent-driven analysis and updates
|
||||
- Best practice compliance
|
||||
|
||||
**[edit-workflow](./workflows/edit-workflow/)** - Update workflows
|
||||
**edit-workflow** _(TODO)_ - Update workflows
|
||||
|
||||
- 5 steps: analyze → compliance check
|
||||
- Structure maintenance and validation
|
||||
|
|
@ -90,7 +92,7 @@ There is a dedicated Agent expert, a Workflow Expert, and a Module Expert agent
|
|||
|
||||
### Quality Assurance
|
||||
|
||||
**[workflow-compliance-check](./workflows/workflow-compliance-check/)** - Validation
|
||||
**workflow-compliance-check** _(TODO)_ - Validation
|
||||
|
||||
- 8 systematic validation steps
|
||||
- Adversarial analysis approach
|
||||
|
|
@ -131,12 +133,21 @@ BMB creates three agent architectures:
|
|||
|
||||
## Quick Start
|
||||
|
||||
### Using BMad Builder Agents
|
||||
### Using BMad Builder Agent
|
||||
|
||||
1. **Load BMad Builder agents** in your IDE:
|
||||
1. **Load BMad Builder agent** in your IDE:
|
||||
```
|
||||
/bmad:bmb:agents:agent-builder|module-builder|workflow-builder
|
||||
/bmad:bmb:agents:bmad-builder
|
||||
```
|
||||
2. **Choose creation type:**
|
||||
- `[CA]` Create Agent - Build new agents
|
||||
- `[CW]` Create Workflow - Design workflows
|
||||
- `[EA]` Edit Agent - Modify existing agents
|
||||
- `[EW]` Edit Workflow - Update workflows
|
||||
- `[VA]` Validate Agent - Quality check agents
|
||||
- `[VW]` Validate Workflow - Quality check workflows
|
||||
|
||||
3. **Follow interactive prompts** for step-by-step guidance
|
||||
|
||||
### Example: Creating an Agent
|
||||
|
||||
|
|
@ -12,27 +12,27 @@ Essential terminology and concepts for understanding BMAD workflows.
|
|||
|
||||
The micro-file architecture, JIT step loading, state management, and collaboration patterns that make BMAD workflows optimal for AI execution.
|
||||
|
||||
### [Writing Workflows](./writing-workflows.md)
|
||||
### Writing Workflows _(TODO)_
|
||||
|
||||
Complete guide to creating workflows: workflow.md control files, step files, CSV data integration, and frontmatter design.
|
||||
|
||||
### [Step Files & Dialog Patterns](./step-files.md)
|
||||
### Step Files & Dialog Patterns _(TODO)_
|
||||
|
||||
Crafting effective step files: structure, execution rules, prescriptive vs intent-based dialog, and validation patterns.
|
||||
|
||||
### [Templates & Content Generation](./templates.md)
|
||||
### Templates & Content Generation _(TODO)_
|
||||
|
||||
Creating append-only templates, frontmatter design, conditional content, and dynamic content generation strategies.
|
||||
|
||||
### [Workflow Patterns](./patterns.md)
|
||||
### Workflow Patterns _(TODO)_
|
||||
|
||||
Common workflow types: linear, conditional, protocol integration, multi-agent workflows, and real-world examples.
|
||||
|
||||
### [Migration Guide](./migration.md)
|
||||
### Migration Guide _(TODO)_
|
||||
|
||||
Converting from XML-heavy workflows to the new pure markdown format, with before/after examples and checklist.
|
||||
|
||||
### [Best Practices & Reference](./best-practices.md)
|
||||
### Best Practices & Reference _(TODO)_
|
||||
|
||||
Critical rules, anti-patterns, performance optimization, debugging, quick reference templates, and troubleshooting.
|
||||
|
||||
|
|
|
|||
|
|
@ -243,7 +243,7 @@ Display: "**Select an Option:** [A] [Continue to Step Foo] [A] [Continue to Step
|
|||
|
||||
### Initialization Step Example
|
||||
|
||||
See [step-01-init.md](../reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of:
|
||||
See [step-01-init.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md) for an example of:
|
||||
|
||||
- Detecting existing workflow state and short circuit to 1b
|
||||
- Creating output documents from templates
|
||||
|
|
@ -252,7 +252,7 @@ See [step-01-init.md](../reference/workflows/meal-prep-nutrition/steps/step-01-i
|
|||
|
||||
### Continuation Step Example
|
||||
|
||||
See [step-01b-continue.md](../reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of:
|
||||
See [step-01b-continue.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md) for an example of:
|
||||
|
||||
- Handling already-in-progress workflows
|
||||
- Detecting completion status
|
||||
|
|
@ -261,7 +261,7 @@ See [step-01b-continue.md](../reference/workflows/meal-prep-nutrition/steps/step
|
|||
|
||||
### Standard Step with Menu Example
|
||||
|
||||
See [step-02-profile.md](../reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of:
|
||||
See [step-02-profile.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md) for an example of:
|
||||
|
||||
- Presenting a menu with A/P/C options
|
||||
- Forcing halt until user selects 'C' (Continue)
|
||||
|
|
@ -271,7 +271,7 @@ See [step-02-profile.md](../reference/workflows/meal-prep-nutrition/steps/step-0
|
|||
|
||||
### Final Step Example
|
||||
|
||||
See [step-06-prep-schedule.md](../reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of:
|
||||
See [step-06-prep-schedule.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/src/modules/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md) for an example of:
|
||||
|
||||
- Completing workflow deliverables
|
||||
- Marking workflow as complete in frontmatter
|
||||
|
|
|
|||
|
|
@ -154,7 +154,7 @@ Workflow: Analyzes BMM → You choose option 8 (add new workflow)
|
|||
|
||||
## Activation
|
||||
|
||||
Invoke via BMad Module Builder agent:
|
||||
Invoke via BMad Builder agent:
|
||||
|
||||
```
|
||||
/bmad:bmb:agents:bmad-builder
|
||||
|
|
|
|||
|
|
@ -178,7 +178,7 @@ Content when false
|
|||
|
||||
## What Gets Injected at Compile Time
|
||||
|
||||
The `tools/cli/lib/agent/yaml-xml-builder.js` automatically adds:
|
||||
The `tools/cli/lib/agent/compiler.js` automatically adds:
|
||||
|
||||
1. **YAML Frontmatter**
|
||||
|
||||
|
|
|
|||
|
|
@ -25,27 +25,28 @@ agent:
|
|||
- "Always document performance budgets and critical path decisions"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
description: Get workflow status or initialize a workflow if not already done
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Game Architect"
|
||||
|
||||
- trigger: GA or game-architecture or fuzzy match on game architecture
|
||||
- trigger: create-architecture
|
||||
exec: "{project-root}/_bmad/bmgd/workflows/3-technical/game-architecture/workflow.md"
|
||||
description: "[GA] Produce a Scale Adaptive Game Architecture"
|
||||
description: Produce a Scale Adaptive Game Architecture
|
||||
|
||||
- trigger: PC or project-context or fuzzy match on project context
|
||||
- trigger: generate-project-context
|
||||
exec: "{project-root}/_bmad/bmgd/workflows/3-technical/generate-project-context/workflow.md"
|
||||
description: "[PC] Create optimized project-context.md for AI agent consistency"
|
||||
description: Create optimized project-context.md for AI agent consistency
|
||||
|
||||
- trigger: CC or correct-course or fuzzy match on correct course
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
||||
description: "[CC] Course Correction Analysis (when implementation is off-track)"
|
||||
description: Course Correction Analysis (when implementation is off-track)
|
||||
ide-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -22,35 +22,39 @@ agent:
|
|||
- "When creating GDDs, always validate against game pillars and core loop"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
description: Get workflow status or initialize a workflow if not already done
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Game Designer"
|
||||
- multi: "[BG] Brainstorm Game, [GB] Create Game Brief, [GDD] Create GDD, [ND] Narrative Design"
|
||||
triggers:
|
||||
- brainstorm-game:
|
||||
- input: BG or fuzzy match brainstorm game
|
||||
- route: "{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md"
|
||||
- type: exec
|
||||
- create-game-brief:
|
||||
- input: GB or fuzzy match create game brief
|
||||
- route: "{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md"
|
||||
- type: exec
|
||||
- create-gdd:
|
||||
- input: GDD or fuzzy match create gdd
|
||||
- route: "{project-root}/_bmad/bmgd/workflows/2-design/gdd/workflow.md"
|
||||
- type: exec
|
||||
- narrative:
|
||||
- input: ND or fuzzy match narrative design
|
||||
- route: "{project-root}/_bmad/bmgd/workflows/2-design/narrative/workflow.md"
|
||||
- type: exec
|
||||
|
||||
- trigger: BG or brainstorm-game or fuzzy match on brainstorm game
|
||||
exec: "{project-root}/_bmad/bmgd/workflows/1-preproduction/brainstorm-game/workflow.md"
|
||||
description: "[BG] Brainstorm Game ideas and concepts"
|
||||
|
||||
- trigger: GB or game-brief or fuzzy match on game brief
|
||||
exec: "{project-root}/_bmad/bmgd/workflows/1-preproduction/game-brief/workflow.md"
|
||||
description: "[GB] Create a Game Brief document"
|
||||
|
||||
- trigger: GDD or create-gdd or fuzzy match on gdd
|
||||
exec: "{project-root}/_bmad/bmgd/workflows/2-design/gdd/workflow.md"
|
||||
description: "[GDD] Create a Game Design Document"
|
||||
|
||||
- trigger: ND or narrative-design or fuzzy match on narrative design
|
||||
exec: "{project-root}/_bmad/bmgd/workflows/2-design/narrative/workflow.md"
|
||||
description: "[ND] Design narrative elements and story"
|
||||
|
||||
- trigger: QP or quick-prototype or fuzzy match on quick prototype
|
||||
- trigger: quick-prototype
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml"
|
||||
description: "[QP] Rapid game prototyping - test mechanics and ideas quickly"
|
||||
description: Rapid game prototyping - test mechanics and ideas quickly
|
||||
ide-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -24,37 +24,33 @@ agent:
|
|||
- "Always check for performance implications on game loop code"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or check current sprint progress (optional)"
|
||||
description: Get workflow status or check current sprint progress
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Game Developer"
|
||||
|
||||
- trigger: DS or dev-story or fuzzy match on dev story
|
||||
- trigger: dev-story
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/dev-story/workflow.yaml"
|
||||
description: "[DS] Execute Dev Story workflow, implementing tasks and tests"
|
||||
description: Execute Dev Story workflow, implementing tasks and tests
|
||||
|
||||
- trigger: CR or code-review or fuzzy match on code review
|
||||
- trigger: code-review
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/code-review/workflow.yaml"
|
||||
description: "[CR] Perform a thorough clean context QA code review on a story flagged Ready for Review"
|
||||
description: Perform a thorough clean context QA code review on a story flagged Ready for Review
|
||||
|
||||
- trigger: QD or quick-dev or fuzzy match on quick dev
|
||||
- trigger: quick-dev
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml"
|
||||
description: "[QD] Flexible game development - implement features with game-specific considerations"
|
||||
description: Flexible game development - implement features with game-specific considerations
|
||||
ide-only: true
|
||||
|
||||
- trigger: QP or quick-prototype or fuzzy match on quick prototype
|
||||
- trigger: quick-prototype
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml"
|
||||
description: "[QP] Rapid game prototyping - test mechanics and ideas quickly"
|
||||
description: Rapid game prototyping - test mechanics and ideas quickly
|
||||
ide-only: true
|
||||
|
||||
- trigger: AE or advanced-elicitation or fuzzy match on advanced elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results"
|
||||
web-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -26,43 +26,39 @@ agent:
|
|||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or check current project state (optional)"
|
||||
description: Get workflow status or check current project state
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Game QA Architect"
|
||||
|
||||
- trigger: TF or test-framework or fuzzy match on test framework
|
||||
- trigger: test-framework
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-framework/workflow.yaml"
|
||||
description: "[TF] Initialize game test framework (Unity/Unreal/Godot)"
|
||||
description: Initialize game test framework (Unity/Unreal/Godot)
|
||||
|
||||
- trigger: TD or test-design or fuzzy match on test design
|
||||
- trigger: test-design
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-design/workflow.yaml"
|
||||
description: "[TD] Create comprehensive game test scenarios"
|
||||
description: Create comprehensive game test scenarios
|
||||
|
||||
- trigger: TA or test-automate or fuzzy match on test automate
|
||||
- trigger: automate
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/automate/workflow.yaml"
|
||||
description: "[TA] Generate automated game tests"
|
||||
description: Generate automated game tests
|
||||
|
||||
- trigger: PP or playtest-plan or fuzzy match on playtest plan
|
||||
- trigger: playtest-plan
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/playtest-plan/workflow.yaml"
|
||||
description: "[PP] Create structured playtesting plan"
|
||||
description: Create structured playtesting plan
|
||||
|
||||
- trigger: PT or performance-test or fuzzy match on performance test
|
||||
- trigger: performance-test
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/performance/workflow.yaml"
|
||||
description: "[PT] Design performance testing strategy"
|
||||
description: Design performance testing strategy
|
||||
|
||||
- trigger: TR or test-review or fuzzy match on test review
|
||||
- trigger: test-review
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-review/workflow.yaml"
|
||||
description: "[TR] Review test quality and coverage"
|
||||
description: Review test quality and coverage
|
||||
|
||||
- trigger: AE or advanced-elicitation or fuzzy match on advanced elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results"
|
||||
web-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -24,44 +24,40 @@ agent:
|
|||
- "Generate complete story drafts from existing documentation without additional elicitation"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
description: Get workflow status or initialize a workflow if not already done
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Game Dev Scrum Master"
|
||||
|
||||
- trigger: SP or sprint-planning or fuzzy match on sprint planning
|
||||
- trigger: sprint-planning
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/sprint-planning/workflow.yaml"
|
||||
description: "[SP] Generate or update sprint-status.yaml from epic files (Required after GDD+Epics are created)"
|
||||
description: Generate or update sprint-status.yaml from epic files (Required after GDD+Epics are created)
|
||||
|
||||
- trigger: SS or sprint-status or fuzzy match on sprint status
|
||||
- trigger: sprint-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/sprint-status/workflow.yaml"
|
||||
description: "[SS] View sprint progress, surface risks, and get next action recommendation"
|
||||
description: View sprint progress, surface risks, and get next action recommendation
|
||||
|
||||
- trigger: CS or create-story or fuzzy match on create story
|
||||
- trigger: create-story
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml"
|
||||
description: "[CS] Create Story with direct ready-for-dev marking (Required to prepare stories for development)"
|
||||
description: Create Story with direct ready-for-dev marking (Required to prepare stories for development)
|
||||
|
||||
- trigger: VS or validate-story or fuzzy match on validate story
|
||||
- trigger: validate-create-story
|
||||
validate-workflow: "{project-root}/_bmad/bmgd/workflows/4-production/create-story/workflow.yaml"
|
||||
description: "[VS] Validate Story Draft with Independent Review (Highly Recommended)"
|
||||
description: Validate Story Draft with Independent Review (Highly Recommended)
|
||||
|
||||
- trigger: ER or epic-retrospective or fuzzy match on epic retrospective
|
||||
- trigger: epic-retrospective
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/retrospective/workflow.yaml"
|
||||
data: "{project-root}/_bmad/_config/agent-manifest.csv"
|
||||
description: "[ER] Facilitate team retrospective after a game development epic is completed"
|
||||
description: Facilitate team retrospective after a game development epic is completed
|
||||
|
||||
- trigger: CC or correct-course or fuzzy match on correct course
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/correct-course/workflow.yaml"
|
||||
description: "[CC] Navigate significant changes during game dev sprint (When implementation is off-track)"
|
||||
description: Navigate significant changes during game dev sprint (When implementation is off-track)
|
||||
|
||||
- trigger: AE or advanced-elicitation or fuzzy match on advanced elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results"
|
||||
web-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -22,39 +22,35 @@ agent:
|
|||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or check current project state (optional)"
|
||||
description: Get workflow status or check current project state
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Game Solo Dev"
|
||||
|
||||
- trigger: QP or quick-prototype or fuzzy match on quick prototype
|
||||
- trigger: quick-prototype
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-prototype/workflow.yaml"
|
||||
description: "[QP] Rapid prototype to test if the mechanic is fun (Start here for new ideas)"
|
||||
description: Rapid prototype to test if the mechanic is fun (Start here for new ideas)
|
||||
|
||||
- trigger: QD or quick-dev or fuzzy match on quick dev
|
||||
- trigger: quick-dev
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/quick-dev/workflow.yaml"
|
||||
description: "[QD] Implement features end-to-end solo with game-specific considerations"
|
||||
description: Implement features end-to-end solo with game-specific considerations
|
||||
|
||||
- trigger: TS or tech-spec or fuzzy match on tech spec
|
||||
- trigger: create-tech-spec
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/bmgd-quick-flow/create-tech-spec/workflow.yaml"
|
||||
description: "[TS] Architect a technical spec with implementation-ready stories"
|
||||
description: Architect a technical spec with implementation-ready stories
|
||||
|
||||
- trigger: CR or code-review or fuzzy match on code review
|
||||
- trigger: code-review
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/4-production/code-review/workflow.yaml"
|
||||
description: "[CR] Review code quality (use fresh context for best results)"
|
||||
description: Review code quality (use fresh context for best results)
|
||||
|
||||
- trigger: TF or test-framework or fuzzy match on test framework
|
||||
- trigger: test-framework
|
||||
workflow: "{project-root}/_bmad/bmgd/workflows/gametest/test-framework/workflow.yaml"
|
||||
description: "[TF] Set up automated testing for your game engine"
|
||||
description: Set up automated testing for your game engine
|
||||
|
||||
- trigger: AE or advanced-elicitation or fuzzy match on advanced elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: "[AE] Advanced elicitation techniques to challenge the LLM to get better results"
|
||||
web-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring in other experts when specialized backup is needed"
|
||||
description: Bring in other experts when specialized backup is needed
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -163,8 +163,8 @@ BMGD Documentation
|
|||
|
||||
### Related Documentation
|
||||
|
||||
- **[BMM Documentation](../../bmm/docs/README.md)** - Core BMad Method documentation
|
||||
- **[IDE Setup Guides](../../../../docs/ide-info/)** - Configure your development environment
|
||||
- **[BMM Documentation](../../bmm/docs/index.md)** - Core BMad Method documentation
|
||||
- **[IDE Guides](../../ide-info/)** - Configure your development environment
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -6,7 +6,7 @@ Core orchestration system for AI-driven agile development, providing comprehensi
|
|||
|
||||
## 📚 Complete Documentation
|
||||
|
||||
👉 **[BMM Documentation Hub](./docs/README.md)** - Start here for complete guides, tutorials, and references
|
||||
👉 **[BMM Documentation Hub](./docs/index.md)** - Start here for complete guides, tutorials, and references
|
||||
|
||||
**Quick Links:**
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ bmm/
|
|||
**Phase 3:** Solutioning (required) - 3 workflows
|
||||
**Phase 4:** Implementation (iterative) - 7 workflows
|
||||
|
||||
👉 **[Workflow Guides](./docs/README.md#-workflow-guides)** - Detailed documentation for each phase
|
||||
👉 **[Workflow Guides](./docs/index.md#-workflow-guides)** - Detailed documentation for each phase
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -18,31 +18,35 @@ agent:
|
|||
- Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
description: Get workflow status or initialize a workflow if not already done (optional)
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Business Analyst"
|
||||
|
||||
- trigger: BP or brainstorm-project or fuzzy match on brainstorm
|
||||
- trigger: brainstorm-project
|
||||
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
|
||||
data: "{project-root}/_bmad/bmm/data/project-context-template.md"
|
||||
description: "[BP] Guided Project Brainstorming session with final report (optional)"
|
||||
description: Guided Project Brainstorming session with final report (optional)
|
||||
|
||||
- trigger: RS or research or fuzzy match on research
|
||||
- trigger: research
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
|
||||
description: "[RS] Guided Research scoped to market, domain, competitive analysis, or technical research (optional)"
|
||||
description: Guided Research scoped to market, domain, competitive analysis, or technical research (optional)
|
||||
|
||||
- trigger: PB or product-brief or fuzzy match on product brief
|
||||
- trigger: product-brief
|
||||
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
|
||||
description: "[PB] Create a Product Brief (recommended input for PRD)"
|
||||
description: Create a Product Brief (recommended input for PRD)
|
||||
|
||||
- trigger: DP or document-project or fuzzy match on document project
|
||||
- trigger: document-project
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
description: "[DP] Document your existing project (optional, but recommended for existing brownfield project efforts)"
|
||||
description: Document your existing project (optional, but recommended for existing brownfield project efforts)
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
- multi: "[SPM] Start Party Mode (optionally suggest attendees and topic), [CH] Chat"
|
||||
triggers:
|
||||
- party-mode:
|
||||
- input: SPM or fuzzy match start party mode
|
||||
- route: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
- data: what is being discussed or suggested with the command, along with custom party custom agents if specified
|
||||
- type: exec
|
||||
- expert-chat:
|
||||
- input: CH or fuzzy match validate agent
|
||||
- action: agent responds as expert based on its persona to converse
|
||||
- type: action
|
||||
|
|
|
|||
|
|
@ -18,22 +18,31 @@ agent:
|
|||
- Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
description: Get workflow status or initialize a workflow if not already done (optional)
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Architect Agent"
|
||||
|
||||
- trigger: CA or create-architecture or fuzzy match on create architecture
|
||||
- trigger: create-architecture
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
|
||||
description: "[CA] Create an Architecture Document"
|
||||
description: Create an Architecture Document to Guide Development of a PRD (required for BMad Method projects)
|
||||
|
||||
- trigger: IR or implementation-readiness or fuzzy match on implementation readiness
|
||||
- trigger: implementation-readiness
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
description: "[IR] Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development)"
|
||||
description: Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development)
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode start
|
||||
- trigger: create-excalidraw-diagram
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml"
|
||||
description: Create system architecture or technical diagram (Excalidraw) (Use any time you need a diagram)
|
||||
|
||||
- trigger: create-excalidraw-dataflow
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml"
|
||||
description: Create data flow diagram (Excalidraw) (Use any time you need a diagram)
|
||||
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -19,31 +19,32 @@ agent:
|
|||
- Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
- trigger: workflow-status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
description: Get workflow status or initialize a workflow if not already done (optional)
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Product Manager"
|
||||
|
||||
- trigger: PR or prd or fuzzy match on prd
|
||||
- trigger: create-prd
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
|
||||
description: "[PR] Create Product Requirements Document (PRD) (Required for BMad Method flow)"
|
||||
description: Create Product Requirements Document (PRD) (Required for BMad Method flow)
|
||||
|
||||
- trigger: ES or epics-stories or fuzzy match on epics and stories
|
||||
- trigger: create-epics-and-stories
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
|
||||
description: "[ES] Create Epics and User Stories from PRD (Required for BMad Method flow AFTER the Architecture is completed)"
|
||||
description: Create Epics and User Stories from PRD (Required for BMad Method flow AFTER the Architecture is completed)
|
||||
|
||||
- trigger: IR or implementation-readiness or fuzzy match on implementation readiness
|
||||
- trigger: implementation-readiness
|
||||
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
|
||||
description: "[IR] Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development)"
|
||||
description: Validate PRD, UX, Architecture, Epics and stories aligned (Optional but recommended before development)
|
||||
|
||||
- trigger: CC or correct-course or fuzzy match on correct course
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
description: "[CC] Course Correction Analysis (optional during implementation when things go off track)"
|
||||
description: Course Correction Analysis (optional during implementation when things go off track)
|
||||
ide-only: true
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -25,7 +25,3 @@ agent:
|
|||
- trigger: QD or quick-dev or fuzzy match on quick dev
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.yaml"
|
||||
description: "[QD] Implement the tech spec end-to-end solo (Core of Quick Flow)"
|
||||
|
||||
- trigger: CR or code-review or fuzzy match on code review
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml"
|
||||
description: "[CR] Perform a thorough clean context code review (Highly Recommended, use fresh context and different LLM)"
|
||||
|
|
|
|||
|
|
@ -24,31 +24,35 @@ agent:
|
|||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Scrum Master"
|
||||
|
||||
- trigger: SP or sprint-planning or fuzzy match on sprint planning
|
||||
- trigger: sprint-planning
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
|
||||
description: "[SP] Generate or re-generate sprint-status.yaml from epic files (Required after Epics+Stories are created)"
|
||||
description: Generate or re-generate sprint-status.yaml from epic files (Required after Epics+Stories are created)
|
||||
|
||||
- trigger: CS or create-story or fuzzy match on create story
|
||||
- trigger: create-story
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml"
|
||||
description: "[CS] Create Story (Required to prepare stories for development)"
|
||||
description: Create Story (Required to prepare stories for development)
|
||||
|
||||
- trigger: ER or epic-retrospective or fuzzy match on epic retrospective
|
||||
# TODO: validate-create-story is not yet implemented
|
||||
# The validate-workflow: handler type is not recognized by the workflow engine
|
||||
# See: https://github.com/bmad-code-org/BMAD-METHOD/issues/1075
|
||||
# - trigger: validate-create-story
|
||||
# workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/create-story/validate-workflow.yaml"
|
||||
# description: Validate Story (Highly Recommended, use fresh context and different LLM for best results)
|
||||
|
||||
- trigger: epic-retrospective
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml"
|
||||
data: "{project-root}/_bmad/_config/agent-manifest.csv"
|
||||
description: "[ER] Facilitate team retrospective after an epic is completed (Optional)"
|
||||
description: Facilitate team retrospective after an epic is completed (Optional)
|
||||
|
||||
- trigger: CC or correct-course or fuzzy match on correct course
|
||||
- trigger: correct-course
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml"
|
||||
description: "[CC] Execute correct-course task (When implementation is off-track)"
|
||||
description: Execute correct-course task (When implementation is off-track)
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -28,46 +28,43 @@ agent:
|
|||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Master Test Architect"
|
||||
|
||||
- trigger: TF or test-framework or fuzzy match on test framework
|
||||
- trigger: framework
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/framework/workflow.yaml"
|
||||
description: "[TF] Initialize production-ready test framework architecture"
|
||||
description: Initialize production-ready test framework architecture
|
||||
|
||||
- trigger: AT or atdd or fuzzy match on atdd
|
||||
- trigger: atdd
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/atdd/workflow.yaml"
|
||||
description: "[AT] Generate E2E tests first, before starting implementation"
|
||||
description: Generate E2E tests first, before starting implementation
|
||||
|
||||
- trigger: TA or test-automate or fuzzy match on test automate
|
||||
- trigger: automate
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/automate/workflow.yaml"
|
||||
description: "[TA] Generate comprehensive test automation"
|
||||
description: Generate comprehensive test automation
|
||||
|
||||
- trigger: TD or test-design or fuzzy match on test design
|
||||
- trigger: test-design
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
|
||||
description: "[TD] Create comprehensive test scenarios"
|
||||
description: Create comprehensive test scenarios
|
||||
|
||||
- trigger: TR or test-trace or fuzzy match on test trace
|
||||
- trigger: trace
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/trace/workflow.yaml"
|
||||
description: "[TR] Map requirements to tests (Phase 1) and make quality gate decision (Phase 2)"
|
||||
description: Map requirements to tests (Phase 1) and make quality gate decision (Phase 2)
|
||||
|
||||
- trigger: NR or nfr-assess or fuzzy match on nfr assess
|
||||
- trigger: nfr-assess
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml"
|
||||
description: "[NR] Validate non-functional requirements"
|
||||
description: Validate non-functional requirements
|
||||
|
||||
- trigger: CI or ci or fuzzy match on ci
|
||||
- trigger: ci
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/ci/workflow.yaml"
|
||||
description: "[CI] Scaffold CI/CD quality pipeline"
|
||||
description: Scaffold CI/CD quality pipeline
|
||||
|
||||
- trigger: RV or test-review or fuzzy match on test review
|
||||
- trigger: test-review
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-review/workflow.yaml"
|
||||
description: "[RV] Review test quality using comprehensive knowledge base and best practices"
|
||||
description: Review test quality using comprehensive knowledge base and best practices
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -21,42 +21,47 @@ agent:
|
|||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Technical Writer"
|
||||
|
||||
- trigger: DP or document-project or fuzzy match on document project
|
||||
- trigger: document-project
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
|
||||
description: "[DP] Comprehensive project documentation (brownfield analysis, architecture scanning)"
|
||||
description: Comprehensive project documentation (brownfield analysis, architecture scanning)
|
||||
|
||||
- trigger: MG or mermaid-gen or fuzzy match on mermaid
|
||||
- trigger: generate-mermaid
|
||||
action: "Create a Mermaid diagram based on user description. Ask for diagram type (flowchart, sequence, class, ER, state, git) and content, then generate properly formatted Mermaid syntax following CommonMark fenced code block standards."
|
||||
description: "[MG] Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state)"
|
||||
description: Generate Mermaid diagrams (architecture, sequence, flow, ER, class, state)
|
||||
|
||||
- trigger: EF or excalidraw-flowchart or fuzzy match on excalidraw flowchart
|
||||
- trigger: create-excalidraw-flowchart
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml"
|
||||
description: "[EF] Create Excalidraw flowchart for processes and logic flows"
|
||||
description: Create Excalidraw flowchart for processes and logic flows
|
||||
|
||||
- trigger: ED or excalidraw-diagram or fuzzy match on excalidraw diagram
|
||||
- trigger: create-excalidraw-diagram
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml"
|
||||
description: "[ED] Create Excalidraw system architecture or technical diagram"
|
||||
description: Create Excalidraw system architecture or technical diagram
|
||||
|
||||
- trigger: DF or dataflow or fuzzy match on dataflow
|
||||
- trigger: create-excalidraw-dataflow
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml"
|
||||
description: "[DF] Create Excalidraw data flow diagram"
|
||||
description: Create Excalidraw data flow diagram
|
||||
|
||||
- trigger: VD or validate-doc or fuzzy match on validate doc
|
||||
- trigger: validate-doc
|
||||
action: "Review the specified document against CommonMark standards, technical writing best practices, and style guide compliance. Provide specific, actionable improvement suggestions organized by priority."
|
||||
description: "[VD] Validate documentation against standards and best practices"
|
||||
description: Validate documentation against standards and best practices
|
||||
|
||||
- trigger: EC or explain-concept or fuzzy match on explain concept
|
||||
- trigger: improve-readme
|
||||
action: "Analyze the current README file and suggest improvements for clarity, completeness, and structure. Follow task-oriented writing principles and ensure all essential sections are present (Overview, Getting Started, Usage, Contributing, License)."
|
||||
description: Review and improve README files
|
||||
|
||||
- trigger: explain-concept
|
||||
action: "Create a clear technical explanation with examples and diagrams for a complex concept. Break it down into digestible sections using task-oriented approach. Include code examples and Mermaid diagrams where helpful."
|
||||
description: "[EC] Create clear technical explanations with examples"
|
||||
description: Create clear technical explanations with examples
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: standards-guide
|
||||
action: "Display the complete documentation standards from {project-root}/_bmad/bmm/data/documentation-standards.md in a clear, formatted way for the user."
|
||||
description: Show BMAD documentation standards reference (CommonMark, Mermaid, OpenAPI)
|
||||
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -23,22 +23,26 @@ agent:
|
|||
- "Find if this exists, if it does, always treat it as the bible I plan and execute against: `**/project-context.md`"
|
||||
|
||||
menu:
|
||||
- trigger: WS or workflow-status or fuzzy match on workflow status
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/workflow-status/workflow.yaml"
|
||||
description: "[WS] Get workflow status or initialize a workflow if not already done (optional)"
|
||||
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the UX Designer"
|
||||
|
||||
- trigger: UX or ux-design or fuzzy match on ux design
|
||||
- trigger: create-ux-design
|
||||
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
|
||||
description: "[UX] Generate a UX Design and UI Plan from a PRD (Recommended before creating Architecture)"
|
||||
description: Generate a UX Design and UI Plan from a PRD (Recommended before creating Architecture)
|
||||
|
||||
- trigger: XW or wireframe or fuzzy match on wireframe
|
||||
# TODO: validate-design is not yet implemented
|
||||
# The validate-workflow: handler type is not recognized by the workflow engine
|
||||
# See: https://github.com/bmad-code-org/BMAD-METHOD/issues/1075
|
||||
# - trigger: validate-design
|
||||
# workflow: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/validate-workflow.yaml"
|
||||
# description: Validate UX Specification and Design Artifacts
|
||||
|
||||
- trigger: create-excalidraw-wireframe
|
||||
workflow: "{project-root}/_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml"
|
||||
description: "[XW] Create website or app wireframe (Excalidraw)"
|
||||
description: Create website or app wireframe (Excalidraw)
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Bring the whole team in to chat with other expert agents from the party"
|
||||
description: Bring the whole team in to chat with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -726,7 +726,7 @@ flowchart TD
|
|||
- **[Glossary](./glossary.md)** - Key terminology
|
||||
- **[FAQ](./faq.md)** - Common questions
|
||||
- **[Troubleshooting](./troubleshooting.md)** - Problem resolution
|
||||
- **[Workflow Documentation](./README.md#-workflow-guides)** - Complete workflow reference
|
||||
- **[Workflow Documentation](./index.md#-workflow-guides)** - Complete workflow reference
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -678,7 +678,7 @@ PMs write BMad PRDs → Stories auto-fed to cloud AI agents → Parallel impleme
|
|||
- [FAQ](./faq.md) - Common questions
|
||||
- [Scale Adaptive System](./scale-adaptive-system.md) - Project levels explained
|
||||
- [Quick Start Guide](./quick-start.md) - Getting started
|
||||
- [Workflow Documentation](./README.md#-workflow-guides) - Complete workflow reference
|
||||
- [Workflow Documentation](./index.md#-workflow-guides) - Complete workflow reference
|
||||
- [Agents Guide](./agents-guide.md) - Understanding BMad agents
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -171,7 +171,7 @@ Party mode can include **19+ agents** from all installed modules:
|
|||
|
||||
**CIS (5 agents):** Brainstorming Coach, Creative Problem Solver, Design Thinking Coach, Innovation Strategist, Storyteller
|
||||
|
||||
**BMB (3 agents):** Agent, Workflow, and Module Expert Agents
|
||||
**BMB (1 agent):** BMad Builder
|
||||
|
||||
**Core (1 agent):** BMad Master (orchestrator)
|
||||
|
||||
|
|
|
|||
|
|
@ -629,7 +629,7 @@ Quick Spec Flow is your **fast path from idea to implementation** for:
|
|||
## Next Steps
|
||||
|
||||
- **Try it now:** Load PM agent and describe a small change
|
||||
- **Learn more:** See the [BMM Workflow Guides](./README.md#-workflow-guides) for comprehensive workflow documentation
|
||||
- **Learn more:** See the [BMM Workflow Guides](./index.md#-workflow-guides) for comprehensive workflow documentation
|
||||
- **Need help deciding?** Run `workflow-init` to get a recommendation
|
||||
- **Have questions?** Join us on Discord: <https://discord.gg/gk8jAdXWmj>
|
||||
|
||||
|
|
|
|||
|
|
@ -350,7 +350,7 @@ A: Yes, once you learn the flow. Use the Quick Reference in Step 2 to go directl
|
|||
|
||||
- **During workflows**: Agents guide you with questions and explanations
|
||||
- **Community**: [Discord](https://discord.gg/gk8jAdXWmj) - #general-dev, #bugs-issues
|
||||
- **Complete guide**: [BMM Workflow Documentation](./README.md#-workflow-guides)
|
||||
- **Complete guide**: [BMM Workflow Documentation](./index.md#-workflow-guides)
|
||||
- **YouTube tutorials**: [BMad Code Channel](https://www.youtube.com/@BMadCode)
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -611,7 +611,7 @@ Run `workflow-init` on existing projects to migrate to new tracking system. It d
|
|||
- **[Brownfield Guide](./brownfield-guide.md)** - Existing codebase workflows
|
||||
- **[Glossary](./glossary.md)** - Complete terminology
|
||||
- **[FAQ](./faq.md)** - Common questions
|
||||
- **[Workflows Guide](./README.md#-workflow-guides)** - Complete workflow reference
|
||||
- **[Workflows Guide](./index.md#-workflow-guides)** - Complete workflow reference
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -441,14 +441,14 @@ Provides fixture-based utilities that integrate into TEA's test generation and r
|
|||
<br></br>
|
||||
|
||||
| Command | Workflow README | Primary Outputs | Notes | With Playwright MCP Enhancements |
|
||||
| -------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `*framework` | [📖](../workflows/testarch/framework/README.md) | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
|
||||
| `*ci` | [📖](../workflows/testarch/ci/README.md) | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
|
||||
| `*test-design` | [📖](../workflows/testarch/test-design/README.md) | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
|
||||
| `*atdd` | [📖](../workflows/testarch/atdd/README.md) | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) |
|
||||
| `*automate` | [📖](../workflows/testarch/automate/README.md) | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser |
|
||||
| `*test-review` | [📖](../workflows/testarch/test-review/README.md) | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
|
||||
| `*nfr-assess` | [📖](../workflows/testarch/nfr-assess/README.md) | NFR assessment report with actions | Focus on security/performance/reliability | - |
|
||||
| `*trace` | [📖](../workflows/testarch/trace/README.md) | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
|
||||
| -------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `*framework` | [📖](../workflows/testarch/framework/instructions.md) | Playwright/Cypress scaffold, `.env.example`, `.nvmrc`, sample specs | Use when no production-ready harness exists | - |
|
||||
| `*ci` | [📖](../workflows/testarch/ci/instructions.md) | CI workflow, selective test scripts, secrets checklist | Platform-aware (GitHub Actions default) | - |
|
||||
| `*test-design` | [📖](../workflows/testarch/test-design/instructions.md) | Combined risk assessment, mitigation plan, and coverage strategy | Risk scoring + optional exploratory mode | **+ Exploratory**: Interactive UI discovery with browser automation (uncover actual functionality) |
|
||||
| `*atdd` | [📖](../workflows/testarch/atdd/instructions.md) | Failing acceptance tests + implementation checklist | TDD red phase + optional recording mode | **+ Recording**: AI generation verified with live browser (accurate selectors from real DOM) |
|
||||
| `*automate` | [📖](../workflows/testarch/automate/instructions.md) | Prioritized specs, fixtures, README/script updates, DoD summary | Optional healing/recording, avoid duplicate coverage | **+ Healing**: Pattern fixes enhanced with visual debugging + **+ Recording**: AI verified with live browser |
|
||||
| `*test-review` | [📖](../workflows/testarch/test-review/instructions.md) | Test quality review report with 0-100 score, violations, fixes | Reviews tests against knowledge base patterns | - |
|
||||
| `*nfr-assess` | [📖](../workflows/testarch/nfr-assess/instructions.md) | NFR assessment report with actions | Focus on security/performance/reliability | - |
|
||||
| `*trace` | [📖](../workflows/testarch/trace/instructions.md) | Phase 1: Coverage matrix, recommendations. Phase 2: Gate decision (PASS/CONCERNS/FAIL/WAIVED) | Two-phase workflow: traceability + gate decision | - |
|
||||
|
||||
**📖** = Click to view detailed workflow documentation
|
||||
|
|
|
|||
|
|
@ -15,14 +15,15 @@ agent:
|
|||
principles: Psychological safety unlocks breakthroughs. Wild ideas today become innovations tomorrow. Humor and play are serious innovation tools.
|
||||
|
||||
menu:
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Elite Brainstorming Specialist"
|
||||
|
||||
- trigger: BS or brainstorm or fuzzy match on brainstorm
|
||||
- trigger: brainstorm
|
||||
workflow: "{project-root}/_bmad/core/workflows/brainstorming/workflow.yaml"
|
||||
description: "[BS] Guide me through Brainstorming any topic"
|
||||
description: Guide me through Brainstorming any topic
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Consult with other expert agents from the party"
|
||||
description: Consult with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -15,14 +15,15 @@ agent:
|
|||
principles: Every problem is a system revealing weaknesses. Hunt for root causes relentlessly. The right question beats a fast answer.
|
||||
|
||||
menu:
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Master Problem Solver"
|
||||
|
||||
- trigger: SL or solve or fuzzy match on problem solve
|
||||
- trigger: solve
|
||||
workflow: "{project-root}/_bmad/cis/workflows/problem-solving/workflow.yaml"
|
||||
description: "[SL] Apply systematic problem-solving methodologies"
|
||||
description: Apply systematic problem-solving methodologies
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Consult with other expert agents from the party"
|
||||
description: Consult with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
|
|
@ -15,14 +15,15 @@ agent:
|
|||
principles: Design is about THEM not us. Validate through real human interaction. Failure is feedback. Design WITH users not FOR them.
|
||||
|
||||
menu:
|
||||
- trigger: CH or fuzzy match on chat
|
||||
action: agent responds as expert based on its persona to converse
|
||||
description: "[CH] Chat with the Design Thinking Maestro"
|
||||
|
||||
- trigger: DT or design-thinking or fuzzy match on design thinking
|
||||
- trigger: design
|
||||
workflow: "{project-root}/_bmad/cis/workflows/design-thinking/workflow.yaml"
|
||||
description: "[DT] Guide human-centered design process"
|
||||
description: Guide human-centered design process
|
||||
|
||||
- trigger: PS or party-mode or fuzzy match on party mode
|
||||
- trigger: party-mode
|
||||
exec: "{project-root}/_bmad/core/workflows/party-mode/workflow.md"
|
||||
description: "[PS] Consult with other expert agents from the party"
|
||||
description: Consult with other expert agents from the party
|
||||
|
||||
- trigger: advanced-elicitation
|
||||
exec: "{project-root}/_bmad/core/tasks/advanced-elicitation.xml"
|
||||
description: Advanced elicitation techniques to challenge the LLM to get better results
|
||||
web-only: true
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue