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

package/src/modules/bmb/workflows/create-workflow/steps/step-07-build.md

@@ -0,0 +1,308 @@
+---
+name: 'step-07-build'
+description: 'Generate all workflow files based on the approved plan'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-07-build.md'
+nextStepFile: '{workflow_path}/steps/step-08-review.md'
+workflowFile: '{workflow_path}/workflow.md'
+# Output files for workflow creation process
+targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
+
+# Template References
+workflowTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md'
+stepTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md'
+stepInitContinuableTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md'
+step1bTemplate: '{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md'
+# No content templates needed - will create content as needed during build
+# No build summary template needed - will append summary directly to workflow plan
+---
+
+# Step 7: Workflow File Generation
+
+## STEP GOAL:
+
+To generate all the workflow files (workflow.md, step files, templates, and supporting files) based on the approved plan from the previous design step.
+
+## 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 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 implementation expertise and best practices
+- ✅ User brings their specific requirements and design approvals
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on generating files based on approved design
+- 🚫 FORBIDDEN to modify the design without user consent
+- 💬 Generate files collaboratively, getting approval at each stage
+- 🚪 CREATE files in the correct target location
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Generate files systematically from design
+- 💾 Document all generated files and their locations
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]` before loading next step
+- 🚫 FORBIDDEN to load next step until user selects 'C' and build is complete
+
+## CONTEXT BOUNDARIES:
+
+- Approved plan from step 6 guides implementation
+- Generate files in target workflow location
+- Load templates and documentation as needed during build
+- Follow step-file architecture principles
+
+## BUILD REFERENCE MATERIALS:
+
+- When building each step file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/step-template.md`
+- When building continuable step-01-init.md files, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md`
+- When building continuation steps, use template `{project-root}/_bmad/bmb/docs/workflows/templates/step-1b-template.md`
+- When building the main workflow.md file, you must follow template `{project-root}/_bmad/bmb/docs/workflows/templates/workflow-template.md`
+- Example step files from {project-root}/_bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md for patterns
+
+## FILE GENERATION SEQUENCE:
+
+### 1. Confirm Build Readiness
+
+Based on the approved plan, confirm:
+"I have your approved plan and I'm ready to generate the workflow files. The plan specifies creating:
+
+- Main workflow.md file
+- [Number] step files
+- [Number] templates
+- Supporting files
+
+All in: {targetWorkflowPath}
+
+Ready to proceed?"
+
+### 2. Create Directory Structure
+
+Create the workflow folder structure in the target location:
+
+```
+{bmb_creations_output_folder}/workflows/{workflow_name}/
+├── workflow.md
+├── steps/
+│   ├── step-01-init.md
+│   ├── step-01b-continue.md (if continuation support needed)
+│   ├── step-02-[name].md
+│   └── ...
+├── templates/
+│   └── [as needed]
+└── data/
+    └── [as needed]
+```
+
+For bmb module, this will be: `_bmad/custom/src/workflows/{workflow_name}/`
+For other modules, check their module.yaml for custom_workflow_location
+
+### 3. Generate workflow.md
+
+Load and follow {workflowTemplate}:
+
+- Create workflow.md using template structure
+- Insert workflow name and description
+- Configure all path variables ({project-root}, _bmad, {workflow_path})
+- Set web_bundle flag to true unless user has indicated otherwise
+- Define role and goal
+- Include initialization path to step-01
+
+### 4. Generate Step Files
+
+#### 4a. Check for Continuation Support
+
+**Check the workflow plan for continuation support:**
+
+- Look for "continuation support: true" or similar flag
+- Check if step-01b-continue.md was included in the design
+- If workflow generates output documents, continuation is typically needed
+
+#### 4b. Generate step-01-init.md (with continuation logic)
+
+If continuation support is needed:
+
+- Load and follow {stepInitContinuableTemplate}
+- This template automatically includes all required continuation detection logic
+- Customize with workflow-specific information:
+  - Update workflow_path references
+  - Set correct outputFile and templateFile paths
+  - Adjust role and persona to match workflow type
+  - Customize welcome message for workflow context
+  - Configure input document discovery patterns (if any)
+- Template automatically handles:
+  - continueFile reference in frontmatter
+  - Logic to check for existing output files with stepsCompleted
+  - Routing to step-01b-continue.md for continuation
+  - Fresh workflow initialization
+
+#### 4c. Generate step-01b-continue.md (if needed)
+
+**If continuation support is required:**
+
+- Load and follow {step1bTemplate}
+- Customize with workflow-specific information:
+  - Update workflow_path references
+  - Set correct outputFile path
+  - Adjust role and persona to match workflow type
+  - Customize welcome back message for workflow context
+- Ensure proper nextStep detection logic based on step numbers
+
+#### 4d. Generate Remaining Step Files
+
+For each remaining step in the design:
+
+- Load and follow {stepTemplate}
+- Create step file using template structure
+- Customize with step-specific content
+- Ensure proper frontmatter with path references
+- Include appropriate menu handling and universal rules
+- Follow all mandatory rules and protocols from template
+- **Critical**: Ensure each step updates `stepsCompleted` array when completing
+
+### 5. Generate Templates (If Needed)
+
+For document workflows:
+
+- Create template.md with proper structure
+- Include all variables from design
+- Ensure variable naming consistency
+
+### 6. Generate Supporting Files
+
+Based on design requirements:
+
+- Create data files (csv)
+- Generate README.md with usage instructions
+- Create any configuration files
+- Add validation checklists if designed
+
+### 7. Verify File Generation
+
+After creating all files:
+
+- Check all file paths are correct
+- Validate frontmatter syntax
+- Ensure variable consistency across files
+- Confirm sequential step numbering
+- Verify menu handling logic
+
+### 8. Document Generated Files
+
+Create a summary of what was generated:
+
+- List all files created with full paths
+- Note any customizations from templates
+- Identify any manual steps needed
+- Provide next steps for testing
+
+## QUALITY CHECKS DURING BUILD:
+
+### Frontmatter Validation
+
+- All YAML syntax is correct
+- Required fields are present
+- Path variables use correct format
+- No hardcoded paths exist
+
+### Step File Compliance
+
+- Each step follows the template structure
+- All mandatory rules are included
+- Menu handling is properly implemented
+- Step numbering is sequential
+
+### Cross-File Consistency
+
+- Variable names match across files
+- Path references are consistent
+- Dependencies are correctly defined
+- No orphaned references exist
+
+## BUILD PRINCIPLES:
+
+### Follow Design Exactly
+
+- Implement the design as approved
+- Don't add or remove steps without consultation
+- Maintain the interaction patterns designed
+- Preserve the data flow architecture
+
+### Maintain Best Practices
+
+- Keep step files focused and reasonably sized (typically 5-10KB)
+- Use collaborative dialogue patterns
+- Include proper error handling
+- Follow naming conventions
+
+### Ensure Extensibility
+
+- Design for future modifications
+- Include clear documentation
+- Make code readable and maintainable
+- Provide examples where helpful
+
+## CONTENT TO APPEND TO PLAN:
+
+After generating all files, append to {workflowPlanFile}:
+
+Create a build summary including:
+
+- List of all files created with full paths
+- Any customizations from templates
+- Manual steps needed
+- Next steps for testing
+
+### 9. Present MENU OPTIONS
+
+Display: **Build Complete - Select an Option:** [C] Continue to Review
+
+#### EXECUTION RULES:
+
+- Build complete - all files generated
+- Present simple completion status
+- User selects [C] to continue to review step
+
+#### Menu Handling Logic:
+
+- IF C: Save build summary to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: respond and redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and content is saved to plan and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow review step.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All workflow files generated in correct locations
+- Files follow step-file architecture principles
+- Plan implemented exactly as approved
+- Build documented in {workflowPlanFile}
+- Frontmatter updated with step completion
+
+### ❌ SYSTEM FAILURE:
+
+- Generating files without user approval
+- Deviating from approved plan
+- Creating files with incorrect paths
+- Not updating plan frontmatter
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/src/modules/bmb/workflows/create-workflow/steps/step-08-review.md

@@ -0,0 +1,284 @@
+---
+name: 'step-08-review'
+description: 'Review the generated workflow and provide final validation and next steps'
+
+# Path Definitions
+workflow_path: '{project-root}/_bmad/bmb/workflows/create-workflow'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-08-review.md'
+workflowFile: '{workflow_path}/workflow.md'
+
+# Output files for workflow creation process
+targetWorkflowPath: '{bmb_creations_output_folder}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
+
+# Task References
+advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+
+# Template References
+# No review template needed - will append review summary directly to workflow plan
+# No completion template needed - will append completion details directly
+
+# Next step reference
+nextStepFile: '{workflow_path}/steps/step-09-complete.md'
+---
+
+# Step 8: Workflow Review and Completion
+
+## STEP GOAL:
+
+To review the generated workflow for completeness, accuracy, and adherence to best practices, then provide next steps for deployment and usage.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: Always 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 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 quality assurance expertise and validation knowledge
+- ✅ User provides final approval and feedback
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on reviewing and validating generated workflow
+- 🚫 FORBIDDEN to make changes without user approval
+- 💬 Guide review process collaboratively
+- 🚪 COMPLETE the workflow creation process
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Conduct thorough review of generated workflow
+- 💾 Document review findings and completion status
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5, 6, 7, 8]` and mark complete
+- 🚫 This is the final step - no next step to load
+
+## CONTEXT BOUNDARIES:
+
+- Generated workflow files are available for review
+- Focus on validation and quality assurance
+- This step completes the workflow creation process
+- No file modifications without explicit user approval
+
+## WORKFLOW REVIEW PROCESS:
+
+### 1. File Structure Review
+
+Verify the workflow organization:
+
+- Are all required files present?
+- Is the directory structure correct?
+- Are file names following conventions?
+- Are paths properly configured?
+
+### 2. Configuration Validation
+
+Check workflow.yaml:
+
+- Is all metadata correctly filled?
+- Are path variables properly formatted?
+- Is the standalone property set correctly?
+- Are all dependencies declared?
+
+### 3. Step File Compliance
+
+Review each step file:
+
+- Does each step follow the template structure?
+- Are all mandatory rules included?
+- Is menu handling properly implemented?
+- Are frontmatter variables correct?
+- Are steps properly numbered?
+
+### 4. Cross-File Consistency
+
+Verify integration between files:
+
+- Do variable names match across all files?
+- Are path references consistent?
+- Is the step sequence logical?
+- Are there any broken references?
+
+### 5. Requirements Verification
+
+Confirm original requirements are met:
+
+- Does the workflow address the original problem?
+- Are all user types supported?
+- Are inputs and outputs as specified?
+- Is the interaction style as designed?
+
+### 6. Best Practices Adherence
+
+Check quality standards:
+
+- Are step files focused and reasonably sized (5-10KB typical)?
+- Is collaborative dialogue implemented?
+- Is error handling included?
+- Are naming conventions followed?
+
+### 7. Test Scenario Planning
+
+Prepare for testing:
+
+- What test data would be useful?
+- What scenarios should be tested?
+- How can the workflow be invoked?
+- What would indicate successful execution?
+
+### 8. Deployment Preparation
+
+Provide next steps:
+
+- Installation requirements
+- Invocation commands
+- Testing procedures
+- Documentation needs
+
+## REVIEW FINDINGS DOCUMENTATION:
+
+### Issues Found
+
+Document any issues discovered:
+
+- **Critical Issues**: Must fix before use
+- **Warnings**: Should fix for better experience
+- **Suggestions**: Nice to have improvements
+
+### Validation Results
+
+Record validation outcomes:
+
+- Configuration validation: PASSED/FAILED
+- Step compliance: PASSED/FAILED
+- Cross-file consistency: PASSED/FAILED
+- Requirements verification: PASSED/FAILED
+
+### Recommendations
+
+Provide specific recommendations:
+
+- Immediate actions needed
+- Future improvements
+- Training needs
+- Maintenance considerations
+
+## COMPLETION CHECKLIST:
+
+### Final Validations
+
+- [ ] All files generated successfully
+- [ ] No syntax errors in YAML
+- [ ] All paths are correct
+- [ ] Variables are consistent
+- [ ] Design requirements met
+- [ ] Best practices followed
+
+### User Acceptance
+
+- [ ] User has reviewed generated workflow
+- [ ] User approves of the implementation
+- [ ] User understands next steps
+- [ ] User satisfied with the result
+
+### Documentation
+
+- [ ] Build summary complete
+- [ ] Review findings documented
+- [ ] Next steps provided
+- [ ] Contact information for support
+
+## CONTENT TO APPEND TO PLAN:
+
+After completing review, append to {workflowPlanFile}:
+
+Append review findings to {workflowPlanFile}:
+
+Create a review summary including:
+
+- Completeness check results
+- Accuracy validation
+- Compliance with best practices
+- Any issues found
+
+Then append completion details:
+
+- Final approval status
+- Deployment recommendations
+- Usage guidance
+
+### 10. Present MENU OPTIONS
+
+Display: **Select an Option:** [C] Continue to Completion
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- User can chat or ask questions - always respond and then end with display again of the menu options
+- Use menu handling logic section below
+
+#### Menu Handling Logic:
+
+- IF C: Save review to {workflowPlanFile}, update frontmatter, then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options)
+
+## COMPLIANCE CHECK INSTRUCTIONS
+
+When user selects [C], provide these instructions:
+
+**🎯 Workflow Creation Complete! Your new workflow is ready at:**
+`{target_workflow_path}`
+
+**⚠️ IMPORTANT - Run Compliance Check in New Context:**
+To validate your workflow meets BMAD standards:
+
+1. **Start a new Claude conversation** (fresh context)
+2. **Use this command:** `/bmad:bmm:workflows:workflow-compliance-check`
+3. **Provide the path:** `{target_workflow_path}/workflow.md`
+4. **Follow the validation process** to identify and fix any violations
+
+**Why New Context?**
+
+- Compliance checking requires fresh analysis without workflow creation context
+- Ensures objective validation against template standards
+- Provides detailed violation reporting with specific fix recommendations
+
+**Your workflow will be checked for:**
+
+- Template compliance and structure
+- Step-by-step validation standards
+- File optimization and formatting
+- Meta-workflow best practices
+
+Ready to validate when you are! [Start new context and run compliance check]
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Generated workflow thoroughly reviewed
+- All validations performed
+- Issues documented with solutions
+- User approves final workflow
+- Complete documentation provided
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping review steps
+- Not documenting findings
+- Ending without user approval
+- Not providing next steps
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.