bmad-method 6.0.0-alpha.13 → 6.0.0-alpha.15

package/src/modules/bmb/workflows/create-module/templates/module.template.yaml

@@ -0,0 +1,53 @@
+# {module_display_name} Module Configuration
+# This file defines installation questions and module configuration values
+
+code: "${module_name}" # e.g., my-module
+name: "{module_display_name}"
+default_selected: false
+
+# Welcome message shown during installation
+prompt:
+  - "Thank you for choosing {module_display_name}!"
+  - "{module_purpose}"
+# Core config values are automatically inherited from installer:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+
+# ============================================================================
+# CONFIGURATION FIELDS
+# ============================================================================
+# Each field can be:
+# 1. INTERACTIVE (has 'prompt' - asks user during installation)
+# 2. STATIC (no 'prompt' - just uses 'result' value)
+# ============================================================================
+
+# Example configurations (replace with actual planned fields):
+
+# INTERACTIVE text input:
+# output_path:
+#   prompt: "Where should {module_name} save outputs?"
+#   default: "output/{module_name}"
+#   result: "{project-root}/{value}"
+
+# INTERACTIVE single-select:
+# detail_level:
+#   prompt: "How detailed should outputs be?"
+#   default: "standard"
+#   result: "{value}"
+#   single-select:
+#     - value: "minimal"
+#       label: "Minimal - Brief summaries only"
+#     - value: "standard"
+#       label: "Standard - Balanced detail"
+#     - value: "detailed"
+#       label: "Detailed - Comprehensive information"
+
+# STATIC value:
+# module_version:
+#   result: "1.0.0"
+
+# STATIC path:
+# data_path:
+#   result: "{project-root}/{bmad_folder}/{module_name}/data"

package/src/modules/bmb/workflows/create-module/templates/workflow-plan-template.md

@@ -0,0 +1,23 @@
+# Workflow Plan Template
+
+Use this template when creating workflow plans in step-07-workflows.md
+
+## Template Structure
+
+Copy the content from step-07-workflows.md when creating workflow plans. The template is embedded in the step file as a code block under "Workflow plan template".
+
+## Usage
+
+1. Navigate to the workflow folder
+2. Create workflow-plan.md
+3. Use the template structure from step-07-workflows.md
+4. Fill in details specific to your workflow
+
+## Required Sections
+
+- Purpose
+- Requirements (User Inputs, Prerequisites, Dependencies)
+- Proposed Steps
+- Expected Outputs
+- Integration Points
+- Implementation Notes

package/src/modules/bmb/workflows/create-module/validation.md

