bmad-method 6.0.0-alpha.22 → 6.0.0-alpha.23

package/src/modules/bmb/workflows/workflow/steps-c/step-11-completion.md

@@ -0,0 +1,191 @@
+---
+name: 'step-11-completion'
+description: 'Complete the workflow creation and provide next steps'
+
+targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
+---
+
+# Step 11: Completion
+
+## STEP GOAL:
+
+Complete the workflow creation process with a summary of what was built and next steps guidance.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER modify the completed workflow at this stage
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a workflow architect and systems designer
+- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring completion expertise
+- ✅ User decides next steps
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on summary and next steps
+- 🚫 FORBIDDEN to modify the built workflow
+- 💬 Present options clearly
+- 🚪 This is the final step
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Present completion summary
+- 💾 Finalize plan document
+- 📖 Provide usage guidance
+- 🚫 No more modifications at this stage
+
+## CONTEXT BOUNDARIES:
+
+- All workflow steps have been built
+- Confirmation has been completed
+- Validation may or may not have been run
+- This is the final step
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise.
+
+### 1. Present Completion Summary
+
+"**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━**
+
+# Workflow Creation Complete!
+
+**Workflow:** {new_workflow_name}
+**Location:** {targetWorkflowPath}
+**Created:** {current date}
+
+---
+
+## What Was Built
+
+**Workflow Structure:**
+- **Type:** [continuable/single-session]
+- **Mode:** [create-only/tri-modal]
+- **Steps Created:** [count]
+
+**Files Created:**
+- workflow.md (entry point)
+- [count] step files in steps-c/
+- [count] validation files in steps-v/ (if tri-modal)
+- [count] edit files in steps-e/ (if tri-modal)
+- [count] supporting files in data/
+- [count] templates in templates/
+
+---
+
+## Your Workflow Is Ready!
+
+**To use your new workflow:**
+
+1. Navigate to: {targetWorkflowPath}
+2. Load workflow.md to start
+3. Follow the step-by-step instructions
+
+**━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━**"
+
+### 2. Update Plan with Completion Status
+
+Update {workflowPlanFile} frontmatter:
+
+```yaml
+---
+workflowName: {new_workflow_name}
+creationDate: [original creation date]
+completionDate: [current date]
+status: COMPLETE
+stepsCompleted: ['step-01-discovery' or 'step-00-conversion', 'step-02-classification', 'step-03-requirements', 'step-04-tools', 'step-05-plan-review', 'step-06-design', 'step-07-foundation', 'step-08-build-step-01', 'step-09-build-next-step', 'step-10-confirmation', 'step-11-completion']
+---
+```
+
+### 3. Provide Next Steps Guidance
+
+"**Next Steps:**
+
+**Test your workflow:**
+- Run through it end-to-end
+- Try with sample data
+- Verify all steps work as expected
+
+**Get user feedback:**
+- If others will use it, have them test
+- Gather feedback on facilitation
+- Note any friction points
+
+**Future maintenance:**
+- Use validation mode to check compliance
+- Use edit mode to make changes
+- Validation can be run anytime
+
+**Resources:**
+- **Validate later:** Load {targetWorkflowPath}/workflow.md with -v flag
+- **Edit later:** Load {targetWorkflowPath}/workflow.md with -e flag
+- **Build more:** Use create workflow mode for new workflows"
+
+### 4. Conversion-Specific Summary (If Applicable)
+
+**Check workflowPlanFile frontmatter for `conversionFrom`:**
+
+**IF this was a conversion:**
+
+"**Conversion Complete!**
+
+**Original workflow:** {conversionFrom}
+**New location:** {targetWorkflowPath}
+
+**Preserved:**
+- Original goal and purpose
+- All {count} steps
+- Key instruction patterns
+- Output format
+
+**Improvements made:**
+- BMAD compliance
+- Better structure
+- Enhanced collaboration
+- Standards adherence
+
+**Review the conversion report** in the confirmation step for full details."
+
+### 5. Final Completion Message
+
+"**Thank you for using BMAD Workflow Creator!**
+
+Your workflow **{new_workflow_name}** is complete and ready to use.
+
+**Workflow location:** {targetWorkflowPath}/workflow.md
+
+Happy workflowing! ✅"
+
+## CRITICAL STEP COMPLETION NOTE
+
+This is the final step. Present completion summary, finalize plan, and provide next steps. No further modifications.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Completion summary presented clearly
+- Plan finalized with COMPLETE status
+- Usage guidance provided
+- Conversion specifics noted (if applicable)
+- Session ends positively
+
+### ❌ SYSTEM FAILURE:
+
+- Not providing clear summary
+- Not finalizing plan status
+- Missing usage guidance
+
+**Master Rule:** End on a positive note with clear summary and next steps. The workflow is ready to use.

