bmad-method 6.0.0-alpha.0 → 6.0.0-alpha.10

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

@@ -9,26 +9,30 @@ A BMAD module is a self-contained package of agents, workflows, tasks, and resou
 ### Core Structure
 
 ```
-project-root/
-├── bmad/{module-code}/     # Source code
-│   ├── agents/                    # Agent definitions
-│   ├── workflows/                 # Workflow folders
-│   ├── tasks/                     # Task files
-│   ├── templates/                 # Shared templates
-│   ├── data/                      # Static data
-│   ├── config.yaml                # Module config
-│   └── README.md                  # Documentation
-│
-└── bmad/{module-code}/            # Runtime instance
-    ├── _module-installer/         # Installation files
-    │   ├── install-module-config.yaml
-    │   ├── installer.js          # Optional
-    │   └── assets/               # Install assets
-    ├── config.yaml               # User config
-    ├── agents/                   # Agent overrides
-    ├── workflows/                # Workflow instances
-    └── data/                     # User data
-
+# SOURCE MODULE (in BMAD-METHOD project)
+src/modules/{module-code}/
+├── agents/                        # Agent definitions (.agent.yaml)
+├── workflows/                     # Workflow folders
+├── tasks/                         # Task files
+├── tools/                         # Tool files
+├── templates/                     # Shared templates
+├── data/                          # Static data
+├── _module-installer/             # Installation configuration
+│   ├── install-config.yaml  # Installation questions & config
+│   ├── installer.js              # Optional custom install logic
+│   └── assets/                   # Files to copy during install
+└── README.md                      # Module documentation
+
+# INSTALLED MODULE (in target project)
+{project-root}/{bmad_folder}/{module-code}/
+├── agents/                        # Compiled agent files (.md)
+├── workflows/                     # Workflow instances
+├── tasks/                         # Task files
+├── tools/                         # Tool files
+├── templates/                     # Templates
+├── data/                          # Module data
+├── config.yaml                    # Generated from install-config.yaml
+└── README.md                      # Module documentation
 ```
 
 ## Module Types by Complexity
@@ -132,43 +136,129 @@ Tasks should be used for:
 - Declare dependencies in config.yaml
 - Version compatibility notes
 
-## Installation Infrastructure
+### Workflow Vendoring (Advanced)
 
-### Required: install-module-config.yaml
+For modules that need workflows from other modules but want to remain standalone, use **workflow vendoring**:
+
+**In Agent YAML:**
 
 ```yaml
-module_name: 'Module Name'
-module_code: 'module-code'
+menu:
+  - trigger: command-name
+    workflow: '{project-root}/{bmad_folder}/SOURCE_MODULE/workflows/path/workflow.yaml'
+    workflow-install: '{project-root}/{bmad_folder}/THIS_MODULE/workflows/vendored/workflow.yaml'
+    description: 'Command description'
+```
 
-install_steps:
-  - name: 'Create directories'
-    action: 'mkdir'
-    paths: [...]
+**What Happens:**
 
-  - name: 'Copy files'
-    action: 'copy'
-    mappings: [...]
+- During installation, workflows are copied from `workflow` to `workflow-install` location
+- Vendored workflows get `config_source` updated to reference this module's config
+- Compiled agent only references the `workflow-install` path
+- Module becomes fully standalone - no source module dependency required
 