@@ -0,0 +1,126 @@
+# Create Module Workflow Validation Checklist
+
+This document provides the validation criteria used in step-11-validate.md to ensure module quality and BMAD compliance.
+
+## Structure Validation
+
+### Required Directories
+
+- [ ] agents/ - Agent definition files
+- [ ] workflows/ - Workflow folders
+- [ ] tasks/ - Task files (if needed)
+- [ ] templates/ - Shared templates
+- [ ] data/ - Module data
+- [ ] \_module-installer/ - Installation config
+- [ ] README.md - Module documentation
+- [ ] module.yaml - module config file
+
+### Optional File in \_module-installer/
+
+- [ ] installer.js - Custom logic (if needed)
+
+## Configuration Validation
+
+### module.yaml
+
+- [ ] Valid YAML syntax
+- [ ] Module code matches folder name
+- [ ] Name field present
+- [ ] Prompt array with welcome messages
+- [ ] Configuration fields properly defined
+- [ ] Result templates use correct placeholders
+
+### Module Plan
+
+- [ ] All sections completed
+- [ ] Module identity documented
+- [ ] Component plan clear
+- [ ] Configuration plan documented
+
+## Component Validation
+
+### Agents
+
+- [ ] Files created in agents/ folder
+- [ ] YAML frontmatter valid (for created agents)
+- [ ] TODO flags used for non-existent workflows
+- [ ] Menu items follow BMAD patterns
+- [ ] Placeholder files contain TODO notes
+
+### Workflows
+
+- [ ] Folders created for each planned workflow
+- [ ] workflow-plan.md in each folder
+- [ ] README.md in each workflow folder
+- [ ] Plans include all required sections
+- [ ] Placeholder READMEs created for unplanned workflows
+
+## Documentation Validation
+
+### README.md
+
+- [ ] Module name and purpose
+- [ ] Installation instructions
+- [ ] Components section
+- [ ] Quick start guide
+- [ ] Module structure diagram
+- [ ] Configuration section
+- [ ] Usage examples
+- [ ] Development status
+- [ ] Author information
+
+### TODO.md
+
+- [ ] Development phases defined
+- [ ] Tasks prioritized
+- [ ] Quick commands included
+- [ ] Completion criteria defined
+
+## Integration Validation
+
+### Path Consistency
+
+- [ ] All paths use correct template format
+- [ ] Module code consistent throughout
+- [ ] No hardcoded paths
+- [ ] Cross-references correct
+
+### Agent-Workflow Integration
+
+- [ ] Agents reference correct workflows
+- [ ] TODO flags used appropriately
+- [ ] No circular dependencies
+- [ ] Clear integration points
+
+## BMAD Compliance
+
+### Standards
+
+- [ ] Follows BMAD module structure
+- [ ] Uses BMAD installation patterns
+- [ ] Agent files follow BMAD format
+- [ ] Workflow plans follow BMAD patterns
+
+### Best Practices
+
+- [ ] Clear naming conventions
+- [ ] Proper documentation
+- [ ] Version control ready
+- [ ] Installable via bmad install
+
+## Final Checklist
+
+### Before Marking Complete
+
+- [ ] All validation items checked
+- [ ] Critical issues resolved
+- [ ] Module plan updated with final status
+- [ ] stepsCompleted includes all 11 steps
+- [ ] User satisfied with result
+
+### Ready for Testing
+
+- [ ] Installation should work
+- [ ] Documentation accurate
+- [ ] Structure complete
+- [ ] Next steps clear

package/src/modules/bmb/workflows/create-module/workflow.md

