docs updated

This commit is contained in:
Brian Madison
2025-10-01 18:28:35 -05:00
parent 7ebbe9fd5f
commit f077a31aa0
77 changed files with 10045 additions and 98 deletions

View File

@@ -0,0 +1,216 @@
# Build Workflow
## Overview
The Build Workflow is an interactive workflow builder that guides you through creating new BMAD workflows with proper structure, conventions, and validation. It ensures all workflows follow best practices for optimal human-AI collaboration and are fully compliant with the BMAD Core v6 workflow execution engine.
## Key Features
- **Optional Brainstorming Phase**: Creative exploration of workflow ideas before structured development
- **Comprehensive Guidance**: Step-by-step process with detailed instructions and examples
- **Template-Based**: Uses proven templates for all workflow components
- **Convention Enforcement**: Ensures adherence to BMAD workflow creation guide
- **README Generation**: Automatically creates comprehensive documentation
- **Validation Built-In**: Includes checklist generation for quality assurance
- **Type-Aware**: Adapts to document, action, interactive, autonomous, or meta-workflow types
## Usage
### Basic Invocation
```bash
workflow create-workflow
```
### Through BMad Builder Agent
```
*create-workflow
```
### What You'll Be Asked
1. **Optional**: Whether to brainstorm workflow ideas first (creative exploration phase)
2. Workflow name and target module
3. Workflow purpose and type (enhanced by brainstorming insights if used)
4. Metadata (description, author, outputs)
5. Step-by-step design (goals, variables, flow)
6. Whether to include optional components
## Workflow Structure
### Files Included
```
create-workflow/
├── workflow.yaml # Configuration and metadata
├── instructions.md # Step-by-step execution guide
├── checklist.md # Validation criteria
├── workflow-creation-guide.md # Comprehensive reference guide
├── README.md # This file
└── workflow-template/ # Templates for new workflows
├── workflow.yaml
├── instructions.md
├── template.md
├── checklist.md
└── README.md
```
## Workflow Process
### Phase 0: Optional Brainstorming (Step -1)
- **Creative Exploration**: Option to brainstorm workflow ideas before structured development
- **Design Concept Development**: Generate multiple approaches and explore different possibilities
- **Requirement Clarification**: Use brainstorming output to inform workflow purpose, type, and structure
- **Enhanced Creativity**: Leverage AI brainstorming tools for innovative workflow design
The brainstorming phase invokes the CIS brainstorming workflow to:
- Explore workflow ideas and approaches
- Clarify requirements and use cases
- Generate creative solutions for complex automation needs
- Inform the structured workflow building process
### Phase 1: Planning (Steps 0-3)
- Load workflow creation guide and conventions
- Define workflow purpose, name, and type (informed by brainstorming if used)
- Gather metadata and configuration details
- Design step structure and flow
### Phase 2: Generation (Steps 4-8)
- Create workflow.yaml with proper configuration
- Generate instructions.md with XML-structured steps
- Create template.md (for document workflows)
- Generate validation checklist
- Create supporting data files (optional)
### Phase 3: Documentation and Validation (Steps 9-11)
- Create comprehensive README.md (MANDATORY)
- Test and validate workflow structure
- Provide usage instructions and next steps
## Output
### Generated Workflow Folder
Creates a complete workflow folder at:
`{project-root}/bmad/{{target_module}}/workflows/{{workflow_name}}/`
### Files Created
**Always Created:**
- `workflow.yaml` - Configuration with paths and variables
- `README.md` - Comprehensive documentation (MANDATORY as of v6)
- `instructions.md` - Execution steps (if not template-only workflow)
**Conditionally Created:**
- `template.md` - Document structure (for document workflows)
- `checklist.md` - Validation criteria (optional but recommended)
- Supporting data files (CSV, JSON, etc. as needed)
### Output Structure
For document workflows, the README documents:
- Workflow purpose and use cases
- Usage examples with actual commands
- Input expectations
- Output structure and location
- Best practices
## Requirements
- Access to workflow creation guide
- BMAD Core v6 project structure
- Module to host the new workflow (bmm, bmb, cis, or custom)
## Best Practices
### Before Starting
1. **Consider Brainstorming**: If you're unsure about the workflow approach, use the optional brainstorming phase
2. Review the workflow creation guide to understand conventions
3. Have a clear understanding of the workflow's purpose (or be ready to explore it creatively)
4. Know which type of workflow you're creating (document, action, etc.) or be open to discovery
5. Identify any data files or references needed
### Creative Workflow Design
The create-workflow now supports a **seamless transition from creative ideation to structured implementation**:
- **"I need a workflow for something..."** → Start with brainstorming to explore possibilities
- **Brainstorm** → Generate multiple approaches and clarify requirements
- **Structured workflow** → Build the actual workflow using insights from brainstorming
- **One seamless session** → Complete the entire process from idea to implementation
### During Execution
1. Follow kebab-case naming conventions
2. Be specific with step goals and instructions
3. Use descriptive variable names (snake_case)
4. Set appropriate limits ("3-5 items maximum")
5. Include examples where helpful
### After Completion
1. Test the newly created workflow
2. Validate against the checklist
3. Ensure README is comprehensive and accurate
4. Test all file paths and variable references
## Troubleshooting
### Issue: Generated workflow won't execute
- **Solution**: Verify all file paths in workflow.yaml use proper variable substitution
- **Check**: Ensure installed_path and project-root are correctly set
### Issue: Variables not replacing in template
- **Solution**: Ensure variable names match exactly between instructions `<template-output>` tags and template `{{variables}}`
- **Check**: Use snake_case consistently
### Issue: README has placeholder text
- **Solution**: This workflow now enforces README generation - ensure Step 10 completed fully
- **Check**: No {WORKFLOW_TITLE} or similar placeholders should remain
## Customization
To modify this workflow:
1. Edit `instructions.md` to adjust the creation process
2. Update templates in `workflow-template/` to change generated files
3. Modify `workflow-creation-guide.md` to update conventions
4. Edit `checklist.md` to change validation criteria
## Version History
- **v6.0.0** - README.md now MANDATORY for all workflows
- Added comprehensive README template
- Enhanced validation for documentation
- Improved Step 10 with detailed README requirements
- **v5.0.0** - Initial BMAD Core v6 compatible version
- Template-based workflow generation
- Convention enforcement
- Validation checklist support
## Support
For issues or questions:
- Review `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
- Check existing workflows in `/bmad/bmm/workflows/` for examples
- Validate against `/bmad/bmb/workflows/create-workflow/checklist.md`
- Consult BMAD Method v6 documentation
---
_Part of the BMad Method v6 - BMB (BMad Builder) Module_

View File

@@ -0,0 +1,197 @@
# Workflow Brainstorming Context
_Context provided to brainstorming workflow when creating a new BMAD workflow_
## Session Focus
You are brainstorming ideas for a **BMAD workflow** - a guided, multi-step process that helps users accomplish complex tasks with structure, consistency, and quality.
## What is a BMAD Workflow?
A workflow is a structured process that provides:
- **Clear Steps**: Sequential operations with defined goals
- **User Guidance**: Prompts, questions, and decisions at each phase
- **Quality Output**: Documents, artifacts, or completed actions
- **Repeatability**: Same process yields consistent results
- **Type**: Document (creates docs), Action (performs tasks), Interactive (guides sessions), Autonomous (runs automated), Meta (orchestrates other workflows)
## Brainstorming Goals
Explore and define:
### 1. Problem and Purpose
- **What task needs structure?** (specific process users struggle with)
- **Why is this hard manually?** (complexity, inconsistency, missing steps)
- **What would ideal process look like?** (steps, checkpoints, outputs)
- **Who needs this?** (target users and their pain points)
### 2. Process Flow
- **How many phases?** (typically 3-10 major steps)
- **What's the sequence?** (logical flow from start to finish)
- **What decisions are needed?** (user choices that affect path)
- **What's optional vs required?** (flexibility points)
- **What checkpoints matter?** (validation, review, approval points)
### 3. Inputs and Outputs
- **What inputs are needed?** (documents, data, user answers)
- **What outputs are generated?** (documents, code, configurations)
- **What format?** (markdown, XML, YAML, actions)
- **What quality criteria?** (how to validate success)
### 4. Workflow Type and Style
- **Document Workflow?** Creates structured documents (PRDs, specs, reports)
- **Action Workflow?** Performs operations (refactoring, deployment, analysis)
- **Interactive Workflow?** Guides creative process (brainstorming, planning)
- **Autonomous Workflow?** Runs without user input (batch processing, generation)
- **Meta Workflow?** Orchestrates other workflows (project setup, module creation)
## Creative Constraints
A great BMAD workflow should be:
- **Focused**: Solves one problem well (not everything)
- **Structured**: Clear phases with defined goals
- **Flexible**: Optional steps, branching paths where appropriate
- **Validated**: Checklist to verify completeness and quality
- **Documented**: README explains when and how to use it
## Workflow Architecture Questions
### Core Structure
1. **Workflow name** (kebab-case, e.g., "product-brief")
2. **Purpose** (one sentence)
3. **Type** (document/action/interactive/autonomous/meta)
4. **Major phases** (3-10 high-level steps)
5. **Output** (what gets created)
### Process Details
1. **Required inputs** (what user must provide)
2. **Optional inputs** (what enhances results)
3. **Decision points** (where user chooses path)
4. **Checkpoints** (where to pause for approval)
5. **Variables** (data passed between steps)
### Quality and Validation
1. **Success criteria** (what defines "done")
2. **Validation checklist** (measurable quality checks)
3. **Common issues** (troubleshooting guidance)
4. **Best practices** (tips for optimal results)
## Workflow Pattern Examples
### Document Generation Workflows
- **Product Brief**: Idea → Vision → Features → Market → Output
- **PRD**: Requirements → User Stories → Acceptance Criteria → Document
- **Architecture**: Requirements → Decisions → Design → Diagrams → ADRs
- **Technical Spec**: Epic → Implementation → Testing → Deployment → Doc
### Action Workflows
- **Code Refactoring**: Analyze → Plan → Refactor → Test → Commit
- **Deployment**: Build → Test → Stage → Validate → Deploy → Monitor
- **Migration**: Assess → Plan → Convert → Validate → Deploy
- **Analysis**: Collect → Process → Analyze → Report → Recommend
### Interactive Workflows
- **Brainstorming**: Setup → Generate → Expand → Evaluate → Prioritize
- **Planning**: Context → Goals → Options → Decisions → Plan
- **Review**: Load → Analyze → Critique → Suggest → Document
### Meta Workflows
- **Project Setup**: Plan → Architecture → Stories → Setup → Initialize
- **Module Creation**: Brainstorm → Brief → Agents → Workflows → Install
- **Sprint Planning**: Backlog → Capacity → Stories → Commit → Kickoff
## Workflow Design Patterns
### Linear Flow
Simple sequence: Step 1 → Step 2 → Step 3 → Done
**Good for:**
- Document generation
- Structured analysis
- Sequential builds
### Branching Flow
Conditional paths: Step 1 → [Decision] → Path A or Path B → Merge → Done
**Good for:**
- Different project types
- Optional deep dives
- Scale-adaptive processes
### Iterative Flow
Refinement loops: Step 1 → Step 2 → [Review] → (Repeat if needed) → Done
**Good for:**
- Creative processes
- Quality refinement
- Approval cycles
### Router Flow
Type selection: [Select Type] → Load appropriate instructions → Execute → Done
**Good for:**
- Multi-mode workflows
- Reusable frameworks
- Flexible tools
## Suggested Brainstorming Techniques
Particularly effective for workflow ideation:
1. **Process Mapping**: Draw current painful process, identify improvements
2. **Step Decomposition**: Break complex task into atomic steps
3. **Checkpoint Thinking**: Where do users need pause/review/decision?
4. **Pain Point Analysis**: What makes current process frustrating?
5. **Success Visualization**: What does perfect execution look like?
## Key Questions to Answer
1. What manual process needs structure and guidance?
2. What makes this process hard or inconsistent today?
3. What are the 3-10 major phases/steps?
4. What document or output gets created?
5. What inputs are required from the user?
6. What decisions or choices affect the flow?
7. What quality criteria define success?
8. Document, Action, Interactive, Autonomous, or Meta workflow?
9. What makes this workflow valuable vs doing it manually?
10. What would make this workflow delightful to use?
## Output Goals
Generate:
- **Workflow name**: Clear, describes the process
- **Purpose statement**: One sentence explaining value
- **Workflow type**: Classification with rationale
- **Phase outline**: 3-10 major steps with goals
- **Input/output description**: What goes in, what comes out
- **Key decisions**: Where user makes choices
- **Success criteria**: How to know it worked
- **Unique value**: Why this workflow beats manual process
- **Use cases**: 3-5 scenarios where this workflow shines
---
_This focused context helps create valuable, structured BMAD workflows_

View File

@@ -0,0 +1,72 @@
# Build Workflow - Validation Checklist
## Workflow Configuration (workflow.yaml)
- [ ] Name follows kebab-case convention
- [ ] Description clearly states workflow purpose
- [ ] All paths use proper variable substitution
- [ ] installed_path points to correct module location
- [ ] template/instructions paths are correct for workflow type
- [ ] Output file pattern is appropriate
- [ ] YAML syntax is valid (no parsing errors)
## Instructions Structure (instructions.md)
- [ ] Critical headers reference workflow engine
- [ ] All steps have sequential numbering
- [ ] Each step has a clear goal attribute
- [ ] Optional steps marked with optional="true"
- [ ] Repeating steps have appropriate repeat attributes
- [ ] All template-output tags have unique variable names
- [ ] Flow control (if any) has valid step references
## Template Structure (if document workflow)
- [ ] All sections have appropriate placeholders
- [ ] Variable names match template-output tags exactly
- [ ] Markdown formatting is valid
- [ ] Date and metadata fields included
- [ ] No unreferenced variables remain
## Content Quality
- [ ] Instructions are specific and actionable
- [ ] Examples provided where helpful
- [ ] Limits set for lists and content length
- [ ] User prompts are clear
- [ ] Step goals accurately describe outcomes
## Validation Checklist (if present)
- [ ] Criteria are measurable and specific
- [ ] Checks grouped logically by category
- [ ] Final validation summary included
- [ ] All critical requirements covered
## File System
- [ ] Workflow folder created in correct module
- [ ] All required files present based on workflow type
- [ ] File permissions allow execution
- [ ] No placeholder text remains (like {TITLE})
## Testing Readiness
- [ ] Workflow can be invoked without errors
- [ ] All required inputs are documented
- [ ] Output location is writable
- [ ] Dependencies (if any) are available
## Documentation
- [ ] README created (if requested)
- [ ] Usage instructions clear
- [ ] Example command provided
- [ ] Special requirements noted
## Final Validation
- [ ] Configuration: No issues
- [ ] Instructions: Complete and clear
- [ ] Template: Variables properly mapped
- [ ] Testing: Ready for test run

View File

@@ -0,0 +1,267 @@
# Build Workflow - Workflow Builder Instructions
<workflow>
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/create-workflow/workflow.yaml</critical>
<critical>You MUST fully understand the workflow creation guide at: {workflow_creation_guide}</critical>
<critical>Study the guide thoroughly to follow ALL conventions for optimal human-AI collaboration</critical>
<step n="-1" goal="Optional brainstorming phase" optional="true">
<ask>Do you want to brainstorm workflow ideas first? [y/n]</ask>
<action if="user_response == 'y' or user_response == 'yes'">
Invoke brainstorming workflow to explore ideas and design concepts:
- Workflow: {project-root}/bmad/cis/workflows/brainstorming/workflow.yaml
- Context data: {installed_path}/brainstorm-context.md
- Purpose: Generate creative workflow ideas, explore different approaches, and clarify requirements
The brainstorming output will inform:
- Workflow purpose and goals
- Workflow type selection
- Step design and structure
- User experience considerations
- Technical requirements
</action>
<action if="user_response == 'n' or user_response == 'no'">
Skip brainstorming and proceed directly to workflow building process.
</action>
</step>
<step n="0" goal="Load and understand workflow conventions">
<action>Load the complete workflow creation guide from: {workflow_creation_guide}</action>
<action>Study all sections thoroughly including:
- Core concepts (tasks vs workflows, workflow types)
- Workflow structure (required/optional files, patterns)
- Writing instructions (step attributes, XML tags, flow control)
- Templates and variables (syntax, naming, sources)
- Validation best practices
- Common pitfalls to avoid
</action>
<action>Load template files from: {workflow_template_path}/</action>
<critical>You must follow ALL conventions from the guide to ensure optimal human-AI collaboration</critical>
</step>
<step n="1" goal="Define workflow purpose and type">
Ask the user:
- What is the workflow name? (kebab-case, e.g., "product-brief")
- What module will it belong to? (e.g., "bmm", "bmb", "cis")
- Store as {{target_module}} for output path determination
- What is the workflow's main purpose?
- What type of workflow is this?
- Document workflow (generates documents like PRDs, specs)
- Action workflow (performs actions like refactoring)
- Interactive workflow (guided sessions)
- Autonomous workflow (runs without user input)
- Meta-workflow (coordinates other workflows)
Based on type, determine which files are needed:
- Document: workflow.yaml + template.md + instructions.md + checklist.md
- Action: workflow.yaml + instructions.md
- Others: Varies based on requirements
<critical>Check {src_impact} variable to determine output location:</critical>
- If {src_impact} = true: Workflow will be saved to {src_output_folder}
- If {src_impact} = false: Workflow will be saved to {default_output_folder}
Store decisions for later use.
</step>
<step n="2" goal="Gather workflow metadata">
Collect essential configuration details:
- Description (clear purpose statement)
- Author name (default to user_name or "BMad")
- Output file naming pattern
- Any required input documents
- Any required tools or dependencies
Create the workflow name in kebab-case and verify it doesn't conflict with existing workflows.
</step>
<step n="3" goal="Design workflow steps">
Work with user to outline the workflow steps:
- How many major steps? (Recommend 5-10 max)
- What is the goal of each step?
- Which steps are optional?
- Which steps need user input?
- Which steps should repeat?
- What variables/outputs does each step produce?
Create a step outline with clear goals and outputs.
</step>
<step n="4" goal="Create workflow.yaml">
Load and use the template at: {template_workflow_yaml}
Replace all placeholders following the workflow creation guide conventions:
- {TITLE} → Proper case workflow name
- {WORKFLOW_CODE} → kebab-case name
- {WORKFLOW_DESCRIPTION} → Clear description
- {module-code} → Target module
- {file.md} → Output filename pattern
Include:
- All metadata from steps 1-2
- Proper paths for installed_path using variable substitution
- Template/instructions/validation paths based on workflow type:
- Document workflow: all files (template, instructions, validation)
- Action workflow: instructions only (template: false)
- Autonomous: set autonomous: true flag
- Required tools if any
- Recommended inputs if any
Follow path conventions from guide:
- Use {project-root} for absolute paths
- Use {installed_path} for workflow components
- Use {config_source} for config references
<critical>Determine save location based on {src_impact}:</critical>
- If {src_impact} = true: Write to {src_output_folder}/workflow.yaml
- If {src_impact} = false: Write to {default_output_folder}/workflow.yaml
</step>
<step n="5" goal="Create instructions.md" if="workflow_type != 'template-only'">
Load and use the template at: {template_instructions}
Generate the instructions.md file following the workflow creation guide:
1. ALWAYS include critical headers:
- Workflow engine reference: {project_root}/bmad/core/tasks/workflow.md
- workflow.yaml reference: must be loaded and processed
2. Structure with <workflow> tags containing all steps
3. For each step from design phase, follow guide conventions:
- Step attributes: n="X" goal="clear goal statement"
- Optional steps: optional="true"
- Repeating: repeat="3" or repeat="for-each-X" or repeat="until-approved"
- Conditional: if="condition"
- Sub-steps: Use 3a, 3b notation
4. Use proper XML tags from guide:
- Execution: <action>, <check>, <ask>, <goto>, <invoke-workflow>
- Output: <template-output>, <elicit-required/>, <critical>, <example>
- Flow: <loop>, <break>, <continue>
5. Best practices from guide:
- Keep steps focused (single goal)
- Be specific ("Write 1-2 paragraphs" not "Write about")
- Provide examples where helpful
- Set limits ("3-5 items maximum")
- Save checkpoints with <template-output>
<critical>Determine save location based on {src_impact}:</critical>
- If {src_impact} = true: Write to {src_output_folder}/instructions.md
- If {src_impact} = false: Write to {default_output_folder}/instructions.md
</step>
<step n="6" goal="Create template.md" if="workflow_type == 'document'">
Load and use the template at: {template_template}
Generate the template.md file following guide conventions:
1. Document structure with clear sections
2. Variable syntax: {{variable_name}} using snake_case
3. Variable names MUST match <template-output> tags exactly from instructions
4. Include standard metadata:
- **Date:** {{date}}
- **Author:** {{user_name}} (if applicable)
5. Follow naming conventions from guide:
- Use descriptive names: {{primary_user_journey}} not {{puj}}
- Snake_case for all variables
- Match instruction outputs precisely
Variable sources as per guide:
- workflow.yaml config values
- User input runtime values
- Step outputs via <template-output>
- System variables (date, paths)
<critical>Determine save location based on {src_impact}:</critical>
- If {src_impact} = true: Write to {src_output_folder}/template.md
- If {src_impact} = false: Write to {default_output_folder}/template.md
</step>
<step n="7" goal="Create validation checklist" optional="true">
Ask if user wants a validation checklist. If yes:
Load and use the template at: {template_checklist}
Create checklist.md following guide best practices:
1. Make criteria MEASURABLE and SPECIFIC
❌ "- [ ] Good documentation"
✅ "- [ ] Each function has JSDoc comments with parameters and return types"
2. Group checks logically:
- Structure: All sections present, no placeholders, proper formatting
- Content Quality: Clear and specific, technically accurate, consistent terminology
- Completeness: Ready for next phase, dependencies documented, action items defined
3. Include workflow-specific validations based on type:
- Document workflows: Template variables mapped, sections complete
- Action workflows: Actions clearly defined, error handling specified
- Interactive: User prompts clear, decision points documented
4. Add final validation section with issue lists
<critical>Determine save location based on {src_impact}:</critical>
- If {src_impact} = true: Write to {src_output_folder}/checklist.md
- If {src_impact} = false: Write to {default_output_folder}/checklist.md
</step>
<step n="8" goal="Create supporting files" optional="true">
Ask if any supporting data files are needed:
- CSV files with data
- Example documents
- Reference materials
If yes, create placeholder files or copy from templates.
</step>
<step n="9" goal="Test and validate workflow">
Review the created workflow:
1. Verify all file paths are correct
2. Check variable names match between files
3. Ensure step numbering is sequential
4. Validate YAML syntax
5. Confirm all placeholders are replaced
Show user a summary of created files and their locations.
Ask if they want to:
- Test run the workflow
- Make any adjustments
- Add additional steps or features
</step>
<step n="10" goal="Document and finalize">
Create a brief README for the workflow folder explaining:
- Purpose and use case
- How to invoke: `workflow {workflow_name}`
- Expected inputs
- Generated outputs
- Any special requirements
Provide user with:
- Location of created workflow:
- If {src_impact} = true: {{src_output_folder}}
- If {src_impact} = false: {{default_output_folder}}
- Command to run it
- Next steps for testing
</step>
</workflow>

View File

@@ -0,0 +1,456 @@
# BMAD Workflow Creation Guide
Create structured, repeatable workflows for human-AI collaboration in BMAD v6.
## Table of Contents
1. [Quick Start](#quick-start)
2. [Core Concepts](#core-concepts)
3. [Workflow Structure](#workflow-structure)
4. [Writing Instructions](#writing-instructions)
5. [Templates and Variables](#templates--variables)
6. [Flow Control](#flow-control)
7. [Validation](#validation)
8. [Examples](#examples)
9. [Best Practices](#best-practices)
10. [Troubleshooting](#troubleshooting)
## Quick Start
### Minimal Workflow (3 minutes)
Create a folder with these files:
```yaml
# workflow.yaml (REQUIRED)
name: 'my-workflow'
description: 'What this workflow does'
installed_path: '{project-root}/bmad/module/workflows/my-workflow'
template: '{installed_path}/template.md'
instructions: '{installed_path}/instructions.md'
default_output_file: '{output_folder}/output.md'
```
```markdown
# template.md
# {{project_name}} Output
{{main_content}}
```
```markdown
# instructions.md
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
<critical>You MUST have already loaded and processed: workflow.yaml</critical>
<workflow>
<step n="1" goal="Generate content">
Create the main content for this document.
<template-output>main_content</template-output>
</step>
</workflow>
```
That's it! To execute, tell the BMAD agent: `workflow my-workflow`
## Core Concepts
### Tasks vs Workflows
| Aspect | Task | Workflow |
| -------------- | ------------------ | ----------------------- |
| **Purpose** | Single operation | Multi-step process |
| **Format** | XML in `.md` file | Folder with YAML config |
| **Location** | `/src/core/tasks/` | `/bmad/*/workflows/` |
| **User Input** | Minimal | Extensive |
| **Output** | Variable | Usually documents |
### Workflow Types
1. **Document Workflows** - Generate PRDs, specs, architectures
2. **Action Workflows** - Refactor code, run tools, orchestrate tasks
3. **Interactive Workflows** - Brainstorming, meditations, guided sessions
4. **Autonomous Workflows** - Run without human input (story generation)
5. **Meta-Workflows** - Coordinate other workflows
## Workflow Structure
### Required Files
```
my-workflow/
└── workflow.yaml # REQUIRED - Configuration
```
### Optional Files
```
my-workflow/
├── template.md # Document structure
├── instructions.md # Step-by-step guide
├── checklist.md # Validation criteria
└── [data files] # Supporting resources
```
### workflow.yaml Configuration
```yaml
# Basic metadata
name: 'workflow-name'
description: 'Clear purpose statement'
# Paths
installed_path: '{project-root}/bmad/module/workflows/name'
template: '{installed_path}/template.md' # or false
instructions: '{installed_path}/instructions.md' # or false
validation: '{installed_path}/checklist.md' # optional
# Output
default_output_file: '{output_folder}/document.md'
# Advanced options
autonomous: true # Skip user checkpoints
recommended_inputs: # Expected input docs
- input_doc: 'path/to/doc.md'
```
### Common Patterns
**Full Document Workflow** (most common)
- Has: All 4 files
- Use for: PRDs, architectures, specs
**Action Workflow** (no template)
- Has: workflow.yaml + instructions.md
- Use for: Refactoring, tool orchestration
**Autonomous Workflow** (no interaction)
- Has: workflow.yaml + template + instructions
- Use for: Automated generation
## Writing Instructions
### Basic Structure
```markdown
# instructions.md
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
<critical>You MUST have already loaded and processed: workflow.yaml</critical>
<workflow>
<step n="1" goal="Clear goal statement">
Instructions for this step.
<template-output>variable_name</template-output>
</step>
<step n="2" goal="Next goal" optional="true">
Optional step instructions.
<template-output>another_variable</template-output>
</step>
</workflow>
```
### Step Attributes
- `n="X"` - Step number (required)
- `goal="..."` - What the step accomplishes (required)
- `optional="true"` - User can skip
- `repeat="3"` - Repeat N times
- `if="condition"` - Conditional execution
### Content Formats
**Markdown Format** (human-friendly):
```xml
<step n="1" goal="Define goals">
Write 1-3 bullet points about project success:
- User outcomes
- Business value
- Measurable results
<template-output>goals</template-output>
</step>
```
**XML Format** (precise control):
```xml
<step n="2" goal="Validate input">
<action>Load validation criteria</action>
<check>If validation fails:</check>
<goto step="1">Return to previous step</goto>
<template-output>validated_data</template-output>
</step>
```
## Templates and Variables
### Variable Syntax
```markdown
# template.md
# {{project_name}} Document
## Section
{{section_content}}
_Generated on {{date}}_
```
### Variable Sources
1. **workflow.yaml** - Config values
2. **User input** - Runtime values
3. **Step outputs** - `<template-output>` tags
4. **System** - Date, paths, etc.
### Naming Convention
- Use snake_case: `{{user_requirements}}`
- Be descriptive: `{{primary_user_journey}}` not `{{puj}}`
## Flow Control
### Sub-Steps
```xml
<step n="3" goal="Process items">
<step n="3a" title="Gather data">
<action>Collect information</action>
</step>
<step n="3b" title="Analyze">
<action>Process collected data</action>
<template-output>analysis</template-output>
</step>
</step>
```
### Repetition
```xml
<!-- Fixed repetitions -->
<step n="4" repeat="3">
<action>Generate example {{iteration}}</action>
</step>
<!-- Conditional repetition -->
<step n="5" repeat="until-approved">
<action>Generate content</action>
<ask>Satisfactory? (y/n)</ask>
</step>
<!-- For-each repetition -->
<step n="6" repeat="for-each-epic">
<action>Define epic {{epic_name}}</action>
</step>
```
### Branching and Goto
```xml
<step n="7" goal="Validate">
<action>Check requirements</action>
<check>If incomplete:</check>
<goto step="2">Return to gathering</goto>
<check>If complete:</check>
<continue>Proceed</continue>
</step>
```
### Loops
```xml
<step n="8" goal="Refine">
<loop max="5">
<action>Generate solution</action>
<check>If criteria met:</check>
<break>Exit loop</break>
</loop>
</step>
```
### Common XML Tags
**Execution:**
- `<action>` - Required action
- `<check>` - Conditional check
- `<ask>` - User prompt
- `<goto>` - Jump to step
- `<invoke-workflow>` - Call another workflow
**Output:**
- `<template-output>` - Save checkpoint
- `<elicit-required/>` - Trigger AI enhancement
- `<critical>` - Important info
- `<example>` - Show example
## Validation
### checklist.md Structure
```markdown
# Validation Checklist
## Structure
- [ ] All sections present
- [ ] No placeholders remain
- [ ] Proper formatting
## Content Quality
- [ ] Clear and specific
- [ ] Technically accurate
- [ ] Consistent terminology
## Completeness
- [ ] Ready for next phase
- [ ] Dependencies documented
- [ ] Action items defined
```
### Making Criteria Measurable
`- [ ] Good documentation`
`- [ ] Each function has JSDoc comments with parameters and return types`
## Examples
### Document Generation
```xml
<workflow>
<step n="1" goal="Gather context">
Load existing documents and understand project scope.
<template-output>context</template-output>
</step>
<step n="2" goal="Define requirements">
Create functional and non-functional requirements.
<template-output>requirements</template-output>
<elicit-required/>
</step>
<step n="3" goal="Validate">
Check requirements against goals.
<template-output>validated_requirements</template-output>
</step>
</workflow>
```
### Action Workflow
```xml
<workflow>
<step n="1" goal="Analyze codebase">
<action>Find all API endpoints</action>
<action>Identify patterns</action>
</step>
<step n="2" goal="Refactor">
<repeat for-each="endpoint">
<action>Update to new pattern</action>
</repeat>
</step>
<step n="3" goal="Verify">
<action>Run tests</action>
<check>If tests fail:</check>
<goto step="2">Fix issues</goto>
</step>
</workflow>
```
### Meta-Workflow
```xml
<workflow name="greenfield-app">
<step n="1" goal="Discovery">
<invoke-workflow>product-brief</invoke-workflow>
<template-output>brief</template-output>
</step>
<step n="2" goal="Requirements">
<invoke-workflow input="{{brief}}">prd</invoke-workflow>
<template-output>prd</template-output>
</step>
<step n="3" goal="Architecture">
<invoke-workflow input="{{prd}}">architecture</invoke-workflow>
<template-output>architecture</template-output>
</step>
</workflow>
```
## Best Practices
### Design Principles
1. **Keep steps focused** - Single goal per step
2. **Limit scope** - 5-10 steps maximum
3. **Build progressively** - Start simple, add detail
4. **Checkpoint often** - Save after major sections
5. **Make sections optional** - Let users skip when appropriate
### Instruction Guidelines
1. **Be specific** - "Write 1-2 paragraphs" not "Write about"
2. **Provide examples** - Show expected output format
3. **Set limits** - "3-5 items maximum"
4. **Explain why** - Context helps AI make better decisions
### Common Pitfalls
- **Missing critical headers** - Always include workflow engine references
- **Variables not replaced** - Ensure names match exactly
- **Too many steps** - Combine related actions
- **No checkpoints** - Add `<template-output>` tags
- **Vague instructions** - Be explicit about expectations
## Troubleshooting
### Variables Not Replaced
- Check exact name match
- Verify `<template-output>` tag present
- Ensure step generates the variable
### Validation Fails
- Review checklist specificity
- Check for impossible requirements
- Verify checklist matches template
### Workflow Too Long
- Combine related steps
- Make sections optional
- Reduce elicitation points
### User Confusion
- Add clearer step goals
- Provide more examples
- Explain section purpose
---
_For implementation details, see:_
- `/src/core/tasks/workflow.md` - Execution engine
- `/bmad/bmm/workflows/` - Production examples

View File

@@ -0,0 +1,24 @@
# {Title} Checklist Validation
## {Section Foo}
- [ ] Check 1
- [ ] Check 2
- [ ] ...
- [ ] Check n
...
## {Section Bar}
- [ ] Check 1
- [ ] Check 2
- [ ] ...
- [ ] Check n
## Final Validation
- [ ] Section Foo
- Issue List
- [ ] Section Bar
- Issue List

View File

@@ -0,0 +1,12 @@
# PRD Workflow Instructions
<workflow>
<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
<critical>You MUST have already loaded and processed: {project_root}/bmad/{module-code}/workflows/{workflow}/workflow.yaml</critical>
<step n="1" goal="">
...
</step>
...
</workflow>

View File

@@ -0,0 +1,9 @@
# Title
**Date:** {{date}}
## {Section 1}
{{section_1_results}}
etc...

View File

@@ -0,0 +1,35 @@
# {TITLE} Workflow Template Configuration
name: "{WORKFLOW_CODE}"
description: "{WORKFLOW_DESCRIPTION}"
author: "BMad"
# Critical variables load from config_source
# Add Additional Config Pulled Variables Here
config_source: "{project-root}/{module-code}/config.yaml"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
date: system-generated
# Required Data Files - HALT if missing!
# optional, can be omitted
brain_techniques: "{installed_path}/{critical-data-file.csv}" # example, can be other formats or URLs
# Optional docs that if loaded on start to kickstart this workflow or used at some point, these are meant to be suggested inputs for the user
recommended_inputs: # optional, can be omitted
- example_input: "{project-root}/{path/to/file.md}"
# Module path and component files
installed_path: "{project-root}/bmad/{module-code}/workflows/{workflow-code}"
template: "{installed_path}/template.md" # optional, can be omitted
instructions: "{installed_path}/instructions.md" # optional, can be omitted
validation: "{installed_path}/checklist.md" # optional, can be omitted
# Output configuration
default_output_file: "{output_folder}/{file.md}" # optional, can be omitted
validation_output_file: "{output_folder}/{file-validation-report.md}" # optional, can be omitted
# Tool Requirements (MCP Required Tools or other tools needed to run this workflow)
required_tools: #optional, can be omitted
- "Tool Name": #example, can be omitted if none
description: "Description of why this tool is needed"
link: "https://link-to-tool.com"

View File

@@ -0,0 +1,39 @@
# Build Workflow - Workflow Builder Configuration
name: create-workflow
description: "Interactive workflow builder that guides creation of new BMAD workflows with proper structure and validation for optimal human-AI collaboration. Includes optional brainstorming phase for workflow ideas and design."
author: "BMad Builder"
# Critical variables
config_source: "{project-root}/bmad/bmb/config.yaml"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
src_impact: "{config_source}:src_impact"
communication_language: "{config_source}:communication_language"
date: system-generated
# Template files for new workflows
template_workflow_yaml: "{workflow_template_path}/workflow.yaml"
template_instructions: "{workflow_template_path}/instructions.md"
template_template: "{workflow_template_path}/template.md"
template_checklist: "{workflow_template_path}/checklist.md"
# Optional input docs
recommended_inputs:
- existing_workflows: "{project-root}/bmad/*/workflows/"
- bmm_workflows: "{project-root}/bmad/bmm/workflows/"
# Module path and component files
installed_path: "{project-root}/bmad/bmb/workflows/create-workflow"
template: false # This is an action workflow - no template needed
instructions: "{installed_path}/instructions.md"
validation: "{installed_path}/checklist.md"
# Required data files - CRITICAL for workflow conventions
workflow_creation_guide: "{installed_path}/workflow-creation-guide.md"
workflow_template_path: "{installed_path}/workflow-template"
# Output configuration - Creates the new workflow folder with all files
# If src_impact=true: Save to src/modules/{{target_module}}/workflows/{{workflow_name}}
# If src_impact=false: Save to output_folder/workflows/{{workflow_name}}
default_output_folder: "{output_folder}/workflows/{{workflow_name}}"
src_output_folder: "{project-root}/src/modules/{{target_module}}/workflows/{{workflow_name}}"