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

package/src/modules/bmb/workflows/module/steps-v/step-08-report.md

@@ -0,0 +1,197 @@
+---
+name: 'step-08-report'
+description: 'Generate final validation report'
+
+validationReportOutput: '{validation_report_output}'
+agentValidationWorkflow: '{project-root}/_bmad/bmb/workflows/agent/steps-v/step-01-validate.md'
+workflowValidationWorkflow: '{project-root}/_bmad/bmb/workflows/workflow/steps-v/step-01-validate.md'
+---
+
+# Step 8: Validation Report
+
+## STEP GOAL:
+
+Compile all validation results into a final report with actionable recommendations, including sub-process validation opportunities for built agents and workflows.
+
+## MANDATORY EXECUTION RULES:
+
+### Universal Rules:
+- 📖 CRITICAL: Read the complete step file before taking any action
+- ✅ Speak in `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are the **Quality Assurance** — reporting results
+- ✅ Clear, actionable feedback
+- ✅ Sub-process validation for built components
+
+---
+
+## MANDATORY SEQUENCE
+
+### 1. Compile Overall Status
+
+Review all validation sections and determine overall status:
+
+**PASS:** All checks passed, ready to proceed
+**WARNINGS:** Minor issues found, can proceed with fixes
+**FAIL:** Critical issues found, must fix before proceeding
+
+### 2. Generate Summary
+
+Add to `{validationReportOutput}`:
+
+```markdown
+---
+
+## Overall Summary
+
+**Status:** {PASS/WARNINGS/FAIL}
+
+**Breakdown:**
+- File Structure: {status}
+- module.yaml: {status}
+- Agent Specs: {status} ({built_count} built, {spec_count} specs)
+- Workflow Specs: {status} ({built_count} built, {spec_count} specs)
+- Documentation: {status}
+- Installation Readiness: {status}
+
+---
+
+## Component Status
+
+### Agents
+- **Built Agents:** {count} — {list}
+- **Spec Agents:** {count} — {list}
+
+### Workflows
+- **Built Workflows:** {count} — {list}
+- **Spec Workflows:** {count} — {list}
+
+---
+
+## Recommendations
+
+{priority-listed-recommendations}
+
+### Priority 1 - Critical (must fix)
+
+{critical_issues}
+
+### Priority 2 - High (should fix)
+
+{high_priority_issues}
+
+### Priority 3 - Medium (nice to have)
+
+{medium_priority_issues}
+
+---
+
+## Sub-Process Validation
+
+{if built_agents_exist}
+### Built Agent Deep Validation
+
+The following built agents can be validated in detail using the agent validation workflow:
+
+{for each built_agent}
+- **{agent_name}** — Use `{agentValidationWorkflow}`
+
+**Recommendation:** Run agent validation workflow on each built agent to verify:
+- Frontmatter completeness
+- Persona quality
+- Menu structure compliance
+- Sidecar validation
+
+**After fixing any module-level issues, I can spawn sub-processes to validate each built agent in parallel.**
+{endif}
+
+{if built_workflows_exist}
+### Built Workflow Deep Validation
+
+The following built workflows can be validated in detail using the workflow validation workflow:
+
+{for each built_workflow}
+- **{workflow_name}** — Use `{workflowValidationWorkflow}`
+
+**Recommendation:** Run workflow validation workflow on each built workflow to verify:
+- Step file compliance
+- Tri-modal structure (steps-c/steps-e/steps-v/)
+- Frontmatter completeness
+- Size limits compliance
+
+**After fixing any module-level issues, I can spawn sub-processes to validate each built workflow in parallel.**
+{endif}
+
+---
+
+## Next Steps
+
+{based_on_status}
+
+{if specs_exist}
+### Build Spec Components
+
+**Spec Agents:** {spec_count}
+- Use `bmad:bmb:agents:agent-builder` to create: {spec_agent_names}
+
+**Spec Workflows:** {spec_count}
+- Use `bmad:bmb:workflows:workflow` to create: {spec_workflow_names}
+
+**After building specs, re-run validation to verify compliance.**
+{endif}
+
+---
+
+**Validation Completed:** {timestamp}
+```
+
+### 3. Present Report
+
+"**✓ Validation complete!**"
+
+**Overall Status:** {overall_status}
+
+**Report saved to:** `{validationReportOutput}`
+
+{if built_components_exist}
+"**Built components found:**"
+- Built Agents: {count}
+- Built Workflows: {count}
+
+"**These can be validated in depth via sub-process.**"
+{endif}
+
+### 4. Offer Next Actions
+
+"**What would you like to do?**"
+
+- **[R]ead report** — Show the full validation report
+- **[S]ub-process validation** — Run deep validation on built agents/workflows
+- **[F]ix issues** — Edit mode to fix identified problems
+- **[D]one** — Complete validation
+
+### 5. Menu Handling
+
+- IF R: Display the full report
+- IF S:
+  - {if built_components_exist}
+  - Offer to run agent validation on built agents
+  - Offer to run workflow validation on built workflows
+  - Can run in parallel for efficiency
+  - {else}
+  - "No built components found for sub-process validation."
+  - {endif}
+- IF F: Offer to load Edit mode
+- IF D: Complete validation session
+
+---
+
+## Success Metrics
+
+✅ Overall status determined
+✅ Complete report generated
+✅ Actionable recommendations provided
+✅ Sub-process validation opportunities identified
+✅ Next steps offered

package/src/modules/bmb/workflows/module/templates/brief-template.md

@@ -0,0 +1,154 @@
+# Module Brief: {module_code}
+
+**Date:** {date}
+**Author:** {user_name}
+**Module Code:** {module_code}
+**Module Type:** {module_type}
+**Status:** Ready for Development
+
+---
+
+## Executive Summary
+
+{module_vision}
+
+**Module Category:** {module_category}
+**Target Users:** {target_users}
+**Complexity Level:** {complexity_level}
+
+---
+
+## Module Identity
+
+### Module Code & Name
+
+- **Code:** `{module_code}`
+- **Name:** `{module_name}`
+
+### Core Concept
+
+{module_identity}
+
+### Personality Theme
+
+{personality_theme}
+
+---
+
+## Module Type
+
+**Type:** {module_type}
+
+{module_type_explanation}
+
+---
+
+## Unique Value Proposition
+
+**What makes this module special:**
+
+{unique_value_proposition}
+
+**Why users would choose this module:**
+
+{value_proposition_details}
+
+---
+
+## User Scenarios
+
+### Target Users
+
+{target_users}
+
+### Primary Use Case
+
+{primary_use_case}
+
+### User Journey
+
+{user_journey}
+
+---
+
+## Agent Architecture
+
+### Agent Count Strategy
+
+{agent_count_strategy}
+
+### Agent Roster
+
+| Agent | Name | Role | Expertise |
+|-------|------|------|-----------|
+{agent_roster_table}
+
+### Agent Interaction Model
+
+{agent_interaction_model}
+
+### Agent Communication Style
+
+{agent_communication_style}
+
+---
+
+## Workflow Ecosystem
+
+### Core Workflows (Essential)
+
+{core_workflows}
+
+### Feature Workflows (Specialized)
+
+{feature_workflows}
+
+### Utility Workflows (Support)
+
+{utility_workflows}
+
+---
+
+## Tools & Integrations
+
+### MCP Tools
+
+{mcp_tools}
+
+### External Services
+
+{external_services}
+
+### Integrations with Other Modules
+
+{module_integrations}
+
+---
+
+## Creative Features
+
+### Personality & Theming
+
+{creative_personality}
+
+### Easter Eggs & Delighters
+
+{easter_eggs}
+
+### Module Lore
+
+{module_lore}
+
+---
+
+## Next Steps
+
+1. **Review this brief** — Ensure the vision is clear
+2. **Run create-module workflow** — Build the module structure
+3. **Create agents** — Use create-agent workflow for each agent
+4. **Create workflows** — Use create-workflow workflow for each workflow
+5. **Test module** — Install and verify functionality
+
+---
+
+_brief created on {date} by {user_name} using the BMAD Module workflow_

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

@@ -0,0 +1,96 @@
+# Workflow Specification: {workflow_name}
+
+**Module:** {module_code}
+**Status:** Placeholder — To be created via create-workflow workflow
+**Created:** {date}
+
+---
+
+## Workflow Overview
+
+**Goal:** {workflow_goal}
+
+**Description:** {workflow_description}
+
+**Workflow Type:** {workflow_type}
+
+---
+
+## Workflow Structure
+
+### Entry Point
+
+```yaml
+---
+name: {workflow_name}
+description: {workflow_description}
+web_bundle: true
+installed_path: '{project-root}/_bmad/{module_code}/workflows/{workflow_folder_name}'
+---
+```
+
+### Mode
+
+- [ ] Create-only (steps-c/)
+- [ ] Tri-modal (steps-c/, steps-e/, steps-v/)
+
+---
+
+## Planned Steps
+
+| Step | Name | Goal |
+|------|------|------|
+{workflow_steps_table}
+
+---
+
+## Workflow Inputs
+
+### Required Inputs
+
+{required_inputs}
+
+### Optional Inputs
+
+{optional_inputs}
+
+---
+
+## Workflow Outputs
+
+### Output Format
+
+- [ ] Document-producing
+- [ ] Non-document
+
+### Output Files
+
+{output_files}
+
+---
+
+## Agent Integration
+
+### Primary Agent
+
+{primary_agent}
+
+### Other Agents
+
+{other_agents}
+
+---
+
+## Implementation Notes
+
+**Use the create-workflow workflow to build this workflow.**
+
+Inputs needed:
+- Workflow name and description
+- Step structure and sequence
+- Input/output specifications
+- Agent associations
+
+---
+
+_Spec created on {date} via BMAD Module workflow_

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

@@ -0,0 +1,100 @@
+---
+name: module
+description: Quad-modal workflow for creating BMAD modules (Brief + Create + Edit + Validate)
+web_bundle: true
+installed_path: '{project-root}/_bmad/bmb/workflows/module'
+---
+
+# Module Workflow
+
+The module workflow guides users through creating complete, installable BMAD modules through a quad-modal process: **Brief → Create → Edit → Validate**.
+
+## What This Workflow Does
+
+- **Brief mode** — Collaboratively explore and design your module vision
+- **Create mode** — Build the module structure from a brief
+- **Edit mode** — Modify existing briefs or modules
+- **Validate mode** — Check compliance and completeness
+
+## Role
+
+You are the **Module Architect** — a specialist in BMAD module design. You understand that modules are complex entities requiring careful planning before implementation.
+
+---
+
+## INITIALIZATION SEQUENCE
+
+### 1. Mode Determination
+
+**Check invocation context:**
+- Look for existing module brief or plan
+- Check if user is starting fresh or continuing work
+- Determine what mode they need
+
+**Ask the user:**
+
+**"Welcome to the Module workflow! What would you like to do?"**
+
+- **[B] Brief** — Create a module brief (exploratory, creative discovery)
+- **[C] Create** — Build a module from a brief
+- **[E] Edit** — Modify an existing brief or module
+- **[V] Validate** — Validate a brief or module
+
+### 2. Route to First Step
+
+**IF mode == brief (B):**
+Load `{installed_path}/steps-b/step-01-welcome.md`
+
+**IF mode == create (C):**
+Ask: "Where is the module brief?" → Load `{installed_path}/steps-c/step-01-load-brief.md`
+
+**IF mode == edit (E):**
+Ask: "What would you like to edit?" → Load `{installed_path}/steps-e/step-01-assess.md`
+
+**IF mode == validate (V):**
+Ask: "What would you like to validate?" → Load `{installed_path}/steps-v/step-01-validate.md`
+
+---
+
+## Configuration
+
+This workflow references:
+- `{installed_path}/data/` — Module standards and templates
+- `{installed_path}/templates/` — Output templates
+
+---
+
+## Workflow Structure
+
+```
+module/
+├── workflow.md              # This file - mode routing
+├── data/                    # Shared standards
+│   ├── module-standards.md
+│   ├── module-yaml-conventions.md
+│   ├── agent-architecture.md
+│   └── module-installer-standards.md
+├── templates/               # Output templates
+│   ├── brief-template.md
+│   ├── agent-spec-template.md
+│   └── workflow-spec-template.md
+├── steps-b/                 # Brief mode (13 steps)
+├── steps-c/                 # Create mode (8 steps)
+├── steps-e/                 # Edit mode
+└── steps-v/                 # Validate mode
+```
+
+---
+
+## Output
+
+**Brief mode produces:**
+- `module-brief-{code}.md` — Complete module vision document
+
+**Create mode produces:**
+- Module directory structure
+- `module.yaml` with install configuration
+- `_module-installer/` folder (if needed)
+- Agent placeholder/spec files
+- Workflow placeholder/spec files
+- `README.md` and `TODO.md`

package/src/modules/bmb/workflows/workflow/data/architecture.md

@@ -0,0 +1,152 @@
+# Workflow Architecture
+
+**Purpose:** Core structural patterns for BMAD workflows.
+
+---
+
+## Structure
+
+```
+workflow-folder/
+├── workflow.md              # Entry point, configuration
+├── steps-c/                 # Create flow steps
+│   ├── step-01-init.md
+│   ├── step-02-[name].md
+│   └── step-N-[name].md
+├── steps-e/                 # Edit flow (if needed)
+├── steps-v/                 # Validate flow (if needed)
+├── data/                    # Shared reference files
+└── templates/               # Output templates (if needed)
+```
+
+---
+
+## workflow.md File Standards
+
+**CRITICAL:** The workflow.md file MUST be lean. It is the entry point and should NOT contain:
+
+- ❌ **Listing of all steps** - This defeats progressive disclosure
+- ❌ **Detailed descriptions of what each step does** - Steps are self-documenting
+- ❌ **Validation checklists** - These belong in steps-v/, not workflow.md
+- ❌ **Implementation details** - These belong in step files
+
+**The workflow.md SHOULD contain:**
+- ✅ Frontmatter: name, description, web_bundle
+- ✅ Goal: What the workflow accomplishes
+- ✅ Role: Who the AI embodies when running this workflow
+- ✅ Meta-context: Background about the architecture (if demonstrating a pattern)
+- ✅ Core architecture principles (step-file design, JIT loading, etc.)
+- ✅ Initialization/routing: How to start and which step to load first
+
+**Progressive Disclosure Rule:**
+Users should ONLY know about the current step they're executing. The workflow.md routes to the first step, and each step routes to the next. No step lists in workflow.md!
+
+---
+
+## Core Principles
+
+### 1. Micro-File Design
+- Each step is a focused file (~80-200 lines)
+- One concept per step
+- Self-contained instructions
+
+### 2. Just-In-Time Loading
+- Only current step file is in memory
+- Never load future steps until user selects 'C'
+- Progressive disclosure - LLM stays focused
+
+### 3. Sequential Enforcement
+- Steps execute in order
+- No skipping, no optimization
+- Each step completes before next loads
+
+### 4. State Tracking
+For continuable workflows:
+```yaml
+stepsCompleted: ['step-01-init', 'step-02-gather', 'step-03-design']
+lastStep: 'step-03-design'
+lastContinued: '2025-01-02'
+```
+
+Each step appends its name to `stepsCompleted` before loading next.
+
+---
+
+## Execution Flow
+
+### Fresh Start
+```
+workflow.md → step-01-init.md → step-02-[name].md → ... → step-N-final.md
+```
+
+### Continuation (Resumed)
+```
+workflow.md → step-01-init.md (detects existing) → step-01b-continue.md → [appropriate next step]
+```
+
+---
+
+## Frontmatter Variables
+
+### Standard (All Workflows)
+```yaml
+workflow_path: '{project-root}/_bmad/[module]/workflows/[name]'
+thisStepFile: './step-[N]-[name].md'
+nextStepFile: './step-[N+1]-[name].md'
+outputFile: '{output_folder}/[output].md'
+```
+
+### Module-Specific
+```yaml
+# BMB example:
+bmb_creations_output_folder: '{project-root}/_bmad/bmb-creations'
+```
+
+### Critical Rules
+- ONLY variables used in step body go in frontmatter
+- All file references use `{variable}` format
+- Paths within workflow folder are relative
+
+---
+
+## Menu Pattern
+
+```markdown
+### N. Present MENU OPTIONS
+
+Display: "**Select:** [A] [action] [P] [action] [C] Continue"
+
+#### Menu Handling Logic:
+- IF A: Execute {task}, then redisplay menu
+- IF P: Execute {task}, then redisplay menu
+- IF C: Save to {outputFile}, update frontmatter, then load {nextStepFile}
+- IF Any other: help user, then redisplay menu
+
+#### EXECUTION RULES:
+- ALWAYS halt and wait for user input
+- ONLY proceed to next step when user selects 'C'
+```
+
+**A/P not needed in:** Step 1 (init), validation sequences, simple data gathering
+
+---
+
+## Output Pattern
+
+Every step writes to a document BEFORE loading next step:
+
+1. **Plan-then-build:** Steps append to plan.md → build step consumes plan
+2. **Direct-to-final:** Steps append directly to final document
+
+See: `output-format-standards.md`
+
+---
+
+## Critical Rules
+
+- 🛑 NEVER load multiple step files simultaneously
+- 📖 ALWAYS read entire step file before execution
+- 🚫 NEVER skip steps or optimize the sequence
+- 💾 ALWAYS update frontmatter when step completes
+- ⏸️ ALWAYS halt at menus and wait for input
+- 📋 NEVER create mental todos from future steps