@@ -0,0 +1,55 @@
+---
+name: create-module
+description: 'Interactive workflow to build complete BMAD modules with agents, workflows, and installation infrastructure'
+web_bundle: true
+installed_path: '{project-root}/{bmad_folder}/bmb/workflows/create-module'
+---
+
+# Create Module Workflow
+
+**Goal:** To guide users through creating complete, installable BMAD modules with proper structure, agents, workflow plans, and documentation.
+
+**Your Role:** In addition to your name, communication_style, and persona, you are also a Module Architect and BMAD Systems Specialist collaborating with module creators. This is a partnership, not a client-vendor relationship. You bring expertise in BMAD architecture, component design, and installation patterns, while the user brings their domain knowledge and specific module requirements. Work together as equals.
+
+## WORKFLOW ARCHITECTURE
+
+### Core Principles
+
+- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
+- **Just-In-Time Loading**: Only 1 current step file will be loaded, read, and executed to completion - 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. Module Configuration Loading
+
+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`, `custom_module_location`
+
+### 2. First Step EXECUTION
+
+Load, read the full file and then execute {installed_path}/steps/step-01-init.md to begin the workflow.

package/src/modules/bmb/workflows/create-workflow/steps/step-01-init.md

@@ -1,6 +1,6 @@
 ---
 name: 'step-01-init'
-description: 'Initialize workflow creation session by detecting continuation state and setting up project'
+description: 'Initialize workflow creation session by gathering project information and setting up unique workflow folder'
 
 # Path Definitions
 workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
@@ -9,24 +9,19 @@ workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
 thisStepFile: '{workflow_path}/steps/step-01-init.md'
 nextStepFile: '{workflow_path}/steps/step-02-gather.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}'
-
-# Task References
-advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
-partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
 
+# Output files for workflow creation process
+targetWorkflowPath: '{custom_stand_alone_location}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
 # Template References
-projectInfoTemplate: '{workflow_path}/templates/project-info.md'
-workflowPlanTemplate: '{workflow_path}/templates/workflow-plan.md'
+# No workflow plan template needed - will create plan file directly
 ---
 
 # Step 1: Workflow Creation Initialization
 
 ## STEP GOAL:
 
-To initialize the workflow creation process by detecting continuation state, understanding project context, and preparing for collaborative workflow design.
+To initialize the workflow creation process by understanding project context, determining a unique workflow name, and preparing for collaborative workflow design.
 
 ## MANDATORY EXECUTION RULES (READ FIRST):
 
@@ -50,7 +45,7 @@ To initialize the workflow creation process by detecting continuation state, und
 - 🎯 Focus ONLY on initialization and project understanding
 - 🚫 FORBIDDEN to start designing workflow steps in this step
 - 💬 Ask questions conversationally to understand context
-- 🚪 DETECT existing workflow state and handle continuation properly
+- 🚪 ENSURE unique workflow naming to avoid conflicts
 
 ## EXECUTION PROTOCOLS:
 
@@ -68,72 +63,66 @@ To initialize the workflow creation process by detecting continuation state, und
 
 ## INITIALIZATION SEQUENCE:
 
-### 1. Check for Existing Workflow Creation
+### 1. Project Discovery
 
-First, check if there's already a workflow folder with the proposed name:
+Welcome the user and understand their needs:
+"Welcome! I'm excited to help you create a new workflow. Let's start by understanding what you want to build."
 
-- Look for folder at `{custom_workflow_location}/{new_workflow_name}/`
-- If exists, check if it contains a workflow.md file
-- If not exists, this is a fresh workflow creation session
+Ask conversationally:
 
-### 2. Handle Continuation (If Workflow Exists)
+- What type of workflow are you looking to create?
+- What problem will this workflow solve?
+- Who will use this workflow?
+- What module will it belong to (bmb, bmm, cis, custom, stand-alone)?
 
-If the workflow folder exists and has been worked on:
+Also, Ask / suggest a workflow name / folder: (kebab-case, e.g., "user-story-generator")
 
-- **STOP here** and continue with step 4 (Welcome Back)
-- Do not proceed with fresh initialization
-- Let step 4 handle the continuation logic
+### 2. Ensure Unique Workflow Name
 
-### 3. Handle Completed Workflow
+After getting the workflow name:
 
-If the workflow folder exists AND is complete:
+**Check for existing workflows:**
 
-- Ask user: "I found an existing workflow '{new_workflow_name}' from [date]. Would you like to:
-  1. Create a new workflow with a different name
-  2. Review or modify the existing workflow"
-- If option 1: Get a new workflow name
-- If option 2: Load step 5 (Review)
+- Look for folder at `{custom_stand_alone_location}/workflows/{new_workflow_name}/`
+- If it exists, inform the user and suggest or get from them a unique name or postfix
 
-### 4. Fresh Workflow Setup (If No Workflow)
+**Example alternatives:**
 
-#### A. Project Discovery
+- Original: "user-story-generator"
+- Alternatives: "user-story-creator", "user-story-generator-2025", "user-story-generator-enhanced"
 
-Welcome the user and understand their needs:
-"Welcome! I'm excited to help you create a new workflow. Let's start by understanding what you want to build."
+**Loop until we have a unique name that doesn't conflict.**
 
-Ask conversationally:
+### 3. Determine Target Location
 
-- What type of workflow are you looking to create?
-- What problem will this workflow solve?
-- Who will use this workflow?
-- What module will it belong to (bmb, bmm, cis, custom, stand-alone)?
-- What would you like to name this workflow folder? (kebab-case, e.g., "user-story-generator")
+Based on the module selection, confirm the target location:
+
+- For bmb module: `{custom_workflow_location}` (defaults to `{bmad_folder}/custom/src/workflows`)
+- For other modules: Check their module.yaml for custom workflow locations
+- Confirm the exact folder path where the workflow will be created
+- Store the confirmed path as `{targetWorkflowPath}`
 
-#### B. Create Workflow Plan Document
+### 4. Create Workflow Plan Document
 
-Create the workflow plan document at `{workflowPlanFile}` using the workflow plan template `{workflowPlanTemplate}`.
-Initialize frontmatter with:
+Create the workflow plan document at `{workflowPlanFile}` with the following initial content:
 
-```yaml
+```markdown
 ---
-workflowName: ''
-targetModule: ''
-workflowType: ''
-flowPattern: ''
-date: [current date]
-user_name: { user_name }
 stepsCompleted: [1]
-lastStep: 'init'
 ---
-```
 
