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

package/src/modules/bmb/workflows/module/data/module-yaml-conventions.md

@@ -0,0 +1,392 @@
+# module.yaml Conventions
+
+**Purpose:** Defines how module.yaml works, including variables, templates, and how they provide context to agents and workflows.
+
+---
+
+## Overview
+
+`module.yaml` is the configuration file for a BMAD module. It:
+- Defines module metadata (code, name, description)
+- Collects user input via prompts during installation
+- Makes those inputs available to agents and workflows as variables
+- Specifies which module should be selected by default
+
+---
+
+## Frontmatter Fields
+
+### Required Fields
+
+```yaml
+code: {module-code}              # kebab-case identifier
+name: "Display Name"             # Human-readable name
+header: "Brief description"      # One-line summary
+subheader: "Additional context"  # More detail
+default_selected: false          # Auto-select on install?
+```
+
+### `default_selected` Guidelines
+
+| Module Type | default_selected | Example |
+|-------------|------------------|---------|
+| Core/Primary | `true` | BMM (agile software delivery) |
+| Specialized | `false` | CIS (creative innovation), BMGD (game dev) |
+| Experimental | `false` | New modules in development |
+
+---
+
+## Variables System
+
+### Core Config Variables (Always Available)
+
+These variables are automatically available to ALL modules:
+
+```yaml
+# Variables from Core Config inserted:
+## user_name                  # User's name
+## communication_language     # Preferred language
+## document_output_language    # Output document language
+## output_folder             # Default output location
+```
+
+No need to define these — they're injected automatically.
+
+---
+
+### Custom Variables
+
+Define custom variables for user input:
+
+```yaml
+variable_name:
+  prompt: "Question to ask the user?"
+  default: "{default_value}"
+  result: "{template_for_final_value}"
+```
+
+**Example:**
+
+```yaml
+project_name:
+  prompt: "What is the title of your project?"
+  default: "{directory_name}"
+  result: "{value}"
+```
+
+### Variable Templates
+
+In `prompt` and `result`, you can use templates:
+
+| Template | Expands To |
+|----------|------------|
+| `{value}` | The user's input |
+| `{directory_name}` | Current directory name |
+| `{output_folder}` | Output folder from core config |
+| `{project-root}` | Project root path |
+| `{variable_name}` | Another variable's value |
+
+---
+
+## Variable Types
+
+### 1. Simple Text Input
+
+```yaml
+project_name:
+  prompt: "What is the title of your project?"
+  default: "{directory_name}"
+  result: "{value}"
+```
+
+---
+
+### 2. Boolean/Flag
+
+```yaml
+enable_feature:
+  prompt: "Enable this feature?"
+  default: false
+  result: "{value}"
+```
+
+---
+
+### 3. Single Select
+
+```yaml
+skill_level:
+  prompt: "What is your experience level?"
+  default: "intermediate"
+  result: "{value}"
+  single-select:
+    - value: "beginner"
+      label: "Beginner - Explains concepts clearly"
+    - value: "intermediate"
+      label: "Intermediate - Balanced approach"
+    - value: "expert"
+      label: "Expert - Direct and technical"
+```
+
+---
+
+### 4. Multi Select
+
+```yaml
+platforms:
+  prompt: "Which platforms do you need?"
+  default: ["unity", "unreal"]
+  result: "{value}"
+  multi-select:
+    - value: "unity"
+      label: "Unity"
+    - value: "unreal"
+      label: "Unreal Engine"
+    - value: "godot"
+      label: "Godot"
+```
+
+---
+
+### 5. Multi-Line Prompt
+
+```yaml
+complex_variable:
+  prompt:
+    - "First question?"
+    - "Second context?"
+    - "Third detail?"
+  default: "default_value"
+  result: "{value}"
+```
+
+---
+
+### 6. Required Variable
+
+```yaml
+critical_variable:
+  prompt: "Required information:"
+  required: true
+  result: "{value}"
+```
+
+---
+
+### 7. Path Variable
+
+```yaml
+artifacts_folder:
+  prompt: "Where should artifacts be stored?"
+  default: "{output_folder}/artifacts"
+  result: "{project-root}/{value}"
+```
+
+---
+
+## Variable Inheritance / Aliasing
+
+Create an alias for another variable:
+
+```yaml
+primary_artifacts:
+  prompt: "Where should primary artifacts be stored?"
+  default: "{output_folder}/artifacts"
+  result: "{project-root}/{value}"
+
+# Alias for workflow compatibility
+sprint_artifacts:
+  inherit: "primary_artifacts"
+```
+
+Now `sprint_artifacts` and `primary_artifacts` reference the same value.
+
+---
+
+## How Variables Become Available
+
+### To Agents
+
+After installation, variables are available in agent frontmatter/context:
+
+```yaml
+# In agent.agent.yaml or workflow execution
+{variable_name}  # Expands to the user's configured value
+```
+
+**Example:** If the user configured `project_name: "MyApp"`, agents can reference `{project_name}` and it will expand to `"MyApp"`.
+
+### To Workflows
+
+Workflows can reference module variables in their step files:
+
+```yaml
+---
+outputFile: '{implementation_artifacts}/my-output.md'
+---
+```
+
+This expands the `implementation_artifacts` variable from module.yaml.
+
+---
+
+## Real-World Examples
+
+### BMM (BMad Method) — Complex Configuration
+
+```yaml
+code: bmm
+name: "BMM: BMad Method Agile-AI Driven-Development"
+header: "BMad Method™: Breakthrough Method of Agile-Ai Driven-Dev"
+subheader: "Agent and Workflow Configuration for this module"
+default_selected: true
+
+# Variables from Core Config inserted:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+
+project_name:
+  prompt: "What is the title of your project?"
+  default: "{directory_name}"
+  result: "{value}"
+
+user_skill_level:
+  prompt:
+    - "What is your development experience level?"
+    - "This affects how agents explain concepts."
+  default: "intermediate"
+  result: "{value}"
+  single-select:
+    - value: "beginner"
+      label: "Beginner - Explain concepts clearly"
+    - value: "intermediate"
+      label: "Intermediate - Balanced approach"
+    - value: "expert"
+      label: "Expert - Direct and technical"
+
+planning_artifacts:
+  prompt: "Where should planning artifacts be stored?"
+  default: "{output_folder}/planning-artifacts"
+  result: "{project-root}/{value}"
+
+implementation_artifacts:
+  prompt: "Where should implementation artifacts be stored?"
+  default: "{output_folder}/implementation-artifacts"
+  result: "{project-root}/{value}"
+
+project_knowledge:
+  prompt: "Where should project knowledge be stored?"
+  default: "docs"
+  result: "{project-root}/{value}"
+
+tea_use_mcp_enhancements:
+  prompt: "Enable MCP enhancements in Test Architect?"
+  default: false
+  result: "{value}"
+```
+
+---
+
+### CIS (Creative Innovation Suite) — Minimal Configuration
+
+```yaml
+code: cis
+name: "CIS: Creative Innovation Suite"
+header: "Creative Innovation Suite (CIS) Module"
+subheader: "No custom configuration - uses Core settings only"
+default_selected: false
+
+# Variables from Core Config inserted:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+```
+
+Some modules don't need custom variables — core config is enough!
+
+---
+
+### BMGD (Game Development) — Multi-Select Example
+
+```yaml
+code: bmgd
+name: "BMGD: BMad Game Development"
+header: "BMad Game Development Module"
+subheader: "Configure game development settings"
+default_selected: false
+
+project_name:
+  prompt: "What is the name of your game project?"
+  default: "{directory_name}"
+  result: "{value}"
+
+primary_platform:
+  prompt: "Which game engine do you use?"
+  default: ["unity", "unreal"]
+  required: true
+  result: "{value}"
+  multi-select:
+    - value: "unity"
+      label: "Unity"
+    - value: "unreal"
+      label: "Unreal Engine"
+    - value: "godot"
+      label: "Godot"
+    - value: "other"
+      label: "Custom / Other"
+```
+
+---
+
+## Best Practices
+
+### DO:
+- Keep prompts clear and concise
+- Provide sensible defaults
+- Use `result: "{project-root}/{value}"` for paths
+- Use single/multi-select for structured choices
+- Group related variables logically
+
+### DON'T:
+- Overwhelm users with too many questions
+- Ask for information that could be inferred
+- Use technical jargon in prompts
+- Create variables that are never used
+
+---
+
+## Variable Naming
+
+- **kebab-case** (e.g., `planning_artifacts`, `user_skill_level`)
+- Descriptive but concise
+- Avoid conflicts with core variables
+
+---
+
+## Testing Your module.yaml
+
+After creating module.yaml, test it:
+
+1. Run `bmad install` in a test project
+2. Verify prompts appear correctly
+3. Check that variables expand in agents/workflows
+4. Test default values
+5. Validate path templates resolve correctly
+
+---
+
+## Quick Reference
+
+| Pattern | Use Case |
+|---------|----------|
+| Simple text input | Names, titles, descriptions |
+| Boolean/Flag | Enable/disable features |
+| Single select | Experience levels, categories |
+| Multi select | Platforms, frameworks, options |
+| Multi-line prompt | Complex questions needing context |
+| Required | Must-have information |
+| Path variable | Directory locations |
+| Inherit/Alias | Compatibility, references |

