bmad-method 5.1.3 → 6.0.0-alpha.0

package/src/modules/bmb/workflows/create-workflow/brainstorm-context.md

@@ -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 & 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 & 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 & 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 & 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_

package/src/modules/bmb/workflows/create-workflow/checklist.md

@@ -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

package/src/modules/bmb/workflows/create-workflow/instructions.md

@@ -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/build-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>