-  - name: 'Register module'
-    action: 'register'
-```
+**Use Cases:**
+
+- Specialized modules that reuse common workflows with different configs
+- Domain-specific adaptations (e.g., game dev using standard dev workflows)
+- Testing workflows in isolation
+
+**Benefits:**
 
-### Optional: installer.js
+- Module independence (no forced dependencies)
+- Clean namespace (workflows in your module)
+- Config isolation (use your module's settings)
+- Customization ready (modify vendored workflows freely)
 
-For complex installations requiring:
+## Installation Infrastructure
+
+### Required: module-installer/install-config.yaml
 
-- Database setup
-- API configuration
-- System integration
-- Permission management
+This file defines both installation questions AND static configuration values:
+
+```yaml
+# Module metadata
+code: module-code
+name: 'Module Name'
+default_selected: false
+
+# Welcome message during installation
+prompt:
+  - 'Welcome to Module Name!'
+  - 'Brief description here'
+
+# Core values automatically inherited from installer:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+
+# INTERACTIVE fields (ask user during install)
+output_location:
+  prompt: 'Where should module outputs be saved?'
+  default: 'output/module-code'
+  result: '{project-root}/{value}'
+
+feature_level:
+  prompt: 'Which feature set?'
+  default: 'standard'
+  result: '{value}'
+  single-select:
+    - value: 'basic'
+      label: 'Basic - Core features only'
+    - value: 'standard'
+      label: 'Standard - Recommended features'
+    - value: 'advanced'
+      label: 'Advanced - All features'
+
+# STATIC fields (no prompt, just hardcoded values)
+module_version:
+  result: '1.0.0'
+
+data_path:
+  result: '{project-root}/{bmad_folder}/module-code/data'
+```
+
+**Key Points:**
+
+- File is named `install-config.yaml` (NOT install-config.yaml)
+- Supports both interactive prompts and static values
+- `result` field uses placeholders: `{value}`, `{project-root}`, `{directory_name}`
+- Installer generates final `config.yaml` from this template
+
+### Optional: module-installer/installer.js
+
+For complex installations requiring custom logic:
+
+```javascript
+/**
+ * @param {Object} options - Installation options
+ * @param {string} options.projectRoot - Target project directory
+ * @param {Object} options.config - Config from install-config.yaml
+ * @param {Array} options.installedIDEs - IDEs being configured
+ * @param {Object} options.logger - Logger (log, warn, error)
+ * @returns {boolean} - true if successful
+ */
+async function install(options) {
+  // Custom installation logic here
+  // - Database setup
+  // - API configuration
+  // - External downloads
+  // - Integration setup
+
+  return true;
+}
+
+module.exports = { install };
+```
 
-### Optional: External Assets
+### Optional: module-installer/assets/
 
-Files that get copied outside the module:
+Files to copy during installation:
 
-- System configurations
-- User templates
-- Shared resources
+- External configurations
+- Documentation
+- Example files
 - Integration scripts
 
 ## Module Lifecycle

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

@@ -1,47 +1,52 @@
 # Build Module Workflow Configuration
-name: build-module
+name: create-module
 description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
 author: "BMad"
 
 # Critical variables load from config_source
-config_source: "{project-root}/bmad/bmb/config.yaml"
-output_folder: "{config_source}:output_folder"
-src_impact: "{config_source}:src_impact"
+config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
+custom_module_location: "{config_source}:custom_module_location"
 communication_language: "{config_source}:communication_language"
 user_name: "{config_source}:user_name"
-date: system-generated
 
 # Reference guides for module building
 module_structure_guide: "{installed_path}/module-structure.md"
 installer_templates: "{installed_path}/installer-templates/"
-example_modules: "{installed_path}/example-modules.md"
 
 # Use existing build workflows
-agent_builder: "{project-root}/bmad/bmb/workflows/build-agent/workflow.yaml"
-workflow_builder: "{project-root}/bmad/bmb/workflows/build-workflow/workflow.yaml"
-
-# Optional docs that help understand module patterns
-recommended_inputs:
-  - module_brief: "{output_folder}/module-brief-*.md"
-  - brainstorming_results: "{output_folder}/brainstorming-*.md"
-  - bmm_module: "{project-root}/bmad/bmm/"
-  - cis_module: "{project-root}/bmad/cis/"
-  - existing_agents: "{project-root}/bmad/*/agents/"
-  - existing_workflows: "{project-root}/bmad/*/workflows/"
+agent_builder: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/workflow.yaml"
+workflow_builder: "{project-root}/{bmad_folder}/bmb/workflows/create-workflow/workflow.yaml"
+brainstorming_workflow: "{project-root}/{bmad_folder}/core/workflows/brainstorming/workflow.yaml"
+brainstorming_context: "{installed_path}/brainstorm-context.md"
+
+# Reference examples - for learning patterns
+bmm_module_dir: "{project-root}/{bmad_folder}/bmm/"
+cis_module_dir: "{project-root}/{bmad_folder}/cis/"
+existing_agents_dir: "{project-root}/{bmad_folder}/*/agents/"
+existing_workflows_dir: "{project-root}/{bmad_folder}/*/workflows/"
+
+# Optional user inputs - discovered if they exist
+input_file_patterns:
+  module_brief:
+    description: "Module brief with vision and requirements (optional)"
+    whole: "{output_folder}/module-brief-*.md"
+    load_strategy: "FULL_LOAD"
+  brainstorming:
+    description: "Brainstorming session outputs (optional)"
+    whole: "{output_folder}/brainstorming-*.md"
+    load_strategy: "FULL_LOAD"
 
 # Module path and component files
-installed_path: "{project-root}/bmad/bmb/workflows/build-module"
+installed_path: "{project-root}/{bmad_folder}/bmb/workflows/create-module"
 template: false # This is an interactive scaffolding workflow
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 
 # Output configuration - creates entire module structure
-# If src_impact=true: Save to src/modules/{{module_code}}
-# If src_impact=false: Save to output_folder/{{module_code}}
-default_output_folder: "{output_folder}/{{module_code}}"
-src_output_folder: "{project-root}/src/modules/{{module_code}}"
-installer_output_folder: "{output_folder}/{{module_code}}"
-src_installer_output_folder: "{project-root}/src/modules/{{module_code}}"
-
-# No special tools required for module building
-required_tools: []
+# Save to custom_module_location/{{module_code}}
+installer_output_folder: "{custom_module_location}/{{module_code}}"
+
+standalone: true
+
+# Web bundle configuration
+web_bundle: false # BMB workflows run locally in BMAD-METHOD project

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

@@ -19,7 +19,7 @@ The Build Workflow is an interactive workflow builder that guides you through cr
 ### Basic Invocation
 
 ```bash