package/src/modules/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md

@@ -0,0 +1,237 @@
+---
+name: 'step-e-01-assess-workflow'
+description: 'Load target workflow, check compliance, check for validation report, offer validation if needed'
+
+# File References
+nextStepFile: './step-e-02-discover-edits.md'
+editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md'
+validationWorkflow: '../steps-v/step-01-validate.md'
+conversionStep: '../steps-c/step-00-conversion.md'
+---
+
+# Edit Step 1: Assess Workflow
+
+## STEP GOAL:
+
+Load the target workflow, check if it follows BMAD step-file architecture, check for existing validation report, and offer to run validation if needed.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not an autonomous editor
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on assessment - no editing yet
+- 🚫 FORBIDDEN to proceed without loading workflow completely
+- 💬 Explain findings clearly and get user confirmation
+- 🚪 ROUTE non-compliant workflows to create flow
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load and analyze target workflow
+- 💾 Create edit plan document
+- 📖 Check for validation report
+- 🚫 FORBIDDEN to proceed without user confirmation
+
+## CONTEXT BOUNDARIES:
+
+- User provides workflow path from workflow.md routing
+- Focus: Assessment and routing
+- This is NOT about making changes yet
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut.
+
+### 1. Get Workflow Path
+
+From the user input provided by workflow.md routing, extract:
+- `targetWorkflowPath` - path to workflow.md file
+- `workflowName` - derived from path
+
+**If path was not provided:**
+
+"Which workflow would you like to edit? Please provide the path to the workflow.md file."
+
+### 2. Load Workflow Completely
+
+**Load these files:**
+
+1. `{targetWorkflowPath}/workflow.md` - Must exist - if the user indicates is something else, ask if this is a conversion to the compliant v6 format
+2. Check for step folders: `steps*`
+3. Check for `data/` folder
+4. Check for `templates/` folder
+
+### 3. Compliance Check
+
+**Determine if workflow is BMAD-compliant:**
+
+**Compliant workflow has:**
+- ✅ workflow.md file exists at root
+- ✅ At least one step folder exists (steps-c/, steps-v/, or steps-e/)
+- ✅ Step files use markdown format (.md)
+- ✅ workflow.md has frontmatter (name, description)
+
+**Non-compliant workflow:**
+- ❌ No workflow.md file
+- ❌ Has workflow.yaml or instructions.md (legacy format)
+- ❌ No step folders
+- ❌ Step files are not markdown
+
+### 4. Route Based on Compliance
+
+**IF NON-COMPLIANT:**
+
+"**Workflow Assessment Result: Non-Compliant Format**
+
+I found that this workflow does not follow BMAD step-file architecture:
+- [Describe what was found - e.g., legacy format, missing workflow.md, etc.]
+
+**Recommendation:** This workflow should be converted using the create workflow process. The create workflow can use your existing workflow as input discovery material to build a new compliant workflow.
+
+**Would you like to:**
+
+1. **[C]onvert to Compliant Workflow** - Use existing workflow as input to build compliant version
+2. **[E]xplore manual conversion** - I can explain what needs to change
+3. **[X] Exit** - Cancel this operation
+
+#### Menu Handling Logic:
+
+- IF C: Route to create workflow conversion mode → Load {conversionStep} with sourceWorkflowPath set to {targetWorkflowPath}
+- IF E: Explain conversion requirements, then redisplay menu
+- IF X: Exit with guidance
+- IF Any other: help user, then redisplay menu"
+
+**IF COMPLIANT:**
+
+"**Workflow Assessment Result: Compliant Format**
+
+This workflow follows BMAD step-file architecture:
+- ✅ workflow.md found
+- ✅ Step folders: [list which ones exist]
+- ✅ Data folder: [yes/no]
+- ✅ Templates folder: [yes/no]"
+
+Continue to step 5.
+
+### 5. Check for Validation Report
+
+**Look for validation report:**
+- Check `{targetWorkflowPath}/validation-report-{workflow_name}.md`
+- Check if report exists and read completion status
+
+**IF NO VALIDATION REPORT EXISTS:**
+
+"This workflow has not been validated yet.
+
+**Recommendation:** Running validation first can help identify issues before editing. Would you like to:
+
+1. **[V]alidate first** - Run comprehensive validation, then proceed with edits
+2. **[S]kip validation** - Proceed directly to editing
+
+#### Menu Handling Logic:
+
+- IF V: Load, read entirely, then execute {validationWorkflow}. After validation completes, return to this step and proceed to step 6.
+- IF S: Proceed directly to step 6 (Discover Edits)
+- IF Any other: help user, then redisplay menu"
+
+**IF VALIDATION REPORT EXISTS:**
+
+Read the validation report and note:
+- Overall status (COMPLETE/INCOMPLETE)
+- Critical issues count
+- Warning issues count
+
+"**Existing Validation Report Found:**
+
+- Status: [status]
+- Critical Issues: [count]
+- Warnings: [count]
+
+I'll keep this report in mind during editing."
+
+Continue to step 6.
+
+### 6. Create Edit Plan Document
+
+**Initialize edit plan:**
+
+```markdown
+---
+mode: edit
+targetWorkflowPath: '{targetWorkflowPath}'
+workflowName: '{workflow_name}'
+editSessionDate: '{current-date}'
+stepsCompleted:
+  - step-e-01-assess-workflow.md
+hasValidationReport: [true/false]
+validationStatus: [from report if exists]
+---
+
+# Edit Plan: {workflow_name}
+
+## Workflow Snapshot
+
+**Path:** {targetWorkflowPath}
+**Format:** BMAD Compliant ✅
+**Step Folders:** [list found]
+
+## Validation Status
+
+[If report exists: summary of validation status]
+[If no report: No validation run yet]
+
+---
+
+## Edit Goals
+
+*To be populated in next step*
+
+---
+
+## Edits Applied
+
+*To track changes made*
+```
+
+Write to `{editPlan}`.
+
+### 7. Present MENU OPTIONS
+
+Display: "**Assessment Complete. Select an Option:** [C] Continue to Discovery"
+
+#### Menu Handling Logic:
+
+- IF C: Update editPlan, then load, read entire file, then execute {nextStepFile}
+- IF Any other: help user respond, then redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN user selects [C] and edit plan is created, will you then load and read fully `{nextStepFile}` to execute and begin edit discovery.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Workflow loaded completely
+- Compliance status determined
+- Non-compliant workflows routed to create flow
+- Edit plan document created
+- Validation report checked
+- User confirmed to proceed
+
+### ❌ SYSTEM FAILURE:
+
+- Not loading workflow completely
+- Misclassifying non-compliant workflow as compliant
+- Not routing non-compliant to create flow
+- Not checking for validation report
+- Not creating edit plan
+
+**Master Rule:** Assessment must be thorough. Non-compliant workflows MUST be routed to create flow. Always check for validation report before editing.

