mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
feat: implement granular step-file workflow architecture with multi-menu support
## Major Features Added - **Step-file workflow architecture**: Transform monolithic workflows into granular step files for improved LLM adherence and consistency - **Multi-menu handler system**: New `handler-multi.xml` enables grouped menu items with fuzzy matching - **Workflow compliance checker**: Added automated compliance validation for all workflows - **Create/edit agent workflows**: New structured workflows for agent creation and editing ## Workflow Enhancements - **Create-workflow**: Expanded from 6 to 14 detailed steps covering tools, design, compliance - **Granular step execution**: Each workflow step now has dedicated files for focused execution - **New documentation**: Added CSV data standards, intent vs prescriptive spectrum, and common tools reference ## Complete Migration Status - **4 workflows fully migrated**: `create-agent`, `edit-agent`, `create-workflow`, and `edit-workflow` now use the new granular step-file architecture - **Legacy transformation**: `edit-workflow` includes built-in capability to transform legacy single-file workflows into the new improved granular format - **Future cleanup**: Legacy versions will be removed in a future commit after validation ## Schema Updates - **Multi-menu support**: Updated agent schema to support `triggers` array for grouped menu items - **Legacy compatibility**: Maintains backward compatibility with single `trigger` field - **Discussion enhancements**: Added conversational_knowledge recommendation for discussion agents ## File Structure Changes - Added: `create-agent/`, `edit-agent/`, `edit-workflow/`, `workflow-compliance-check/` workflows - Added: Documentation standards and CSV reference files - Refactored: `create-workflow/steps/` with detailed granular step files ## Handler Improvements - Enhanced `handler-exec.xml` with clearer execution instructions - Improved data passing context for executed files - Better error handling and user guidance This architectural change significantly improves workflow execution consistency across all LLM models by breaking complex processes into manageable, focused steps. The edit-workflow transformation tool ensures smooth migration of existing workflows to the new format.
This commit is contained in:
Brian Madison
@@ -7,7 +7,7 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-02-gather.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-03-design.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-03-tools-overview.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
# Output files for workflow creation process
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
@@ -0,0 +1,128 @@
|
||||
---
|
||||
name: 'step-03-tools-overview'
|
||||
description: 'Present available tools from CSV and gather initial user requirements'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-tools-overview.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-core-tools.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
# Documentation References
|
||||
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
|
||||
---
|
||||
|
||||
# Step 3: Tools Overview
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Load and present available tools from the CSV, then gather the user's general tool requirements for their workflow.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and integration specialist
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in BMAD tools and workflow optimization
|
||||
- ✅ User brings their workflow requirements
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load CSV and present tools dynamically
|
||||
- 💾 Gather user's general tool requirements
|
||||
- 📖 Document requirements in workflow plan
|
||||
- 🚫 FORBIDDEN to proceed without user input
|
||||
|
||||
## SEQUENCE OF INSTRUCTIONS:
|
||||
|
||||
### 1. Initialize Tools Discussion
|
||||
|
||||
"Beginning **Tools Integration and Configuration**
|
||||
|
||||
Based on your workflow requirements, I'll help identify the best tools and integrations. Let me first load the available tools from our reference."
|
||||
|
||||
### 2. Load and Present Available Tools
|
||||
|
||||
Load `{commonToolsCsv}` and present tools organized by type:
|
||||
|
||||
"**Available BMAD Tools and Integrations:**
|
||||
|
||||
**Always Available (Recommended for Most Workflows):**
|
||||
|
||||
- [List tools from CSV where propose='always', organized by type]
|
||||
|
||||
**Example Tools (Available When Needed):**
|
||||
|
||||
- [List tools from CSV where propose='example', organized by type]
|
||||
|
||||
\*\*Tools requiring installation will be noted."
|
||||
|
||||
### 3. Gather Initial Requirements
|
||||
|
||||
"**Your Tool Requirements:**
|
||||
|
||||
Based on your workflow type and goals, what tools do you anticipate needing?
|
||||
|
||||
1. **Core BMAD Tools:** Do you want collaborative idea generation, critical evaluation, or brainstorming capabilities?
|
||||
2. **LLM Features:** Will you need web access, file management, sub-agents, or parallel processing?
|
||||
3. **Memory:** Does your workflow need persistent state across sessions?
|
||||
4. **External Tools:** Will you need MCP integrations like documentation access, browser automation, or database connections?
|
||||
|
||||
**Initial Tool Preferences:** [gather user's general requirements]"
|
||||
|
||||
### 4. Document Requirements
|
||||
|
||||
Append to {workflowPlanFile}:
|
||||
|
||||
```markdown
|
||||
## Tool Requirements Summary
|
||||
|
||||
**Initial Tool Preferences:**
|
||||
|
||||
- Core BMAD Tools: [user selections]
|
||||
- LLM Features: [user selections]
|
||||
- Memory Requirements: [user selections]
|
||||
- External Tools: [user selections]
|
||||
**Installation Willingness:** [user comfort level with installing tools]
|
||||
```
|
||||
|
||||
### 5. Menu Options
|
||||
|
||||
Display: **Select an Option:** [C] Continue to Core Tools [M] Modify Requirements [X] Exit
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save requirements and load {nextStepFile}
|
||||
- IF M: Refine requirements discussion
|
||||
- IF X: Save current state and end session
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and requirements are documented will you load {nextStepFile} to configure core tools.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- CSV loaded and tools presented clearly
|
||||
- User's initial tool requirements gathered
|
||||
- Requirements documented in workflow plan
|
||||
- User ready to proceed to detailed configuration
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not loading tools from CSV
|
||||
- Duplicating CSV content in step file
|
||||
- Proceeding without user requirements input
|
||||
@@ -0,0 +1,146 @@
|
||||
---
|
||||
name: 'step-04-core-tools'
|
||||
description: 'Configure always-available core tools and their integration points'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-core-tools.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-05-memory-requirements.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
# Documentation References
|
||||
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
|
||||
---
|
||||
|
||||
# Step 4: Core Tools Configuration
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Configure always-available core tools (party-mode, advanced-elicitation, brainstorming, and LLM features) with specific integration points in the workflow.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and integration specialist
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in BMAD tools and integration patterns
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load core tools from CSV and configure integration points
|
||||
- 💾 Confirm user choices for each core tool
|
||||
- 📖 Document configuration in workflow plan
|
||||
- 🚫 FORBIDDEN to proceed without user confirmation
|
||||
|
||||
## SEQUENCE OF INSTRUCTIONS:
|
||||
|
||||
### 1. Initialize Core Tools Configuration
|
||||
|
||||
"Configuring **Core BMAD Tools and Features**
|
||||
|
||||
These core tools significantly enhance workflow quality. Let's configure each one for optimal integration into your workflow."
|
||||
|
||||
### 2. Present Core Tools from CSV
|
||||
|
||||
Load `{commonToolsCsv}` and filter for `propose='always'`:
|
||||
|
||||
"**Core Tools (Always Available):**
|
||||
|
||||
**Workflows & Tasks:**
|
||||
|
||||
- **Party-Mode:** [description from CSV]
|
||||
- **Advanced Elicitation:** [description from CSV]
|
||||
- **Brainstorming:** [description from CSV]
|
||||
|
||||
**LLM Tool Features:**
|
||||
|
||||
- **Web-Browsing:** [description from CSV]
|
||||
- **File I/O:** [description from CSV]
|
||||
- **Sub-Agents:** [description from CSV]
|
||||
- **Sub-Processes:** [description from CSV]
|
||||
|
||||
**Tool-Memory:**
|
||||
|
||||
- **Sidecar File:** [description from CSV]"
|
||||
|
||||
### 3. Configure Integration Points
|
||||
|
||||
For each tool, ask about integration:
|
||||
|
||||
"**Core Tools Integration:**
|
||||
|
||||
**Workflows & Tasks:**
|
||||
|
||||
1. **Party-Mode** - Where should collaborative AI sessions be offered? [decision points, creative phases]
|
||||
2. **Advanced Elicitation** - Where should critical evaluation checkpoints be placed? [after content creation, quality gates]
|
||||
3. **Brainstorming** - Where should creative ideation be integrated? [idea generation phases, innovation points]
|
||||
|
||||
**LLM Features:** 4. **Web-Browsing** - When is current information needed? [real-time data, current events] 5. **File I/O** - What document operations are required? [file creation, data management] 6. **Sub-Agents** - Where would specialized delegation help? [complex tasks, parallel processing] 7. **Sub-Processes** - Where would parallel processing improve performance? [long operations, resource optimization]
|
||||
|
||||
**Tool-Memory:** 8. **Sidecar File** - Does your workflow need persistent state? [session continuity, agent initialization]"
|
||||
|
||||
### 4. Document Core Tools Configuration
|
||||
|
||||
Append to {workflowPlanFile}:
|
||||
|
||||
```markdown
|
||||
## Core Tools Configuration
|
||||
|
||||
### Workflows & Tasks
|
||||
|
||||
**Party-Mode:** [included/excluded] - Integration points: [specific phases]
|
||||
**Advanced Elicitation:** [included/excluded] - Integration points: [specific phases]
|
||||
**Brainstorming:** [included/excluded] - Integration points: [specific phases]
|
||||
|
||||
### LLM Tool Features
|
||||
|
||||
**Web-Browsing:** [included/excluded] - Integration points: [specific phases]
|
||||
**File I/O:** [included/excluded] - Integration points: [specific phases]
|
||||
**Sub-Agents:** [included/excluded] - Integration points: [specific phases]
|
||||
**Sub-Processes:** [included/excluded] - Integration points: [specific phases]
|
||||
|
||||
### Tool-Memory
|
||||
|
||||
**Sidecar File:** [included/excluded] - Use case: [history tracking, agent initialization]
|
||||
```
|
||||
|
||||
### 5. Menu Options
|
||||
|
||||
Display: **Select an Option:** [C] Continue to Memory Configuration [M] Modify Core Tools [X] Exit
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save configuration and load {nextStepFile}
|
||||
- IF M: Return to tool configuration
|
||||
- IF X: Save current state and end session
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and core tools are documented will you load {nextStepFile} to configure memory requirements.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Core tools presented using CSV descriptions
|
||||
- Integration points configured for each selected tool
|
||||
- Configuration documented in workflow plan
|
||||
- User understands how tools enhance workflow
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Duplicating CSV content instead of referencing it
|
||||
- Not confirming integration points with user
|
||||
- Proceeding without user confirmation of configuration
|
||||
@@ -0,0 +1,137 @@
|
||||
---
|
||||
name: 'step-05-memory-requirements'
|
||||
description: 'Assess memory requirements and configure memory implementation'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-05-memory-requirements.md'
|
||||
nextStepFile: '{project_path}/steps/step-06-external-tools.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
# Documentation References
|
||||
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
|
||||
---
|
||||
|
||||
# Step 5: Memory Requirements Assessment
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Assess whether the workflow needs memory capabilities and configure appropriate memory implementation.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and integration specialist
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in memory implementation patterns
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Assess memory needs based on workflow requirements
|
||||
- 💾 Present memory options from CSV
|
||||
- 📖 Configure memory implementation if needed
|
||||
- 🚫 FORBIDDEN to push memory when not required
|
||||
|
||||
## SEQUENCE OF INSTRUCTIONS:
|
||||
|
||||
### 1. Initialize Memory Assessment
|
||||
|
||||
"Assessing **Memory Requirements**
|
||||
|
||||
Most workflows complete their task and exit without needing persistent memory. However, some specialized workflows benefit from session-to-session continuity."
|
||||
|
||||
### 2. Present Memory Options from CSV
|
||||
|
||||
Load `{commonToolsCsv}` and filter for `type='tool-memory'`:
|
||||
|
||||
"**Memory Options:**
|
||||
|
||||
**Available Memory Types:**
|
||||
|
||||
- [List tool-memory options from CSV with descriptions]
|
||||
|
||||
**Key Question:** Does your workflow need to maintain state across multiple sessions?"
|
||||
|
||||
### 3. Memory Requirements Analysis
|
||||
|
||||
"**Memory Assessment Questions:**
|
||||
|
||||
1. **Session Continuity:** Will your workflow need to resume where it left off?
|
||||
2. **Agent Initialization:** Will your workflow initialize agents with previous context?
|
||||
3. **Pattern Recognition:** Would semantic search of past experiences be valuable?
|
||||
4. **Self-Improvement:** Will your workflow learn from previous executions?
|
||||
|
||||
**Most workflows:** No memory needed (they complete and exit)
|
||||
**Some workflows:** Sidecar files for history tracking
|
||||
**Advanced workflows:** Vector database for semantic learning"
|
||||
|
||||
### 4. Configure Memory (If Needed)
|
||||
|
||||
If user selects memory:
|
||||
|
||||
"**Memory Configuration:**
|
||||
|
||||
Based on your needs, which memory type?
|
||||
|
||||
1. **Sidecar File** - History tracking and session continuity
|
||||
2. **Vector Database** - Semantic search and pattern recognition
|
||||
3. **Both** - Comprehensive memory capabilities
|
||||
4. **None** - No persistent memory required
|
||||
|
||||
**Memory Management:** Privacy controls, cleanup strategies, access patterns"
|
||||
|
||||
### 5. Document Memory Configuration
|
||||
|
||||
Append to {workflowPlanFile}:
|
||||
|
||||
```markdown
|
||||
## Memory Configuration
|
||||
|
||||
### Memory Requirements
|
||||
|
||||
**Sidecar File:** [selected/not selected] - Use case: [specific implementation]
|
||||
**Vector Database:** [selected/not selected] - Use case: [specific implementation]
|
||||
**Memory Management:** [cleanup, privacy, access patterns]
|
||||
**Integration:** [how memory enhances workflow continuity]
|
||||
```
|
||||
|
||||
### 6. Menu Options
|
||||
|
||||
Display: **Select an Option:** [C] Continue to External Tools [M] Modify Memory [X] Exit
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save memory configuration and load {nextStepFile}
|
||||
- IF M: Refine memory requirements
|
||||
- IF X: Save current state and end session
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and memory is documented will you load {nextStepFile} to configure external tools.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Memory options presented from CSV
|
||||
- User's memory needs properly assessed
|
||||
- Configuration documented appropriately
|
||||
- No memory pushed when not needed
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Assuming memory is needed without assessment
|
||||
- Duplicating CSV descriptions in step file
|
||||
- Not documenting memory management strategies
|
||||
@@ -0,0 +1,155 @@
|
||||
---
|
||||
name: 'step-06-external-tools'
|
||||
description: 'Configure MCP integrations and installation requirements'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-06-external-tools.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-07-installation-guidance.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
# Documentation References
|
||||
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
|
||||
---
|
||||
|
||||
# Step 6: External Tools Configuration
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Identify and configure MCP integrations and external tools that the workflow requires.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and integration specialist
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in MCP integrations and external tools
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Load external tools from CSV
|
||||
- 💾 Identify specific MCP needs for workflow
|
||||
- 📖 Document which tools require installation
|
||||
- 🚫 FORBIDDEN to proceed without confirming tool selections
|
||||
|
||||
## SEQUENCE OF INSTRUCTIONS:
|
||||
|
||||
### 1. Initialize External Tools Assessment
|
||||
|
||||
"Configuring **External Tools and MCP Integrations**
|
||||
|
||||
These tools extend workflow capabilities but typically require installation. Let's identify what your workflow actually needs."
|
||||
|
||||
### 2. Present External Tools from CSV
|
||||
|
||||
Load `{commonToolsCsv}` and filter for `propose='example'` and `type='mcp'`:
|
||||
|
||||
"**Available External Tools:**
|
||||
|
||||
**MCP Integrations (Require Installation):**
|
||||
|
||||
- [List MCP tools from CSV with URLs and descriptions]
|
||||
|
||||
**Example Workflows/Tasks:**
|
||||
|
||||
- [List example workflows/tasks from CSV with descriptions]
|
||||
|
||||
**Installation Note:** Tools marked with `requires_install=yes` will need setup steps."
|
||||
|
||||
### 3. Identify Specific Tool Needs
|
||||
|
||||
"**External Tool Requirements:**
|
||||
|
||||
Based on your workflow goals, which external tools do you need?
|
||||
|
||||
**Common MCP Needs:**
|
||||
|
||||
- **Documentation Access:** Context-7 for current API docs
|
||||
- **Browser Automation:** Playwright for web interactions
|
||||
- **Git Operations:** Direct version control integration
|
||||
- **Database Access:** Multiple database connectivity
|
||||
- **Custom Tools:** Any domain-specific MCPs you need
|
||||
|
||||
**Your Requirements:**
|
||||
|
||||
1. What external data or APIs will your workflow access?
|
||||
2. Does your workflow need web browser automation?
|
||||
3. Will it interact with version control systems?
|
||||
4. Are database connections required?
|
||||
5. Any custom MCPs you plan to use?"
|
||||
|
||||
### 4. Document External Tools Selection
|
||||
|
||||
Append to {workflowPlanFile}:
|
||||
|
||||
```markdown
|
||||
## External Tools Configuration
|
||||
|
||||
### MCP Integrations
|
||||
|
||||
**Selected Tools:** [list from CSV]
|
||||
**Purpose:** [how each MCP enhances workflow]
|
||||
**Integration Points:** [where external tools are essential]
|
||||
**Installation Required:** [yes/no, which tools]
|
||||
|
||||
### Example Workflows/Tasks
|
||||
|
||||
**Selected:** [list chosen workflows/tasks]
|
||||
**Purpose:** [how they enhance workflow capabilities]
|
||||
**Integration:** [where they fit in workflow flow]
|
||||
```
|
||||
|
||||
### 5. Installation Assessment
|
||||
|
||||
"**Installation Requirements Assessment:**
|
||||
|
||||
**Tools Requiring Installation:** [list from CSV where requires_install=yes]
|
||||
|
||||
**Installation Guidance Options:**
|
||||
|
||||
1. Include detailed setup steps in workflow
|
||||
2. Provide user installation checklist
|
||||
3. Assume tools are pre-installed
|
||||
|
||||
**Your Preference:** [ask user how to handle installation]"
|
||||
|
||||
### 6. Menu Options
|
||||
|
||||
Display: **Select an Option:** [C] Continue to Installation Guidance [M] Modify External Tools [X] Exit
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save selections and load {nextStepFile}
|
||||
- IF M: Refine external tool requirements
|
||||
- IF X: Save current state and end session
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and external tools are documented will you load {nextStepFile} to configure installation guidance.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- External tools presented from CSV with installation requirements
|
||||
- User's specific tool needs identified and documented
|
||||
- Installation requirements clearly marked
|
||||
- User understands which tools need setup
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not filtering CSV for relevant tool types
|
||||
- Missing installation requirement information
|
||||
- Proceeding without confirming tool selections
|
||||
@@ -0,0 +1,160 @@
|
||||
---
|
||||
name: 'step-07-installation-guidance'
|
||||
description: 'Configure installation guidance for tools that require setup'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-07-installation-guidance.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-08-tools-summary.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
# Documentation References
|
||||
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
|
||||
---
|
||||
|
||||
# Step 7: Installation Guidance Configuration
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Configure installation guidance for any selected tools that require setup, ensuring users can successfully prepare their environment.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and integration specialist
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in tool installation and setup procedures
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Identify tools requiring installation from CSV
|
||||
- 💾 Configure installation approach based on user preference
|
||||
- 📖 Generate or skip installation guidance as appropriate
|
||||
- 🚫 FORBIDDEN to proceed without confirming installation approach
|
||||
|
||||
## SEQUENCE OF INSTRUCTIONS:
|
||||
|
||||
### 1. Initialize Installation Guidance
|
||||
|
||||
"Configuring **Installation Guidance**
|
||||
|
||||
Let's ensure users can successfully set up any tools your workflow requires. This prevents runtime errors and improves user experience."
|
||||
|
||||
### 2. Identify Installation Requirements
|
||||
|
||||
Load `{commonToolsCsv}` and filter for selected tools with `requires_install=yes`:
|
||||
|
||||
"**Installation Requirements:**
|
||||
|
||||
**Tools Requiring Installation:**
|
||||
|
||||
- [List selected tools from CSV where requires_install=yes]
|
||||
- [Include URLs from CSV for each tool]
|
||||
|
||||
**No Installation Required:**
|
||||
|
||||
- [List selected tools from CSV where requires_install=no]
|
||||
- All BMAD core tools, LLM features, and sidecar file memory"
|
||||
|
||||
### 3. Installation Approach Options
|
||||
|
||||
"**Installation Guidance Options:**
|
||||
|
||||
Based on your selected tools, how should the workflow handle installation?
|
||||
|
||||
1. **Include Installation Steps** - Add detailed setup instructions in early workflow step
|
||||
2. **User Instructions Only** - Provide guidance but don't embed in workflow
|
||||
3. **Assume Pre-Installed** - Skip installation guidance (advanced users)
|
||||
|
||||
**Installation Prerequisites (if included):**
|
||||
|
||||
- Node.js 18+ (for Node.js-based MCPs)
|
||||
- Python 3.8+ (for Python-based MCPs)
|
||||
- Git for cloning repositories
|
||||
- MCP-compatible AI client (Claude Desktop or similar)"
|
||||
|
||||
### 4. Configure Installation Guidance
|
||||
|
||||
If user chooses installation guidance:
|
||||
|
||||
"**Installation Step Configuration:**
|
||||
|
||||
For each tool requiring installation, the workflow will include:
|
||||
|
||||
- Clone/download instructions using URL from CSV
|
||||
- Dependency installation commands
|
||||
- Configuration file setup
|
||||
- Server startup procedures
|
||||
- Claude Desktop configuration steps
|
||||
|
||||
**Installation Checklist (if included):**
|
||||
|
||||
- [ ] Download and install Claude Desktop
|
||||
- [ ] Clone MCP repositories
|
||||
- [ ] Install required dependencies
|
||||
- [ ] Configure MCP servers
|
||||
- [ ] Add to Claude configuration
|
||||
- [ ] Test connectivity
|
||||
- [ ] Verify functionality"
|
||||
|
||||
### 5. Document Installation Configuration
|
||||
|
||||
Append to {workflowPlanFile}:
|
||||
|
||||
```markdown
|
||||
## Installation Guidance Configuration
|
||||
|
||||
### Installation Approach
|
||||
|
||||
**Selected Approach:** [detailed steps/user instructions/assume pre-installed]
|
||||
**Tools Requiring Installation:** [list with URLs]
|
||||
**Installation Step Placement:** [early in workflow, after setup]
|
||||
|
||||
### Installation Content
|
||||
|
||||
**Prerequisites:** [system requirements]
|
||||
**Setup Steps:** [commands and procedures]
|
||||
**Verification:** [testing procedures]
|
||||
**User Support:** [troubleshooting guidance]
|
||||
```
|
||||
|
||||
### 6. Menu Options
|
||||
|
||||
Display: **Select an Option:** [C] Continue to Tools Summary [M] Modify Installation Approach [X] Exit
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save installation configuration and load {nextStepFile}
|
||||
- IF M: Refine installation approach
|
||||
- IF X: Save current state and end session
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and installation guidance is documented will you load {nextStepFile} to complete tools configuration.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Installation requirements clearly identified from CSV
|
||||
- Installation approach configured based on user preference
|
||||
- Documentation prepared for setup procedures
|
||||
- User understands how tools will be installed
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Missing installation requirement assessment
|
||||
- Not using URLs from CSV for installation guidance
|
||||
- Proceeding without confirming installation approach
|
||||
@@ -0,0 +1,168 @@
|
||||
---
|
||||
name: 'step-08-tools-summary'
|
||||
description: 'Summarize tools configuration and proceed to workflow design'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-08-tools-summary.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-design.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
|
||||
# Documentation References
|
||||
commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
|
||||
---
|
||||
|
||||
# Step 8: Tools Configuration Summary
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Summarize the complete tools configuration and confirm readiness to proceed to workflow design.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and integration specialist
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in tools integration and workflow optimization
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Compile complete tools configuration summary
|
||||
- 💾 Present final configuration for user confirmation
|
||||
- 📖 Update workflow plan with comprehensive summary
|
||||
- 🚫 FORBIDDEN to proceed to design without user confirmation
|
||||
|
||||
## SEQUENCE OF INSTRUCTIONS:
|
||||
|
||||
### 1. Initialize Tools Summary
|
||||
|
||||
"**Tools Configuration Summary**
|
||||
|
||||
Let's review your complete tools configuration before proceeding to workflow design. This ensures all integrations are properly planned."
|
||||
|
||||
### 2. Present Complete Configuration
|
||||
|
||||
Load all previous configurations from {workflowPlanFile} and CSV:
|
||||
|
||||
"**Complete Tools Configuration:**
|
||||
|
||||
**Core BMAD Tools:**
|
||||
|
||||
- [List selected core tools with integration points]
|
||||
- [Load descriptions from CSV for confirmation]
|
||||
|
||||
**LLM Tool Features:**
|
||||
|
||||
- [List selected LLM features with integration points]
|
||||
- [Load descriptions from CSV for confirmation]
|
||||
|
||||
**Tool-Memory:**
|
||||
|
||||
- [Selected memory types with implementation details]
|
||||
- [Load descriptions from CSV for confirmation]
|
||||
|
||||
**External Tools:**
|
||||
|
||||
- [List selected MCP integrations with URLs]
|
||||
- [Load descriptions from CSV for confirmation]
|
||||
- [Mark which require installation]
|
||||
|
||||
**Installation Guidance:**
|
||||
|
||||
- [Approach selected and tools included]
|
||||
- [Setup steps configured as needed]
|
||||
|
||||
**Integration Strategy:**
|
||||
|
||||
- [How tools enhance rather than disrupt workflow]
|
||||
- [Checkpoint approaches and user choice points]
|
||||
- [Performance optimization opportunities]"
|
||||
|
||||
### 3. Final Configuration Confirmation
|
||||
|
||||
"**Final Configuration Review:**
|
||||
|
||||
**Your workflow will include:**
|
||||
|
||||
- **Total Tools:** [count of selected tools]
|
||||
- **Core Tools:** [number selected]
|
||||
- **External Tools:** [number selected]
|
||||
- **Installation Required:** [yes/no, which tools]
|
||||
|
||||
**Key Integration Points:**
|
||||
|
||||
- [Major phases where tools enhance workflow]
|
||||
- [User experience considerations]
|
||||
- [Performance optimizations]
|
||||
|
||||
**Ready to proceed with this configuration?**"
|
||||
|
||||
### 4. Update Workflow Plan with Final Summary
|
||||
|
||||
Append to {workflowPlanFile}:
|
||||
|
||||
```markdown
|
||||
## Final Tools Configuration Summary
|
||||
|
||||
### Tools Inventory
|
||||
|
||||
**Core BMAD Tools:** [count and list]
|
||||
**LLM Features:** [count and list]
|
||||
**Memory Implementation:** [type and use case]
|
||||
**External Tools:** [count and list with URLs]
|
||||
**Installation Required:** [tools and setup complexity]
|
||||
|
||||
### Integration Strategy
|
||||
|
||||
**User Experience:** [how tools enhance workflow]
|
||||
**Checkpoint Approach:** [when tools are offered]
|
||||
**Performance Optimization:** [efficiency improvements]
|
||||
**Installation Strategy:** [how users prepare environment]
|
||||
|
||||
### Ready for Design
|
||||
|
||||
All tools configured and ready for workflow design phase.
|
||||
```
|
||||
|
||||
### 5. Menu Options
|
||||
|
||||
Display: **Select an Option:** [C] Continue to Workflow Design [M] Modify Configuration [X] Exit
|
||||
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF C: Save final summary, update frontmatter stepsCompleted: [3, 4, 5, 6, 7, 8], then load {nextStepFile}
|
||||
- IF M: Return to specific configuration step
|
||||
- IF X: Save current state and end session
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN C is selected and summary is saved will you load {nextStepFile} to begin workflow design phase.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Complete tools configuration summarized clearly
|
||||
- All descriptions loaded from CSV (not duplicated)
|
||||
- User confirms configuration before proceeding
|
||||
- Frontmatter updated with completed steps
|
||||
- Ready to proceed to workflow design
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Not presenting complete configuration summary
|
||||
- Duplicating CSV content instead of referencing it
|
||||
- Proceeding to design without user confirmation
|
||||
- Not updating workflow plan with final summary
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
name: 'step-03-design'
|
||||
description: 'Design the workflow structure and step sequence based on gathered requirements'
|
||||
name: 'step-04-design'
|
||||
description: 'Design the workflow structure and step sequence based on gathered requirements and tools configuration'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-03-design.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-04-build.md'
|
||||
thisStepFile: '{workflow_path}/steps/step-04-design.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-05-review-plan.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
# Output files for workflow creation process
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
name: 'step-04-review-plan'
|
||||
name: 'step-05-review-plan'
|
||||
description: 'Review the complete workflow plan before generating files'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-04-review-plan.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-05-build.md'
|
||||
thisStepFile: '{workflow_path}/steps/step-05-review-plan.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-06-build.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
# Output files for workflow creation process
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
name: 'step-05-build'
|
||||
name: 'step-06-build'
|
||||
description: 'Generate all workflow files based on the approved plan'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-05-build.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-06-review.md'
|
||||
thisStepFile: '{workflow_path}/steps/step-06-build.md'
|
||||
nextStepFile: '{workflow_path}/steps/step-07-review.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
# Output files for workflow creation process
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
@@ -1,16 +1,17 @@
|
||||
---
|
||||
name: 'step-06-review'
|
||||
name: 'step-07-review'
|
||||
description: 'Review the generated workflow and provide final validation and next steps'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-06-review.md'
|
||||
thisStepFile: '{workflow_path}/steps/step-07-review.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
# Output files for workflow creation process
|
||||
workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
|
||||
targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
|
||||
nextStepFile: '{workflow_path}/steps/step-08-compliance-check.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
|
||||
@@ -203,12 +204,12 @@ Then load and append the content from {completionTemplate}
|
||||
|
||||
## FINAL MENU OPTIONS
|
||||
|
||||
Display: **Workflow Creation Complete!** [A] Advanced Elicitation [P] Party Mode [F] Finish
|
||||
Display: **Workflow Review Complete!** [A] Advanced Elicitation [P] Party Mode [C] Continue to Compliance Check
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
- ALWAYS halt and wait for user input after presenting menu
|
||||
- This is the final step - only 'F' will complete the process
|
||||
- Compliance check is required before workflow completion
|
||||
- After other menu items execution, return to this menu
|
||||
- User can chat or ask questions - always respond and then end with display again of the menu options
|
||||
- Use menu handling logic section below
|
||||
@@ -217,12 +218,12 @@ Display: **Workflow Creation Complete!** [A] Advanced Elicitation [P] Party Mode
|
||||
|
||||
- IF A: Execute {advancedElicitationTask}
|
||||
- IF P: Execute {partyModeWorkflow}
|
||||
- IF F: Mark workflow as complete, provide final summary, and end session
|
||||
- IF C: Save content to {workflowPlanFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
|
||||
- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#final-menu-options)
|
||||
|
||||
## FINAL STEP COMPLETION NOTE
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN F is selected and workflow is marked as complete will the session end. Update frontmatter to mark the entire workflow creation process as complete and provide the user with their final deliverables.
|
||||
ONLY WHEN C is selected and content is saved to {workflowPlanFile} with frontmatter updated, will you then load and read fully {nextStepFile} to execute and begin compliance validation phase.
|
||||
|
||||
---
|
||||
|
||||
@@ -0,0 +1,268 @@
|
||||
---
|
||||
name: 'step-08-compliance-check'
|
||||
description: 'Run comprehensive compliance validation on the created workflow'
|
||||
|
||||
# Path Definitions
|
||||
workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
|
||||
|
||||
# File References
|
||||
thisStepFile: '{workflow_path}/steps/step-08-compliance-check.md'
|
||||
workflowFile: '{workflow_path}/workflow.md'
|
||||
generatedWorkflowPath: '{target_workflow_path}'
|
||||
complianceCheckWorkflow: '{project-root}/{bmad_folder}/bmb/workflows/workflow-compliance-check/workflow.md'
|
||||
|
||||
# Task References
|
||||
complianceCheckTask: '{project-root}/{bmad_folder}/bmb/workflows/workflow-compliance-check/workflow.md'
|
||||
---
|
||||
|
||||
# Step 8: Compliance Validation
|
||||
|
||||
## STEP GOAL:
|
||||
|
||||
Run comprehensive compliance validation on the newly created workflow using the workflow-compliance-check workflow to ensure it meets all BMAD standards before completion.
|
||||
|
||||
## MANDATORY EXECUTION RULES (READ FIRST):
|
||||
|
||||
### Universal Rules:
|
||||
|
||||
- 🛑 NEVER generate content without user input
|
||||
- 📖 CRITICAL: Read the complete step file before taking any action
|
||||
- 📋 YOU ARE A FACILITATOR, not a content generator
|
||||
|
||||
### Role Reinforcement:
|
||||
|
||||
- ✅ You are a workflow architect and quality assurance specialist
|
||||
- ✅ If you already have been given a name, communication_style, and persona, continue to use those while playing this new role
|
||||
- ✅ We engage in collaborative dialogue, not command-response
|
||||
- ✅ You bring expertise in BMAD standards and workflow validation
|
||||
- ✅ User brings their newly created workflow and needs quality assurance
|
||||
|
||||
### Step-Specific Rules:
|
||||
|
||||
- 🎯 Focus only on running compliance validation on the created workflow
|
||||
- 🚫 FORBIDDEN to skip compliance validation or declare workflow complete without it
|
||||
- 💬 Approach: Quality-focused, thorough, and collaborative
|
||||
- 📋 Ensure user understands compliance results and next steps
|
||||
|
||||
## EXECUTION PROTOCOLS:
|
||||
|
||||
- 🎯 Launch workflow-compliance-check on the generated workflow
|
||||
- 💾 Review compliance report and present findings to user
|
||||
- 📖 Explain any issues found and provide fix recommendations
|
||||
- 🚫 FORBIDDEN to proceed without compliance validation completion
|
||||
|
||||
## CONTEXT BOUNDARIES:
|
||||
|
||||
- Available context: Newly created workflow files from previous build step
|
||||
- Focus: Compliance validation using workflow-compliance-check workflow
|
||||
- Limits: Validation and reporting only, no further workflow modifications
|
||||
- Dependencies: Successful workflow creation in previous step
|
||||
|
||||
## Sequence of Instructions (Do not deviate, skip, or optimize)
|
||||
|
||||
### 1. Initialize Compliance Validation
|
||||
|
||||
"**Final Step: Workflow Compliance Validation**
|
||||
|
||||
Your workflow has been created! Now let's run a comprehensive compliance check to ensure it meets all BMAD standards and follows best practices.
|
||||
|
||||
This validation will check:
|
||||
|
||||
- Template compliance (workflow-template.md and step-template.md)
|
||||
- File size optimization and markdown formatting
|
||||
- CSV data file standards (if applicable)
|
||||
- Intent vs Prescriptive spectrum alignment
|
||||
- Web search and subprocess optimization
|
||||
- Overall workflow flow and goal alignment"
|
||||
|
||||
### 2. Launch Compliance Check Workflow
|
||||
|
||||
**A. Execute Compliance Validation:**
|
||||
|
||||
"Running comprehensive compliance validation on your workflow...
|
||||
Target: `{generated_workflow_path}`
|
||||
|
||||
**Executing:** {complianceCheckTask}
|
||||
**Validation Scope:** Full 8-phase compliance analysis
|
||||
**Expected Duration:** Thorough validation may take several minutes"
|
||||
|
||||
**B. Monitor Validation Progress:**
|
||||
|
||||
Provide updates as the validation progresses:
|
||||
|
||||
- "✅ Workflow.md validation in progress..."
|
||||
- "✅ Step-by-step compliance checking..."
|
||||
- "✅ File size and formatting analysis..."
|
||||
- "✅ Intent spectrum assessment..."
|
||||
- "✅ Web search optimization analysis..."
|
||||
- "✅ Holistic workflow analysis..."
|
||||
- "✅ Generating comprehensive compliance report..."
|
||||
|
||||
### 3. Compliance Report Analysis
|
||||
|
||||
**A. Review Validation Results:**
|
||||
|
||||
"**Compliance Validation Complete!**
|
||||
|
||||
**Overall Assessment:** [PASS/PARTIAL/FAIL - based on compliance report]
|
||||
|
||||
- **Critical Issues:** [number found]
|
||||
- **Major Issues:** [number found]
|
||||
- **Minor Issues:** [number found]
|
||||
- **Compliance Score:** [percentage]%"
|
||||
|
||||
**B. Present Key Findings:**
|
||||
|
||||
"**Key Compliance Results:**
|
||||
|
||||
- **Template Adherence:** [summary of template compliance]
|
||||
- **File Optimization:** [file size and formatting issues]
|
||||
- **Intent Spectrum:** [spectrum positioning validation]
|
||||
- **Performance Optimization:** [web search and subprocess findings]
|
||||
- **Overall Flow:** [workflow structure and completion validation]"
|
||||
|
||||
### 4. Issue Resolution Options
|
||||
|
||||
**A. Review Compliance Issues:**
|
||||
|
||||
If issues are found:
|
||||
"**Issues Requiring Attention:**
|
||||
|
||||
**Critical Issues (Must Fix):**
|
||||
[List any critical violations that prevent workflow functionality]
|
||||
|
||||
**Major Issues (Should Fix):**
|
||||
[List major issues that impact quality or maintainability]
|
||||
|
||||
**Minor Issues (Nice to Fix):**
|
||||
[List minor standards compliance issues]"
|
||||
|
||||
**B. Resolution Options:**
|
||||
|
||||
"**Resolution Options:**
|
||||
|
||||
1. **Automatic Fixes** - I can apply automated fixes where possible
|
||||
2. **Manual Guidance** - I'll guide you through manual fixes step by step
|
||||
3. **Edit Workflow Launch** - Launch edit-agent with this compliance report
|
||||
4. **Accept as Is** - Proceed with current state (if no critical issues)
|
||||
5. **Detailed Review** - Review full compliance report in detail"
|
||||
|
||||
### 5. Final Validation Confirmation
|
||||
|
||||
**A. User Choice Handling:**
|
||||
|
||||
Based on user selection:
|
||||
|
||||
- **If Automatic Fixes**: Apply fixes and re-run validation
|
||||
- **If Manual Guidance**: Provide step-by-step fix instructions
|
||||
- **If Edit Workflow**: Launch edit-agent with compliance report context
|
||||
- **If Accept as Is**: Confirm understanding of any remaining issues
|
||||
- **If Detailed Review**: Present full compliance report
|
||||
|
||||
**B. Final Status Confirmation:**
|
||||
|
||||
"**Workflow Compliance Status:** [FINAL/PROVISIONAL]
|
||||
|
||||
**Completion Criteria:**
|
||||
|
||||
- ✅ All critical issues resolved
|
||||
- ✅ Major issues addressed or accepted
|
||||
- ✅ Compliance documentation complete
|
||||
- ✅ User understands any remaining minor issues
|
||||
|
||||
**Your workflow is ready for production use!**"
|
||||
|
||||
### 6. Completion Documentation
|
||||
|
||||
**A. Update Workflow Completion:**
|
||||
|
||||
Document final compliance status:
|
||||
|
||||
- **Validation Date:** [current date]
|
||||
- **Compliance Score:** [final percentage]
|
||||
- **Issues Resolved:** [summary of fixes applied]
|
||||
- **Remaining Issues:** [any accepted minor issues]
|
||||
|
||||
**B. Final User Guidance:**
|
||||
|
||||
"**Next Steps for Your Workflow:**
|
||||
|
||||
1. **Test the workflow** with real users to validate functionality
|
||||
2. **Monitor performance** and consider optimization opportunities
|
||||
3. **Gather feedback** for potential future improvements
|
||||
4. **Consider compliance check** periodically for maintenance
|
||||
|
||||
**Support Resources:**
|
||||
|
||||
- Use workflow-compliance-check for future validations
|
||||
- Refer to BMAD documentation for best practices
|
||||
- Consider edit-agent for future modifications"
|
||||
|
||||
### 7. Workflow Completion
|
||||
|
||||
**A. Final Celebration:**
|
||||
|
||||
"🎉 **Congratulations! Your BMAD workflow is complete and compliant!**
|
||||
|
||||
**Workflow Summary:**
|
||||
|
||||
- **Name:** {new_workflow_name}
|
||||
- **Location:** {target_workflow_path}
|
||||
- **Compliance Status:** Fully validated
|
||||
- **Ready for:** Production use
|
||||
|
||||
**You've successfully created a professional BMAD workflow that:**
|
||||
|
||||
- ✅ Follows all BMAD standards and templates
|
||||
- ✅ Optimizes file sizes and performance
|
||||
- ✅ Implements appropriate Intent vs Prescriptive positioning
|
||||
- ✅ Includes efficient tool integrations
|
||||
- ✅ Provides excellent user experience
|
||||
|
||||
**Great work!**"
|
||||
|
||||
**B. Completion Options:**
|
||||
|
||||
"**Workflow Creation Complete!**
|
||||
|
||||
**Select an Option:**
|
||||
|
||||
- [C] Complete - Finish workflow creation
|
||||
- [T] Test Workflow - Try a test run (if workflow supports testing)
|
||||
- [D] Documentation - View full compliance report
|
||||
- [M] More Modifications - Make additional changes"
|
||||
|
||||
## Menu Handling Logic:
|
||||
|
||||
- IF C: End workflow creation successfully with completion summary
|
||||
- IF T: If workflow supports testing, suggest test execution method
|
||||
- IF D: Present detailed compliance report findings
|
||||
- IF M: Return to edit-agent for additional modifications
|
||||
- IF Any other comments or queries: respond and redisplay completion options
|
||||
|
||||
## CRITICAL STEP COMPLETION NOTE
|
||||
|
||||
ONLY WHEN compliance validation is complete and user confirms final workflow status, will the workflow creation process be considered successfully finished.
|
||||
|
||||
---
|
||||
|
||||
## 🚨 SYSTEM SUCCESS/FAILURE METRICS
|
||||
|
||||
### ✅ SUCCESS:
|
||||
|
||||
- Comprehensive compliance validation executed on created workflow
|
||||
- All compliance issues identified and documented with severity rankings
|
||||
- User provided with clear understanding of validation results
|
||||
- Appropriate resolution options offered and implemented
|
||||
- Final workflow meets BMAD standards and is ready for production
|
||||
- User satisfaction with workflow quality and compliance
|
||||
|
||||
### ❌ SYSTEM FAILURE:
|
||||
|
||||
- Skipping compliance validation before workflow completion
|
||||
- Not addressing critical compliance issues found during validation
|
||||
- Failing to provide clear guidance on issue resolution
|
||||
- Declaring workflow complete without ensuring standards compliance
|
||||
- Not documenting final compliance status for future reference
|
||||
|
||||
**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
|
||||
@@ -51,7 +51,7 @@ This uses **step-file architecture** for disciplined execution:
|
||||
|
||||
Load and read full config from {project-root}/{bmad_folder}/bmb/config.yaml and resolve:
|
||||
|
||||
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
|
||||
- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, `custom_workflow_location`
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
|
||||
Reference in New Issue
Block a user