-workflow build-workflow
+workflow create-workflow
 ```
 
 ### Through BMad Builder Agent
@@ -42,7 +42,7 @@ workflow build-workflow
 ### Files Included
 
 ```
-build-workflow/
+create-workflow/
 ├── workflow.yaml                  # Configuration and metadata
 ├── instructions.md                # Step-by-step execution guide
 ├── checklist.md                   # Validation criteria
@@ -56,6 +56,67 @@ build-workflow/
     └── README.md
 ```
 
+## Understanding Instruction Styles
+
+One of the most important decisions when creating a workflow is choosing the **instruction style** - how the workflow guides the AI's interaction with users.
+
+### Intent-Based vs Prescriptive Instructions
+
+**Intent-Based (Recommended for most workflows)**
+
+Guides the LLM with goals and principles, allowing natural conversation adaptation.
+
+- **More flexible and conversational** - AI adapts questions to context
+- **Better for complex discovery** - Requirements gathering, creative exploration
+- **Quality over consistency** - Focus on deep understanding
+- **Example**: `<action>Guide user to define their target audience with specific demographics and needs</action>`
+
+**Best for:**
+
+- Complex discovery processes (user research, requirements)
+- Creative brainstorming and ideation
+- Iterative refinement workflows
+- When adaptation to context matters
+- Workflows requiring nuanced understanding
+
+**Prescriptive**
+
+Provides exact wording for questions and structured options.
+
+- **More controlled and predictable** - Same questions every time
+- **Better for simple data collection** - Platform choices, yes/no decisions
+- **Consistency over quality** - Standardized execution
+- **Example**: `<ask>What is your target platform? Choose: PC, Console, Mobile, Web</ask>`
+
+**Best for:**
+
+- Simple data collection (platform, format, binary choices)
+- Compliance verification and standards
+- Configuration with finite options
+- Quick setup wizards
+- When consistency is critical
+
+### Best Practice: Mix Both Styles
+
+The most effective workflows use **both styles strategically**:
+
+```xml
+<!-- Intent-based workflow with prescriptive moments -->
+<step n="1" goal="Understand user vision">
+  <action>Explore the user's vision, uncovering creative intent and target experience</action>
+</step>
+
+<step n="2" goal="Capture basic metadata">
+  <ask>What is your target platform? Choose: PC, Console, Mobile, Web</ask>
+</step>
+
+<step n="3" goal="Deep dive into details">
+  <action>Guide user to articulate their core approach and unique aspects</action>
+</step>
+```
+
+**During workflow creation**, you'll be asked to choose a **primary style preference** - this sets the default approach, but you can (and should) use the other style when it makes more sense for specific steps.
+
 ## Workflow Process
 
 ### Phase 0: Optional Brainstorming (Step -1)
@@ -87,7 +148,7 @@ The brainstorming phase invokes the CIS brainstorming workflow to:
 - Generate validation checklist
 - Create supporting data files (optional)
 
-### Phase 3: Documentation & Validation (Steps 9-11)
+### Phase 3: Documentation and Validation (Steps 9-11)
 
 - Create comprehensive README.md (MANDATORY)
 - Test and validate workflow structure
@@ -98,7 +159,7 @@ The brainstorming phase invokes the CIS brainstorming workflow to:
 ### Generated Workflow Folder
 
 Creates a complete workflow folder at:
-`{project-root}/bmad/{{target_module}}/workflows/{{workflow_name}}/`
+`{project-root}/{bmad_folder}/{{target_module}}/workflows/{{workflow_name}}/`
 
 ### Files Created
 
@@ -142,7 +203,7 @@ For document workflows, the README documents:
 
 ### Creative Workflow Design
 
-The build-workflow now supports a **seamless transition from creative ideation to structured implementation**:
+The create-workflow now supports a **seamless transition from creative ideation to structured implementation**:
 
 - **"I need a workflow for something..."** → Start with brainstorming to explore possibilities
 - **Brainstorm** → Generate multiple approaches and clarify requirements
@@ -197,7 +258,7 @@ To modify this workflow:
   - Enhanced validation for documentation
   - Improved Step 10 with detailed README requirements
 
-- **v5.0.0** - Initial BMAD Core v6 compatible version
+- **v6.0.0** - Initial BMAD Core v6 compatible version
   - Template-based workflow generation
   - Convention enforcement
   - Validation checklist support
@@ -206,9 +267,9 @@ To modify this workflow:
 
 For issues or questions:
 
-- Review `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
-- Check existing workflows in `/bmad/bmm/workflows/` for examples
-- Validate against `/bmad/bmb/workflows/build-workflow/checklist.md`
+- Review `/{bmad_folder}/bmb/workflows/create-workflow/workflow-creation-guide.md`
+- Check existing workflows in `/{bmad_folder}/bmm/workflows/` for examples
+- Validate against `/{bmad_folder}/bmb/workflows/create-workflow/checklist.md`
 - Consult BMAD Method v6 documentation
 
 ---