package/src/modules/bmb/workflows/module/steps-b/step-01-welcome.md

@@ -0,0 +1,147 @@
+---
+name: 'step-01-welcome'
+description: 'Welcome user, select mode (Interactive/Express/YOLO), gather initial idea'
+
+nextStepFile: './step-02-spark.md'
+briefTemplateFile: '../templates/brief-template.md'
+moduleStandardsFile: '../data/module-standards.md'
+advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md'
+---
+
+# Step 1: Welcome & Mode Selection
+
+## STEP GOAL:
+
+Welcome the user to the Module Brief workflow, select the collaboration mode (Interactive/Express/YOLO), and gather their initial module idea.
+
+## 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 with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ Speak in `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are the **Module Architect** — creative, inspiring, helping users discover amazing module ideas
+- ✅ This is explorative and collaborative — not a template-filling exercise
+- ✅ Help users clarify and expand their vision
+
+### Step-Specific Rules:
+
+- 🎯 Set the creative tone — this is about discovering possibilities
+- 🚫 FORBIDDEN to jump straight to technical details
+- 💬 Ask questions that spark imagination
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Follow the MANDATORY SEQUENCE exactly
+- 💾 No output file yet — gathering initial context
+- 📖 Load next step when user selects 'C'
+
+## CONTEXT BOUNDARIES:
+
+- Available: module standards, brief template
+- Focus: Initial idea gathering and mode selection
+- No existing brief — this is a fresh start
+
+---
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise.
+
+### 1. Welcome with Enthusiasm
+
+"**Welcome to the Module Brief workflow!** 🚀
+
+I'm here to help you create an amazing BMAD module. We'll explore your vision, design the agents and workflows, and create a comprehensive brief that will guide the module's creation.
+
+Modules are powerful — they package agents, workflows, and configuration into a cohesive capability. Let's make something great!"
+
+### 2. Select Collaboration Mode
+
+"**How would you like to work?**"
+
+- **[I]nteractive** — Deep collaboration, we'll explore each section together thoroughly
+- **[E]xpress** — Faster pace, targeted questions to get to a solid brief quickly
+- **[Y]OLO** — I'll generate a complete brief from minimal input (you can refine later)
+
+**Store the selected mode. This affects how we proceed through subsequent steps.**
+
+### 3. Gather the Initial Idea
+
+"**Tell me about your module idea.**"
+
+Encourage them to share:
+- What problem does it solve?
+- Who would use it?
+- What excites you about it?
+
+**If they're stuck**, offer creative prompts:
+- "What domain do you work in? What tasks feel repetitive or could be AI-powered?"
+- "Imagine you had a team of AI experts at your disposal — what would you ask them to build?"
+- "Is there a module you wish existed?"
+
+**Capture their initial idea.** We'll explore and expand it in the next steps.
+
+### 4. Preview the Journey Ahead
+
+"**Here's where we're going together:**"
+
+1. Spark — Explore and clarify your idea
+2. Module Type — Standalone, Extension, or Global?
+3. Vision — What would make this extraordinary?
+4. Identity — Name, code, personality
+5. Users — Who is this for?
+6. Value — What makes it special?
+7. Agents — Who's on your team?
+8. Workflows — What can we do?
+9. Tools — MCP tools, integrations?
+10. Scenarios — How will people use it?
+11. Creative — Easter eggs, lore, magic ✨
+12. Review — Read through together
+13. Finalize — Your complete brief
+
+"**This is about discovery and creativity. We're not filling out forms — we're designing something amazing together.**"
+
+### 5. Present MENU OPTIONS
+
+**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- ONLY proceed to next step when user selects 'C'
+- User can chat or ask questions — always respond and redisplay menu
+
+#### Menu Handling Logic:
+
+- IF A: Execute `{advancedElicitationTask}` for deeper idea exploration, then redisplay menu
+- IF P: Execute `{partyModeWorkflow}` for creative brainstorming, then redisplay menu
+- IF C: Store the mode and initial idea, then load `{nextStepFile}`
+- IF Any other: Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- User feels welcomed and inspired
+- Collaboration mode selected
+- Initial idea captured
+- User understands the journey ahead
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping to technical details prematurely
+- Not capturing the initial idea
+- Not setting the creative tone
+- Rushing through mode selection
+
+**Master Rule:** This step sets the tone for the entire brief — make it inspiring and collaborative.

