bmad-method 6.0.0-alpha.12 → 6.0.0-alpha.14

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

@@ -0,0 +1,228 @@
+---
+installed_path: '{project-root}/{bmad_folder}/bmb/workflows/create-module'
+nextStepFile: '{installed_path}/steps/step-08-installer.md'
+modulePlanFile: '{custom_module_location}/{module_name}/module-plan-{module_name}.md'
+workflowPlanTemplate: '{installed_path}/templates/workflow-plan-template.md'
+advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
+---
+
+# Step 7: Review Workflow Plans
+
+## 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 Module Architect and Workflow 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 expertise in BMAD workflow patterns, user brings their workflow requirements
+- ✅ Maintain collaborative, review-focused tone
+
+### Step-Specific Rules:
+
+- 🎯 Focus on reviewing existing workflow README files from Step 6
+- 🚫 FORBIDDEN to use create-workflow workflow in this step
+- 💬 Review and refine workflow plans, not create new ones
+- 🚫 FORBIDDEN to create actual workflow steps
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Review workflow README files created in Step 6
+- 💾 Update README files based on user feedback
+- 📖 Add "step-07-workflows" to stepsCompleted array` before loading next step
+- 🚫 FORBIDDEN to load next step until user selects 'C'
+
+## CONTEXT BOUNDARIES:
+
+- Workflow README files were created in Step 6 for each agent
+- These README files contain workflow plans for later implementation
+- Module structure already created with workflow folders
+- Focus on reviewing and refining, not creating from scratch
+
+## STEP GOAL:
+
+To review and refine the workflow README files created in Step 6, ensuring they have clear plans for later implementation with the create-workflow workflow.
+
+## WORKFLOW REVIEW PROCESS:
+
+### 1. List Workflow Folders Created
+
+"Let's review the workflow plans created in Step 6 for your {module_display_name} module.
+
+I've already created workflow folders and README.md files for each agent's workflows:
+
+**Workflow folders found:**
+
+- [List all workflow folders in {custom_module_location}/{module_name}/workflows/]
+
+**Each workflow folder contains a README.md with:**
+
+- Purpose and description
+- Trigger code from agent menu
+- Key steps outline
+- Expected outputs
+- Notes for implementation"
+
+### 2. Review Each Workflow Plan
+
+For each workflow README file:
+
+#### 2.1 Load and Present
+
+"**Reviewing Workflow: [Workflow Name]**
+
+Reading the README.md from: [workflow-folder]/README.md
+
+**Current Plan:**
+[Purpose]
+[Trigger]
+[Key Steps]
+[Expected Output]
+[Notes]
+
+How does this plan look? Should we:
+
+- Keep it as is
+- Modify the purpose
+- Adjust the steps
+- Change the expected output"
+
+#### 2.2 Update Based on Feedback
+
+If user wants changes:
+
+- Update the README.md file
+- Keep the same basic structure
+- Ensure clarity for future implementation
+
+#### 2.3 Check for Missing Information
+
+Ensure each README has:
+
+```markdown
+# [Workflow Name]
+
+## Purpose
+
+[Clear, concise description of what this workflow accomplishes]
+
+## Trigger
+
+[Trigger code from agent menu, e.g., "WF" or specific code]
+
+## Key Steps
+
+1. [Step 1 - What happens first]
+2. [Step 2 - What happens next]
+3. [Step 3 - Continue as needed]
+
+## Expected Output
+
+[What the workflow produces - document, action, result]
+
+## Notes
+
+This workflow will be implemented using the create-workflow workflow.
+(Optional: Any special considerations or requirements)
+```
+
+### 3. Link Workflows to Agents
+
+"**Workflow-Agent Mapping:**
+
+Let's verify each workflow is properly linked to its agent:
+
+[For each workflow]:
+
+- **Workflow:** [Workflow Name]
+- **Agent:** [Agent Name]
+- **Trigger Code:** [WF code]
+- **Menu Item:** [Menu description in agent]
+
+Are all these mappings correct in the agent files?"
+
+### 4. Document Implementation Plan
+
+Update module-plan.md with workflow section:
+
+```markdown
+## Workflow Plans Reviewed
+
+### For Agent [Agent Name]:
+
+1. **[Workflow Name]**
+   - Location: workflows/[workflow-name]/
+   - Status: Plan reviewed and ready for implementation
+   - Trigger: [WF code]
+   - Implementation: Use create-workflow workflow
+
+2. **[Workflow Name]**
+   - Location: workflows/[workflow-name]/
+   - Status: Plan reviewed and ready for implementation
+   - Trigger: [WF code]
+   - Implementation: Use create-workflow workflow
+```
+
+### 5. Next Steps Guidance
+
+"**Ready for Implementation:**
+
+All workflow plans are now reviewed and ready. To implement these workflows later:
+
+1. Use the `/bmad:bmb:workflows:create-workflow` command
+2. Select each workflow folder
+3. Follow the create-workflow workflow
+4. It will create the full workflow.md and step files
+
+The README.md in each folder serves as your blueprint for implementation."
+
+### 6. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask} to refine workflow designs
+- IF P: Execute {partyModeWorkflow} to get creative input on workflow processes
+- IF C: Save workflow plan status to module-plan.md, add step-07-workflows to the end of the stepsCompleted array in frontmatter, then load nextStepFile
+- IF Any other comments or queries: help user respond then redisplay menu
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond then end with display again of the menu options
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All workflow README files reviewed with user
+- Each workflow plan has clear purpose and steps
+- Workflow-agent mappings verified
+- README files updated based on feedback
+- Clear implementation guidance provided
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping review of workflow README files
+- Not updating plans based on user feedback
+- Missing critical information in README files
+- Not verifying workflow-agent mappings
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and all workflow plans are reviewed and documented and stepsCompleted updated, will you then load, read entire file, then execute `{nextStepFile}` to begin installer setup.

package/src/modules/bmb/workflows/create-module/steps/step-08-installer.md

@@ -0,0 +1,186 @@
+---
+installed_path: '{project-root}/{bmad_folder}/bmb/workflows/create-module'
+nextStepFile: '{installed_path}/steps/step-09-documentation.md'
+modulePlanFile: '{custom_module_location}/{module_name}/module-plan-{module_name}.md'
+installerTemplate: '{installed_path}/templates/installer.template.js'
+installConfigTemplate: '{installed_path}/templates/install-config.template.yaml'
+advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
+---
+
+# Step 8: Setup Module Installer
+
+## 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 Module Architect and Installation Specialist
+- ✅ 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 expertise in BMAD installation patterns, user brings their module requirements
+- ✅ Maintain collaborative, technical tone
+
+### Step-Specific Rules:
+
+- 🎯 Focus on creating installer configuration files
+- 🚫 FORBIDDEN to run actual installation
+- 💬 Follow BMAD installer standards exactly
+- 🚫 FORBIDDEN to deviate from configuration template
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Use configuration plan from step 5
+- 💾 Create install-config.yaml with all fields
+- 📖 Add "step-08-installer" to stepsCompleted array` before loading next step
+- 🚫 FORBIDDEN to load next step until user selects 'C'
+
+## CONTEXT BOUNDARIES:
+
+- Configuration plan from step 5 defines installer fields
+- Standard BMAD installer template to follow
+- Module structure already created
+- Focus on installer setup, not module content
+
+## STEP GOAL:
+
+To create the module installer configuration (install-config.yaml) that defines how users will install and configure the module.
+
+## INSTALLER SETUP PROCESS:
+
+### 1. Review Configuration Plan
+
+"Now let's set up the installer for your {module_display_name} module.
+
+The installer will:
+
+- Define how users install your module
+- Collect configuration settings
+- Set up the module structure in user projects
+- Generate the module's config.yaml file
+
+From step 5, we planned these configuration fields:
+
+- [List planned configuration fields]"
+
+### 2. Create Installer Directory
+
+Ensure \_module-installer directory exists
+Directory: {custom_module_location}/{module_name}/\_module-installer/
+
+### 3. Create install-config.yaml
+
+"I'll create the install-config.yaml file based on your configuration plan. This is the core installer configuration file."
+
+Create file: {custom_module_location}/{module_name}/\_module-installer/install-config.yaml from template {installConfigTemplate}
+
+### 4. Handle Custom Installation Logic
+
+"**Custom Installation Logic:**
+
+Does your module need any special setup during installation? For example:
+
+- Creating database tables
+- Setting up API connections
+- Downloading external assets
+- Running initialization scripts"
+
+<ask>Does your module need custom installation logic? [yes/no]</ask>
+
+"I'll create an installer.js file for custom logic."
+
+Create file: {custom_module_location}/{module_name}/\_module-installer/installer.js from {installerTemplate}
+
+Update installer.js with module-specific logic
+
+### 5. Create Assets Directory (if needed)
+
+"**Installer Assets:**
+
+If your module needs to copy files during installation (templates, examples, documentation), we can add them to the assets directory."
+
+Create directory: \_module-installer/assets/
+Add note about what assets to include
+
+### 6. Document Installer Setup
+
+Update module-plan.md with installer section:
+
+```markdown
+## Installer Configuration
+
+### Install Configuration
+
+- File: \_module-installer/install-config.yaml
+- Module code: {module_name}
+- Default selected: false
+- Configuration fields: [count]
+
+### Custom Logic
+
+- installer.js: [Created/Not needed]
+- Custom setup: [description if yes]
+
+### Installation Process
+
+1. User runs: `bmad install {module_name}`
+2. Installer asks: [list of questions]
+3. Creates: {bmad_folder}/{module_name}/
+4. Generates: config.yaml with user settings
+
+### Validation
+
+- ✅ YAML syntax valid
+- ✅ All fields defined
+- ✅ Paths use proper templates
+- ✅ Custom logic ready (if needed)
+```
+
+### 7. Present MENU OPTIONS
+
+Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask} to review installer configuration
+- IF P: Execute {partyModeWorkflow} to get input on user experience
+- IF C: Save installer info to module-plan.md, add step-08-installer to the end of the stepsCompleted array in frontmatter, then load nextStepFile
+- IF Any other comments or queries: help user respond then redisplay menu
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond then end with display again of the menu options
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- install-config.yaml created with all planned fields
+- YAML syntax valid
+- Custom installation logic prepared (if needed)
+- Installer follows BMAD standards
+- Configuration properly templated
+
+### ❌ SYSTEM FAILURE:
+
+- Not creating install-config.yaml
+- Invalid YAML syntax
+- Missing required fields
+- Not using proper path templates
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and installer info is saved to module-plan.md with stepsCompleted updated to [1, 2, 3, 4, 5, 6, 7, 8], will you then load, read entire file, then execute `{nextStepFile}` to begin documentation creation.