-This plan will capture all requirements and design details before building the actual workflow.
+# Workflow Creation Plan: {new_workflow_name}
 
-### 5. Welcome Message
+## Initial Project Context
 
-"Great! I'm ready to help you create a structured workflow using our step-based architecture. We'll work together to design a workflow that's collaborative, maintainable, and follows best practices."
+- **Module:** [module from user]
+- **Target Location:** {targetWorkflowPath}
+- **Created:** [current date]
+```
+
+This plan will capture all requirements and design details before building the actual workflow.
 
-### 6. Present MENU OPTIONS
+### 5. Present MENU OPTIONS
 
 Display: **Proceeding to requirements gathering...**
 
@@ -145,7 +134,7 @@ Display: **Proceeding to requirements gathering...**
 
 #### Menu Handling Logic:
 
-- After setup completion, immediately load, read entire file, then execute `{workflow_path}/step-02-gather.md` to begin requirements gathering
+- After setup completion and the workflow folder with the workflow plan file created already, only then immediately load, read entire file, and then execute `{workflow_path}/steps/step-02-gather.md` to begin requirements gathering
 
 ---
 

package/src/modules/bmb/workflows/create-workflow/steps/step-02-gather.md

@@ -7,18 +7,16 @@ 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-tools-overview.md'
-workflowFile: '{workflow_path}/workflow.md'
+nextStepFile: '{workflow_path}/steps/step-03-tools-configuration.md'
 # Output files for workflow creation process
-workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
-targetWorkflowPath: '{custom_workflow_location}/{new_workflow_name}'
+targetWorkflowPath: '{custom_stand_alone_location}/workflows/{new_workflow_name}'
+workflowPlanFile: '{targetWorkflowPath}/workflow-plan-{new_workflow_name}.md'
 
 # Task References
 advancedElicitationTask: '{project-root}/{bmad_folder}/core/tasks/advanced-elicitation.xml'
 partyModeWorkflow: '{project-root}/{bmad_folder}/core/workflows/party-mode/workflow.md'
-
 # Template References
-requirementsTemplate: '{workflow_path}/templates/requirements-section.md'
+# No template needed - will append requirements directly to workflow plan
 ---
 
 # Step 2: Requirements Gathering
@@ -156,25 +154,7 @@ Define what the workflow produces:
 - Should outputs be saved automatically?
 - What format should outputs be in?
 
-### 8. Target Location and Module Configuration
-
-Determine where the workflow will be created:
-
-- For bmb module: Workflows go to `{custom_workflow_location}` (defaults to `{bmad_folder}/custom/src/workflows`)
-- For other modules: Check their install-config.yaml for custom workflow locations
-- Confirm the exact folder path where the workflow will be created
-- Ensure the folder name doesn't conflict with existing workflows
-
-### 9. Technical Constraints
-
-Discuss technical requirements:
-
-- Any specific tools or dependencies needed?
-- Does it need to integrate with other systems?
-- Any performance considerations?
-- Should it be standalone or callable by other workflows?
-
-### 10. Success Criteria
+### 8. Success Criteria
 
 Define what makes the workflow successful:
 
@@ -183,13 +163,11 @@ Define what makes the workflow successful:
 - Are there measurable outcomes?
 - What would make a user satisfied with the result?
 
-## STORE REQUIREMENTS:
-
-After collecting all requirements, append them to {workflowPlanFile} using {requirementsTemplate}:
+#### STORE REQUIREMENTS:
 
-This information will be used in the design phase to create the workflow structure.
+After collecting all requirements, append them to {workflowPlanFile} in a format that will be be used later to design in more detail and create the workflow structure.
 
-### 8. Present MENU OPTIONS
+### 9. Present MENU OPTIONS
 
 Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
 
@@ -210,7 +188,7 @@ Display: **Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Conti
 
 ## CRITICAL STEP COMPLETION NOTE
 
-ONLY WHEN C is selected and requirements are stored, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow structure design step.
+ONLY WHEN C is selected and requirements are stored in the output file, will you then load, read entire file, then execute {nextStepFile} to execute and begin workflow structure design step.
 
 ---