package/src/modules/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md

@@ -0,0 +1,248 @@
+---
+name: 'step-e-02-discover-edits'
+description: 'Discover what user wants to change - fix validation issues, make changes, or both'
+
+# File References
+nextStepFile: './step-e-03-fix-validation.md'
+directEditStep: './step-e-04-direct-edit.md'
+editPlan: '{bmb_creations_output_folder}/edit-plan-{workflow_name}.md'
+targetWorkflowPath: '{targetWorkflowPath}'
+validationReport: '{targetWorkflowPath}/validation-report-{workflow_name}.md'
+---
+
+# Edit Step 2: Discover Edits
+
+## STEP GOAL:
+
+Discover what the user wants to do: fix validation issues, make specific changes, or both. Document edit goals in the edit plan.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER assume what edits are needed
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not an autonomous editor
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on understanding edit goals
+- 🚫 FORBIDDEN to make any modifications yet
+- 💬 Ask clarifying questions
+- 🚪 CATEGORIZE edits by type
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Guide discovery conversation
+- 💾 Document edit goals in edit plan
+- 📖 Determine which next step to load
+- 🚫 FORBIDDEN to proceed without user confirmation
+
+## CONTEXT BOUNDARIES:
+
+- Edit plan from previous step provides context
+- Validation report (if exists) provides issues to fix
+- Focus: What does user want to change?
+- This is discovery, not implementation
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip or shortcut.
+
+### 1. Read Edit Plan Context
+
+**Load the editPlan file:**
+Read `{editPlan}` to understand the workflow context and validation status.
+
+### 2. Determine Discovery Approach
+
+**IF validation report exists AND has issues:**
+
+Present fix-or-change options (step 3a)
+
+**ELSE (no validation report or no issues):**
+
+Present direct change options (step 3b)
+
+---
+
+### 3a. Discovery With Validation Issues
+
+**IF validation report exists with issues:**
+
+"**I found an existing validation report for this workflow.**
+
+**Validation Summary:**
+- Status: {status from report}
+- Critical Issues: {count}
+- Warnings: {count}
+
+**What would you like to do?**
+
+**[F]ix Validation Issues** - Systematically fix issues found in validation
+**[C]hange Something** - Make a specific change (add feature, modify step, etc.)
+**[B]oth** - Fix validation issues, then make a change
+**[R]eview Report** - See detailed validation findings first
+
+#### Menu Handling Logic:
+
+- IF F: Proceed to [Document Fix Goals](#4-document-fix-goals), then route to {nextStepFile}
+- IF C: Proceed to [Document Change Goals](#3b-discovery-for-direct-change)
+- IF B: Document both fix and change goals, then route to {nextStepFile} for fixes first
+- IF R: Present key findings from validation report, then redisplay this menu
+- IF Any other: help user, then redisplay menu"
+
+---
+
+### 3b. Discovery For Direct Change
+
+**IF no validation report or no issues:**
+
+"**What would you like to change about this workflow?**
+
+I can help you modify:
+
+**[W]orkflow.md** - Goal, role, initialization, routing
+**[S]tep Files** - Add, remove, or modify steps
+**[D]ata Files** - Add or modify reference data in data/ folder
+**[T]emplates** - Add or modify output templates
+**[M]ultiple** - Changes across multiple areas
+**[O]ther** - Something else
+
+Which areas would you like to edit?"
+
+#### For Each Selected Category:
+
+**If Workflow.md selected:**
+- "What aspects need change?"
+  - Goal or description?
+  - Role definition?
+  - Architecture principles?
+  - Initialization/routing?
+
+**If Step Files selected:**
+- "What type of step changes?"
+  - Add new step?
+  - Remove existing step?
+  - Modify step content?
+  - Reorder steps?
+
+**If Data Files selected:**
+- "What data changes?"
+  - Add new data file?
+  - Modify existing data?
+  - Add/remove data entries?
+
+**If Templates selected:**
+- "What template changes?"
+  - Add new template?
+  - Modify template structure?
+  - Change variable references?"
+
+**If Multiple selected:**
+- Walk through each area systematically
+
+**If Other selected:**
+- "Describe what you'd like to change..."
+
+---
+
+### 4. Document Fix Goals (For Validation Issues)
+
+**Append to editPlan:**
+
+```markdown
+## Edit Goals
+
+### Fix Validation Issues
+
+**Priority: High** - These issues prevent compliance
+
+**Critical Issues to Fix:**
+- [ ] {issue from validation report}
+- [ ] {issue from validation report}
+
+**Warnings to Address:**
+- [ ] {warning from validation report}
+- [ ] {warning from validation report}
+```
+
+---
+
+### 5. Document Change Goals
+
+**Append to editPlan:**
+
+```markdown
+### Direct Changes
+
+**Category:** [workflow.md / step files / data / templates / other]
+
+**Changes Requested:**
+- [ ] {specific change description}
+- [ ] {specific change description}
+
+**Rationale:**
+{user's explanation of why this change is needed}
+```
+
+---
+
+### 6. Confirm and Route
+
+**Present summary for confirmation:**
+
+"**Here's what I heard you want to do:**
+
+{Summarize all edit goals clearly}
+
+**Did I capture everything correctly?**
+
+- [C] Yes, continue
+- [M] Modify the plan
+- [X] Cancel"
+
+#### Menu Handling Logic:
+
+- IF C: Update editPlan stepsCompleted, then route based on goals:
+  - **If Fix goals only**: Load, read entirely, then execute {nextStepFile} (fix-validation)
+  - **If Change goals only**: Load, read entirely, then execute {directEditStep}
+  - **If Both**: Load, read entirely, then execute {nextStepFile} (fix first, then direct edit after)
+- IF M: Return to relevant discovery section
+- IF X: Exit with explanation
+- IF Any other: help user, then redisplay menu
+
+### 7. Present MENU OPTIONS (Final)
+
+Display: "**Edit Goals Confirmed. Select an Option:** [C] Continue to Edits"
+
+#### Menu Handling Logic:
+
+- IF C: Save editPlan with confirmed goals, then load appropriate next step based on [Route Based on Goals](#6-confirm-and-route)
+- IF Any other: help user respond, then redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN user confirms goals and routing is determined, will you then load and read fully the appropriate next step file to execute.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Edit goals clearly documented
+- User confirmed the plan
+- Routing determined (fix vs direct vs both)
+- Edit plan updated with goals
+- Appropriate next step selected
+
+### ❌ SYSTEM FAILURE:
+
+- Not documenting edit goals
+- Routing to wrong next step
+- Not getting user confirmation
+- Missing changes user mentioned
+
+**Master Rule:** Discovery must be thorough. Document all goals. Route correctly based on whether fixes, changes, or both are needed.