bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.20

package/src/modules/bmb/workflows/edit-workflow/templates/workflow-analysis.md

@@ -0,0 +1,56 @@
+## Workflow Analysis
+
+### Target Workflow
+
+- **Path**: {{workflowPath}}
+- **Name**: {{workflowName}}
+- **Module**: {{workflowModule}}
+- **Format**: {{workflowFormat}} (Standalone/Legacy)
+
+### Structure Analysis
+
+- **Type**: {{workflowType}}
+- **Total Steps**: {{stepCount}}
+- **Step Flow**: {{stepFlowPattern}}
+- **Files**: {{fileStructure}}
+
+### Content Characteristics
+
+- **Purpose**: {{workflowPurpose}}
+- **Instruction Style**: {{instructionStyle}}
+- **User Interaction**: {{interactionPattern}}
+- **Complexity**: {{complexityLevel}}
+
+### Initial Assessment
+
+#### Strengths
+
+{{#strengths}}
+
+- {{.}}
+  {{/strengths}}
+
+#### Potential Issues
+
+{{#issues}}
+
+- {{.}}
+  {{/issues}}
+
+#### Format-Specific Notes
+
+{{#formatNotes}}
+
+- {{.}}
+  {{/formatNotes}}
+
+### Best Practices Compliance
+
+- **Step File Structure**: {{stepCompliance}}
+- **Frontmatter Usage**: {{frontmatterCompliance}}
+- **Menu Implementation**: {{menuCompliance}}
+- **Variable Consistency**: {{variableCompliance}}
+
+---
+
+_Analysis completed on {{date}}_

package/src/modules/bmb/workflows/edit-workflow/workflow.md

@@ -0,0 +1,58 @@
+---
+name: edit-workflow
+description: Intelligent workflow editor that helps modify existing workflows while following best practices
+web_bundle: true
+---
+
+# Edit Workflow
+
+**Goal:** Collaboratively edit and improve existing workflows, ensuring they follow best practices and meet user needs effectively.
+
+**Your Role:** In addition to your name, communication_style, and persona, you are also a workflow editor and improvement specialist collaborating with a workflow owner. This is a partnership, not a client-vendor relationship. You bring expertise in workflow design patterns, best practices, and collaborative facilitation, while the user brings their workflow context, user feedback, and improvement goals. Work together as equals.
+
+---
+
+## WORKFLOW ARCHITECTURE
+
+This uses **step-file architecture** for disciplined execution:
+
+### Core Principles
+
+- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
+- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
+- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
+- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
+- **Append-Only Building**: Build documents by appending content as directed to the output file
+
+### Step Processing Rules
+
+1. **READ COMPLETELY**: Always read the entire step file before taking any action
+2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
+3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
+4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
+5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
+6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
+
+### Critical Rules (NO EXCEPTIONS)
+
+- 🛑 **NEVER** load multiple step files simultaneously
+- 📖 **ALWAYS** read entire step file before execution
+- 🚫 **NEVER** skip steps or optimize the sequence
+- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
+- 🎯 **ALWAYS** follow the exact instructions in the step file
+- ⏸️ **ALWAYS** halt at menus and wait for user input
+- 📋 **NEVER** create mental todo lists from future steps
+
+---
+
+## INITIALIZATION SEQUENCE
+
+### 1. Configuration Loading
+
+Load and read full config from {project-root}/_bmad/bmb/config.yaml and resolve:
+
+- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`
+
+### 2. First Step EXECUTION
+
+Load, read the full file and then execute `{workflow_path}/steps/step-01-analyze.md` to begin the workflow.

package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md

@@ -0,0 +1,152 @@
+---
+name: 'step-01-validate-goal'
+description: 'Confirm workflow path and validation goals before proceeding'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-01-validate-goal.md'
+nextStepFile: '{workflow_path}/steps/step-02-workflow-validation.md'
+workflowFile: '{workflow_path}/workflow.md'
+complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md'
+
+# Template References
+complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
+
+# Documentation References
+stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md'
+workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md'
+---
+
+# Step 1: Goal Confirmation and Workflow Target
+
+## STEP GOAL:
+
+Confirm the target workflow path and validation objectives before proceeding with systematic compliance analysis.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a compliance validator 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 compliance expertise and systematic validation skills
+- ✅ User brings their workflow and specific compliance concerns
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on confirming workflow path and validation scope
+- 🚫 FORBIDDEN to proceed without clear target confirmation
+- 💬 Approach: Systematic and thorough confirmation of validation objectives
+- 📋 Ensure user understands the compliance checking process and scope
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Confirm target workflow path exists and is accessible
+- 💾 Establish clear validation objectives and scope
+- 📖 Explain the three-phase compliance checking process
+- 🚫 FORBIDDEN to proceed without user confirmation of goals
+
+## CONTEXT BOUNDARIES:
+
+- Available context: User-provided workflow path and validation concerns
+- Focus: Goal confirmation and target validation setup
+- Limits: No actual compliance analysis yet, just setup and confirmation
+- Dependencies: Clear workflow path and user agreement on validation scope
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Workflow Target Confirmation
+
+Present this to the user:
+
+"I'll systematically validate your workflow against BMAD standards through three phases:
+
+1. **Workflow.md Validation** - Against workflow-template.md standards
+2. **Step-by-Step Compliance** - Each step against step-template.md
+3. **Holistic Analysis** - Flow optimization and goal alignment"
+
+IF {user_provided_path} has NOT been provided, ask the user:
+
+**What workflow should I validate?** Please provide the full path to the workflow.md file."
+
+### 2. Workflow Path Validation
+
+Once user provides path:
+
+"Validating workflow path: `{user_provided_path}`"
+[Check if path exists and is readable]
+
+**If valid:** "✅ Workflow found and accessible. Ready to begin compliance analysis."
+**If invalid:** "❌ Cannot access workflow at that path. Please check the path and try again."
+
+### 3. Validation Scope Confirmation
+
+"**Compliance Scope:** I will check:
+
+- ✅ Frontmatter structure and required fields
+- ✅ Mandatory execution rules and sections
+- ✅ Menu patterns and continuation logic
+- ✅ Path variable format consistency
+- ✅ Template usage appropriateness
+- ✅ Workflow flow and goal alignment
+- ✅ Meta-workflow failure analysis
+
+**Report Output:** I'll generate a detailed compliance report with:
+
+- Severity-ranked violations (Critical/Major/Minor)
+- Specific template references for each violation
+- Recommended fixes (automated where possible)
+- Meta-feedback for create/edit workflow improvements
+
+**Is this validation scope acceptable?**"
+
+### 4. Final Confirmation
+
+"**Ready to proceed with compliance check of:**
+
+- **Workflow:** `{workflow_name}`
+- **Validation:** Full systematic compliance analysis
+- **Output:** Detailed compliance report with fix recommendations
+
+**Select an Option:** [C] Continue [X] Exit"
+
+## Menu Handling Logic:
+
+- IF C: Initialize compliance report, update frontmatter, then load, read entire file, then execute {nextStepFile}
+- IF X: End workflow gracefully with guidance on running again later
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#4-final-confirmation)
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [workflow path validated and scope confirmed], will you then load and read fully `{nextStepFile}` to execute and begin workflow.md validation phase.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Workflow path successfully validated and accessible
+- User confirms validation scope and objectives
+- Compliance report initialization prepared
+- User understands the three-phase validation process
+- Clear next steps established for systematic analysis
+
+### ❌ SYSTEM FAILURE:
+
+- Proceeding without valid workflow path confirmation
+- Not ensuring user understands validation scope and process
+- Starting compliance analysis without proper setup
+- Failing to establish clear reporting objectives
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/src/modules/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md

@@ -0,0 +1,243 @@
+---
+name: 'step-02-workflow-validation'
+description: 'Validate workflow.md against workflow-template.md standards'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmb/workflows/workflow-compliance-check'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-02-workflow-validation.md'
+nextStepFile: '{workflow_path}/steps/step-03-step-validation.md'
+workflowFile: '{workflow_path}/workflow.md'
+complianceReportFile: '{output_folder}/workflow-compliance-report-{workflow_name}.md'
+targetWorkflowFile: '{target_workflow_path}'
+
+# Template References
+complianceReportTemplate: '{workflow_path}/templates/compliance-report.md'
+
+# Documentation References
+stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md'
+workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md'
+---
+
+# Step 2: Workflow.md Validation
+
+## STEP GOAL:
+
+Perform adversarial validation of the target workflow.md against workflow-template.md standards, identifying all violations with severity rankings and specific fix recommendations.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a compliance validator 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 adversarial validation expertise - your success is finding violations
+- ✅ User brings their workflow and needs honest, thorough validation
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on workflow.md validation against template standards
+- 🚫 FORBIDDEN to skip or minimize any validation checks
+- 💬 Approach: Systematic, thorough adversarial analysis
+- 📋 Document every violation with template reference and severity ranking
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load and compare target workflow.md against workflow-template.md
+- 💾 Document all violations with specific template references
+- 📖 Rank violations by severity (Critical/Major/Minor)
+- 🚫 FORBIDDEN to overlook any template violations
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Validated workflow path and target workflow.md
+- Focus: Systematic validation of workflow.md structure and content
+- Limits: Only workflow.md validation, not step files yet
+- Dependencies: Successful completion of goal confirmation step
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Initialize Compliance Report
+
+"Beginning **Phase 1: Workflow.md Validation**
+Target: `{target_workflow_name}`
+
+**COMPLIANCE STANDARD:** All validation performed against `{workflowTemplate}` - this is THE authoritative standard for workflow.md compliance.
+
+Loading workflow templates and target files for systematic analysis..."
+[Load workflowTemplate, targetWorkflowFile]
+
+### 2. Frontmatter Structure Validation
+
+**Check these elements systematically:**
+
+"**Frontmatter Validation:**"
+
+- Required fields: name, description, web_bundle
+- Proper YAML format and syntax
+- Boolean value format for web_bundle
+- Missing or invalid fields
+
+For each violation found:
+
+- **Template Reference:** Section "Frontmatter Structure" in workflow-template.md
+- **Severity:** Critical (missing required) or Major (format issues)
+- **Specific Fix:** Exact correction needed
+
+### 3. Role Description Validation
+
+**Check role compliance:**
+
+"**Role Description Validation:**"
+
+- Follows partnership format: "In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals."
+- Role accurately describes workflow function
+- User type correctly identified
+- Partnership language present
+
+For violations:
+
+- **Template Reference:** "Your Role" section in workflow-template.md
+- **Severity:** Major (deviation from standard) or Minor (incomplete)
+- **Specific Fix:** Exact wording or structure correction
+
+### 4. Workflow Architecture Validation
+
+**Validate architecture section:**
+
+"**Architecture Validation:**"
+
+- Core Principles section matches template exactly
+- Step Processing Rules includes all 6 rules from template
+- Critical Rules section matches template exactly (NO EXCEPTIONS)
+
+For each deviation:
+
+- **Template Reference:** "WORKFLOW ARCHITECTURE" section in workflow-template.md
+- **Severity:** Critical (modified core principles) or Major (missing rules)
+- **Specific Fix:** Restore template-compliant text
+
+### 5. Initialization Sequence Validation
+
+**Check initialization:**
+
+"**Initialization Validation:**"
+
+- Configuration Loading uses correct path format: `{project-root}/_bmad/[module]/config.yaml` (variable substitution pattern)
+- First step follows pattern: `step-01-init.md` OR documented deviation
+- Required config variables properly listed
+- Variables use proper substitution pattern: {project-root}, _bmad, {workflow_path}, etc.
+
+For violations:
+
+- **Template Reference:** "INITIALIZATION SEQUENCE" section in workflow-template.md
+- **Severity:** Major (incorrect paths or missing variables) or Minor (format issues)
+- **Specific Fix:** Use proper variable substitution patterns for flexible installation
+
+### 6. Document Workflow.md Findings
+
+"**Workflow.md Validation Complete**
+Found [X] Critical, [Y] Major, [Z] Minor violations
+
+**Summary:**
+
+- Critical violations must be fixed before workflow can function
+- Major violations impact workflow reliability and maintainability
+- Minor violations are cosmetic but should follow standards
+
+**Next Phase:** Step-by-step validation of all step files..."
+
+### 7. Update Compliance Report
+
+Append to {complianceReportFile}:
+
+```markdown
+## Phase 1: Workflow.md Validation Results
+
+### Template Adherence Analysis
+
+**Reference Standard:** {workflowTemplate}
+
+### Frontmatter Structure Violations
+
+[Document each violation with severity and specific fix]
+
+### Role Description Violations
+
+[Document each violation with template reference and correction]
+
+### Workflow Architecture Violations
+
+[Document each deviation from template standards]
+
+### Initialization Sequence Violations
+
+[Document each path or reference issue]
+
+### Phase 1 Summary
+
+**Critical Issues:** [number]
+**Major Issues:** [number]
+**Minor Issues:** [number]
+
+### Phase 1 Recommendations
+
+[Prioritized fix recommendations with specific actions]
+```
+
+### 8. Continuation Confirmation
+
+"**Phase 1 Complete:** Workflow.md validation finished with detailed violation analysis.
+
+**Ready for Phase 3:** Step-by-step validation against step-template.md
+
+This will check each step file for:
+
+- Frontmatter completeness and format
+- MANDATORY EXECUTION RULES compliance
+- Menu pattern and continuation logic
+- Path variable consistency
+- Template appropriateness
+
+**Select an Option:** [C] Continue to Step Validation [X] Exit"
+
+## Menu Handling Logic:
+
+- IF C: Save workflow.md findings to report, update frontmatter, then load, read entire file, then execute {nextStepFile}
+- IF X: Save current findings and end workflow with guidance for resuming
+- IF Any other comments or queries: respond and redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [workflow.md validation complete with all violations documented], will you then load and read fully `{nextStepFile}` to execute and begin step-by-step validation phase.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Complete workflow.md validation against workflow-template.md
+- All violations documented with severity rankings and template references
+- Specific fix recommendations provided for each violation
+- Compliance report updated with Phase 1 findings
+- User confirms understanding before proceeding
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping any workflow.md validation sections
+- Not documenting violations with specific template references
+- Failing to rank violations by severity
+- Providing vague or incomplete fix recommendations
+- Proceeding without user confirmation of findings
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.