package/src/modules/bmb/workflows/module/steps-b/step-02-spark.md

@@ -0,0 +1,140 @@
+---
+name: 'step-02-spark'
+description: 'Ignite the idea, explore problem space, what excites them'
+
+nextStepFile: './step-03-module-type.md'
+moduleStandardsFile: '../data/module-standards.md'
+advancedElicitationTask: '../../../../core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '../../../../core/workflows/party-mode/workflow.md'
+---
+
+# Step 2: Spark
+
+## STEP GOAL:
+
+Ignite and explore the user's idea — dig into the problem space, understand what excites them, and help clarify the vision.
+
+## 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 with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ Speak in `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are the **Module Architect** — curious, explorative, helping ideas grow
+- ✅ Ask open-ended questions that reveal depth
+- ✅ Listen more than you speak
+
+### Step-Specific Rules:
+
+- 🎯 This is about understanding the problem space, not solving it yet
+- 🚫 FORBIDDEN to jump to implementation
+- 💬 Ask "why" and "what if" questions
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Follow the MANDATORY SEQUENCE exactly
+- 📖 Reference module standards to understand types
+- 📖 Load next step when user selects 'C'
+
+---
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly.
+
+### 1. Connect to Their Idea
+
+"**Let's explore your idea together.**"
+
+Reference what they shared in step 1:
+- "You mentioned {their idea} — I love that direction."
+- "Tell me more about the problem you're solving."
+
+### 2. Explore the Problem Space
+
+Ask questions to deepen understanding:
+
+**"What problem does this module solve?"**
+
+- Who feels this problem right now?
+- What do they currently do without this module?
+- What would change if this existed?
+
+**"What excites you about this idea?"**
+
+- Why THIS module? Why now?
+- What's the vision — the dream outcome?
+- If this module succeeds wildly, what does that look like?
+
+### 3. Identify the Users
+
+**"Who is this module for?"**
+
+Help them think about:
+- Primary users — who will use this most?
+- Secondary users — who else benefits?
+- What do these users care about?
+
+### 4. Adjust for Mode
+
+**IF mode == Interactive:**
+- Deep exploration, multiple rounds of questions
+- Use Advanced Elicitation if they want to dig deeper
+
+**IF mode == Express:**
+- Targeted questions, get the key insights quickly
+- 2-3 rounds max
+
+**IF mode == YOLO:**
+- Brief clarification, acknowledge what you have
+- Move quickly to next step
+
+### 5. Capture Insights
+
+Summarize what you've learned:
+- "So the core problem is {summary}"
+- "The primary users are {users}"
+- "What excites you most is {excitement}"
+
+"**Does this capture your vision? Anything to add or refine?**"
+
+### 6. Present MENU OPTIONS
+
+**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input
+- ONLY proceed to next step when user selects 'C'
+
+#### Menu Handling Logic:
+
+- IF A: Execute `{advancedElicitationTask}` for deeper exploration
+- IF P: Execute `{partyModeWorkflow}` for creative ideation
+- IF C: Load `{nextStepFile}`
+- IF Any other: Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Problem space clearly understood
+- User excitement identified
+- Target users clarified
+- Vision feels solid
+
+### ❌ SYSTEM FAILURE:
+
+- Skipping to solutions too quickly
+- Not understanding the problem
+- Not capturing what excites them
+
+**Master Rule:** Understand before you build. This step is about clarity, not solutions.