package/src/modules/bmb/workflows/create-workflow/brainstorm-context.md

@@ -20,7 +20,7 @@ A workflow is a structured process that provides:
 
 Explore and define:
 
-### 1. Problem & Purpose
+### 1. Problem and Purpose
 
 - **What task needs structure?** (specific process users struggle with)
 - **Why is this hard manually?** (complexity, inconsistency, missing steps)
@@ -35,14 +35,14 @@ Explore and define:
 - **What's optional vs required?** (flexibility points)
 - **What checkpoints matter?** (validation, review, approval points)
 
-### 3. Inputs & Outputs
+### 3. Inputs and Outputs
 
 - **What inputs are needed?** (documents, data, user answers)
 - **What outputs are generated?** (documents, code, configurations)
 - **What format?** (markdown, XML, YAML, actions)
 - **What quality criteria?** (how to validate success)
 
-### 4. Workflow Type & Style
+### 4. Workflow Type and Style
 
 - **Document Workflow?** Creates structured documents (PRDs, specs, reports)
 - **Action Workflow?** Performs operations (refactoring, deployment, analysis)
@@ -78,7 +78,7 @@ A great BMAD workflow should be:
 4. **Checkpoints** (where to pause for approval)
 5. **Variables** (data passed between steps)
 
-### Quality & Validation
+### Quality and Validation
 
 1. **Success criteria** (what defines "done")
 2. **Validation checklist** (measurable quality checks)

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

@@ -57,12 +57,34 @@
 - [ ] Output location is writable
 - [ ] Dependencies (if any) are available
 
+## Web Bundle Configuration (if applicable)
+
+- [ ] web_bundle section present if needed
+- [ ] Name, description, author copied from main config
+- [ ] All file paths converted to {bmad_folder}/-relative format
+- [ ] NO {config_source} variables in web bundle
+- [ ] NO {project-root} prefixes in paths
+- [ ] Instructions path listed correctly
+- [ ] Validation/checklist path listed correctly
+- [ ] Template path listed (if document workflow)
+- [ ] All data files referenced in instructions are listed
+- [ ] All sub-workflows are included
+- [ ] web_bundle_files array is complete:
+  - [ ] Instructions.md included
+  - [ ] Checklist.md included
+  - [ ] Template.md included (if applicable)
+  - [ ] All CSV/JSON data files included
+  - [ ] All referenced templates included
+  - [ ] All sub-workflow files included
+- [ ] No external dependencies outside bundle
+
 ## Documentation
 
 - [ ] README created (if requested)
 - [ ] Usage instructions clear
 - [ ] Example command provided
 - [ ] Special requirements noted
+- [ ] Web bundle deployment noted (if applicable)
 
 ## Final Validation