bmad-method 5.1.2 → 6.0.0-alpha.0

package/src/modules/bmb/workflows/module-brief/instructions.md

@@ -0,0 +1,265 @@
+# Module Brief Instructions
+
+<critical>The workflow execution engine is governed by: {project_root}/bmad/core/tasks/workflow.md</critical>
+<critical>You MUST have already loaded and processed: {project_root}/bmad/bmb/workflows/module-brief/workflow.yaml</critical>
+
+<workflow>
+
+<step n="1" goal="Setup and context gathering">
+<action>Ask the user which mode they prefer:</action>
+1. **Interactive Mode** - Work through each section collaboratively with detailed questions
+2. **Express Mode** - Quick essential questions only
+3. **YOLO Mode** (#yolo) - Generate complete draft based on minimal input
+
+<action>Check for available inputs:</action>
+
+- Brainstorming results from previous sessions
+- Existing module ideas or notes
+- Similar modules for inspiration
+
+<action>If brainstorming results exist, offer to load and incorporate them</action>
+</step>
+
+<step n="2" goal="Module concept and vision">
+Ask the user to describe their module idea. Probe for:
+- What problem does this module solve?
+- Who would use this module?
+- What makes this module exciting or unique?
+- Any inspiring examples or similar tools?
+
+If they're stuck, offer creative prompts:
+
+- "Imagine you're a [role], what tools would make your life easier?"
+- "What repetitive tasks could be automated with agents?"
+- "What domain expertise could be captured in workflows?"
+
+<template-output>module_vision</template-output>
+</step>
+
+<step n="3" goal="Define module identity">
+Based on the vision, work with user to define:
+
+**Module Code** (kebab-case):
+
+- Suggest 2-3 options based on their description
+- Ensure it's memorable and descriptive
+
+**Module Name** (friendly):
+
+- Creative, engaging name that captures the essence
+
+**Module Category:**
+
+- Domain-Specific (legal, medical, finance)
+- Creative (writing, gaming, music)
+- Technical (devops, testing, architecture)
+- Business (project management, marketing)
+- Personal (productivity, learning)
+
+**Personality Theme** (optional but fun!):
+
+- Should the module have a consistent personality across agents?
+- Star Trek crew? Fantasy party? Corporate team? Reality show cast?
+
+<template-output>module_identity</template-output>
+</step>
+
+<step n="4" goal="Agent architecture planning">
+<action>Help user envision their agent team</action>
+
+For each agent, capture:
+
+- **Role**: What's their specialty?
+- **Personality**: How do they communicate? (reference communication styles)
+- **Key Capabilities**: What can they do?
+- **Signature Commands**: 2-3 main commands
+
+Suggest agent archetypes based on module type:
+
+- The Orchestrator (manages other agents)
+- The Specialist (deep expertise)
+- The Helper (utility functions)
+- The Creator (generates content)
+- The Analyzer (processes and evaluates)
+
+<template-output>agent_architecture</template-output>
+</step>
+
+<step n="5" goal="Workflow ecosystem design">
+<action>Map out the workflow landscape</action>
+
+Categorize workflows:
+
+**Core Workflows** (2-3 essential ones):
+
+- The primary value-delivery workflows
+- What users will use most often
+
+**Feature Workflows** (3-5 specialized):
+
+- Specific capabilities
+- Advanced features
+
+**Utility Workflows** (1-3 supporting):
+
+- Setup, configuration
+- Maintenance, cleanup
+
+For each workflow, define:
+
+- Purpose (one sentence)
+- Input → Process → Output
+- Complexity (simple/standard/complex)
+
+<template-output>workflow_ecosystem</template-output>
+</step>
+
+<step n="6" goal="User journey and scenarios">
+<action>Create usage scenarios to validate the design</action>
+
+Write 2-3 user stories:
+"As a [user type], I want to [goal], so that [outcome]"
+
+Then walk through how they'd use the module:
+
+1. They load [agent]
+2. They run [command/workflow]
+3. They get [result]
+4. This helps them [achievement]
+
+This validates the module makes sense end-to-end.
+
+<template-output>user_scenarios</template-output>
+</step>
+
+<step n="7" goal="Technical and resource planning">
+Assess technical requirements:
+
+**Data Requirements:**
+
+- What data/files does the module need?
+- Any external APIs or services?
+- Storage or state management needs?
+
+**Integration Points:**
+
+- Other BMAD modules it might use
+- External tools or platforms
+- Import/export formats
+
+**Complexity Assessment:**
+
+- Simple (standalone, no dependencies)
+- Standard (some integrations, moderate complexity)
+- Complex (multiple systems, advanced features)
+
+<template-output>technical_planning</template-output>
+</step>
+
+<step n="8" goal="Success metrics and validation">
+Define what success looks like:
+
+**Module Success Criteria:**
+
+- What indicates the module is working well?
+- How will users measure value?
+- What feedback mechanisms?
+
+**Quality Standards:**
+
+- Performance expectations
+- Reliability requirements
+- User experience goals
+
+<template-output>success_metrics</template-output>
+</step>
+
+<step n="9" goal="Development roadmap">
+Create a phased approach:
+
+**Phase 1 - MVP (Minimum Viable Module):**
+
+- 1 primary agent
+- 2-3 core workflows
+- Basic functionality
+
+**Phase 2 - Enhancement:**
+
+- Additional agents
+- More workflows
+- Refined features
+
+**Phase 3 - Polish:**
+
+- Advanced features
+- Optimizations
+- Nice-to-haves
+
+<template-output>development_roadmap</template-output>
+</step>
+
+<step n="10" goal="Creative flourishes and special features" optional="true">
+<action>If user wants to add special touches:</action>
+
+**Easter Eggs:**
+
+- Hidden commands or responses
+- Fun interactions between agents
+
+**Delighters:**
+
+- Unexpected helpful features
+- Personality quirks
+- Creative responses
+
+**Module Lore:**
+
+- Backstory for agents
+- Thematic elements
+- Consistent universe
+
+<template-output>creative_features</template-output>
+</step>
+
+<step n="11" goal="Risk assessment and mitigation">
+Identify potential challenges:
+
+**Technical Risks:**
+
+- Complex integrations
+- Performance concerns
+- Dependency issues
+
+**Usability Risks:**
+
+- Learning curve
+- Complexity creep
+- User confusion
+
+**Scope Risks:**
+
+- Feature bloat
+- Timeline expansion
+- Resource constraints
+
+For each risk, note mitigation strategy.
+
+<template-output>risk_assessment</template-output>
+</step>
+
+<step n="12" goal="Final review and export readiness">
+<action>Review all sections with user</action>
+<action>Ensure module brief is ready for build-module workflow</action>
+
+Ask if they want to:
+
+1. Proceed directly to build-module workflow
+2. Save and refine later
+3. Generate additional planning documents
+
+<action>Highlight that this brief can be fed directly into build-module workflow!</action>
+
+<template-output>final_brief</template-output>
+</step>
+
+</workflow>

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

@@ -0,0 +1,275 @@
+# Module Brief: {{module_name}}
+
+**Date:** {{date}}
+**Author:** {{user_name}}
+**Module Code:** {{module_code}}
+**Status:** Ready for Development
+
+---
+
+## Executive Summary
+
+{{module_vision}}
+
+**Module Category:** {{module_category}}
+**Complexity Level:** {{complexity_level}}
+**Target Users:** {{target_users}}
+
+---
+
+## Module Identity
+
+### Core Concept
+
+{{module_identity}}
+
+### Unique Value Proposition
+
+What makes this module special:
+{{unique_value}}
+
+### Personality Theme
+
+{{personality_theme}}
+
+---
+
+## Agent Architecture
+
+{{agent_architecture}}
+
+### Agent Roster
+
+{{agent_roster}}
+
+### Agent Interaction Model
+
+How agents work together:
+{{agent_interactions}}
+
+---
+
+## Workflow Ecosystem
+
+{{workflow_ecosystem}}
+
+### Core Workflows
+
+Essential functionality that delivers primary value:
+{{core_workflows}}
+
+### Feature Workflows
+
+Specialized capabilities that enhance the module:
+{{feature_workflows}}
+
+### Utility Workflows
+
+Supporting operations and maintenance:
+{{utility_workflows}}
+
+---
+
+## User Scenarios
+
+### Primary Use Case
+
+{{primary_scenario}}
+
+### Secondary Use Cases
+
+{{secondary_scenarios}}
+
+### User Journey
+
+Step-by-step walkthrough of typical usage:
+{{user_journey}}
+
+---
+
+## Technical Planning
+
+### Data Requirements
+
+{{data_requirements}}
+
+### Integration Points
+
+{{integration_points}}
+
+### Dependencies
+
+{{dependencies}}
+
+### Technical Complexity Assessment
+
+{{technical_planning}}
+
+---
+
+## Success Metrics
+
+### Module Success Criteria
+
+How we'll know the module is successful:
+{{success_criteria}}
+
+### Quality Standards
+
+{{quality_standards}}
+
+### Performance Targets
+
+{{performance_targets}}
+
+---
+
+## Development Roadmap
+
+### Phase 1: MVP (Minimum Viable Module)
+
+**Timeline:** {{phase1_timeline}}
+
+{{phase1_components}}
+
+**Deliverables:**
+{{phase1_deliverables}}
+
+### Phase 2: Enhancement
+
+**Timeline:** {{phase2_timeline}}
+
+{{phase2_components}}
+
+**Deliverables:**
+{{phase2_deliverables}}
+
+### Phase 3: Polish & Optimization
+
+**Timeline:** {{phase3_timeline}}
+
+{{phase3_components}}
+
+**Deliverables:**
+{{phase3_deliverables}}
+
+---
+
+## Creative Features
+
+### Special Touches
+
+{{creative_features}}
+
+### Easter Eggs & Delighters
+
+{{easter_eggs}}
+
+### Module Lore & Theming
+
+{{module_lore}}
+
+---
+
+## Risk Assessment
+
+### Technical Risks
+
+{{technical_risks}}
+
+### Usability Risks
+
+{{usability_risks}}
+
+### Scope Risks
+
+{{scope_risks}}
+
+### Mitigation Strategies
+
+{{risk_mitigation}}
+
+---
+
+## Implementation Notes
+
+### Priority Order
+
+1. {{priority_1}}
+2. {{priority_2}}
+3. {{priority_3}}
+
+### Key Design Decisions
+
+{{design_decisions}}
+
+### Open Questions
+
+{{open_questions}}
+
+---
+
+## Resources & References
+
+### Inspiration Sources
+
+{{inspiration_sources}}
+
+### Similar Modules
+
+{{similar_modules}}
+
+### Technical References
+
+{{technical_references}}
+
+---
+
+## Appendices
+
+### A. Detailed Agent Specifications
+
+{{detailed_agent_specs}}
+
+### B. Workflow Detailed Designs
+
+{{detailed_workflow_specs}}
+
+### C. Data Structures & Schemas
+
+{{data_schemas}}
+
+### D. Integration Specifications
+
+{{integration_specs}}
+
+---
+
+## Next Steps
+
+1. **Review this brief** with stakeholders
+2. **Run build-module workflow** using this brief as input
+3. **Create first agent** using build-agent workflow
+4. **Develop initial workflows** using build-workflow
+5. **Test MVP** with target users
+
+---
+
+_This Module Brief is ready to be fed directly into the build-module workflow for scaffolding and implementation._
+
+**Module Viability Score:** {{viability_score}}/10
+**Estimated Development Effort:** {{effort_estimate}}
+**Confidence Level:** {{confidence_level}}
+
+---
+
+**Approval for Development:**
+
+- [ ] Concept Approved
+- [ ] Scope Defined
+- [ ] Resources Available
+- [ ] Ready to Build
+
+---
+
+_Generated on {{date}} by {{user_name}} using the BMAD Method Module Brief workflow_

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

@@ -0,0 +1,30 @@
+# Module Brief Workflow Configuration
+name: module-brief
+description: "Create a comprehensive Module Brief that serves as the blueprint for building new BMAD modules using strategic analysis and creative vision"
+author: "BMad Builder"
+
+# Critical variables
+config_source: "{project-root}/bmad/bmb/config.yaml"
+output_folder: "{config_source}:output_folder"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+src_impact: "{config_source}:src_impact"
+date: system-generated
+
+# Optional input docs that enhance module planning
+recommended_inputs:
+  - brainstorming_results: "{output_folder}/brainstorming-*.md"
+  - existing_modules: "{project-root}/bmad/"
+  - module_examples: "{project-root}/bmad/bmb/workflows/build-module/module-structure.md"
+
+# Module path and component files
+installed_path: "{project-root}/bmad/bmb/workflows/module-brief"
+template: "{installed_path}/template.md"
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+# Output configuration
+default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md"
+
+# No special tools required
+required_tools: []

package/src/modules/bmb/workflows/redoc/README.md

@@ -0,0 +1,87 @@
+# ReDoc - Reverse-Tree Documentation Engine
+
+**Type:** Autonomous Action Workflow
+**Module:** BMad Builder (bmb)
+
+## Purpose
+
+ReDoc is an intelligent documentation maintenance system for BMAD modules, workflows, and agents. It uses a reverse-tree approach (leaf folders first, then parent folders) to systematically generate and update README.md files with technical writer quality output.
+
+The workflow understands BMAD conventions deeply and focuses documentation on distinctive features rather than explaining standard patterns, resulting in succinct, precise technical documentation.
+
+## Key Features
+
+- **Reverse-Tree Processing**: Documents from deepest folders up to module root, allowing child documentation to inform parent summaries
+- **Convention-Aware**: Loads BMAD architecture patterns and only documents unique/distinctive aspects
+- **Scalability**: Automatically creates catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) for massive folders (>10 items)
+- **Diff-Aware**: Tracks `last-redoc-date` frontmatter to enable change detection since last run
+- **Autonomous**: Runs without user checkpoints unless clarification is genuinely required
+- **Comprehensive**: Reads ALL files completely before generating documentation (no partial reads)
+
+## Usage
+
+Invoke with a target path:
+
+```
+workflow redoc
+```
+
+When prompted, provide one of:
+
+- **Module path**: `bmad/bmm` (documents entire module: root, workflows, agents)
+- **Workflows folder**: `bmad/bmm/workflows` (documents all workflows)
+- **Agents folder**: `bmad/bmm/agents` (documents all agents)
+- **Single workflow**: `bmad/bmm/workflows/product-brief` (documents one workflow)
+- **Single agent**: `bmad/bmm/agents/prd-agent.md` (documents one agent)
+
+## Inputs
+
+### Required
+
+- **target_path**: Path to module, folder, or specific component to document
+
+### Knowledge Base (Auto-loaded)
+
+- agent-architecture.md
+- agent-command-patterns.md
+- agent-types.md
+- module-structure.md
+- workflow-creation-guide.md
+
+## Outputs
+
+### Created/Updated Files
+
+- **README.md**: At each documented level (workflow folders, agent folders, module root)
+- **Catalog files**: WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md (for massive folders)
+- **Frontmatter**: All READMEs include `last-redoc-date: <timestamp>`
+
+### Summary Report
+
+- Documentation coverage statistics
+- List of files created/updated
+- Any items requiring manual review
+
+## Workflow Steps
+
+1. **Initialize**: Load BMAD conventions and validate target
+2. **Analyze Structure**: Build reverse-tree execution plan
+3. **Process Leaves**: Document individual workflows/agents (deepest first)
+4. **Process Folders**: Document workflow/agent collections with categorization
+5. **Process Root**: Document module overview with links and highlights
+6. **Validate**: Verify completeness and generate report
+7. **Diff Analysis** (optional): Show changes since last redoc
+8. **Complete**: Report success and suggest next steps
+
+## Technical Details
+
+- **Execution**: Autonomous with minimal user interaction
+- **Quality**: Technical writer standards - succinct, precise, professional
+- **Context-Aware**: Uses BMAD convention knowledge to highlight only distinctive features
+- **Scalable**: Handles folders of any size with intelligent catalog creation
+
+## Next Steps After Running
+
+1. Review generated documentation for accuracy
+2. If documenting a subfolder, run redoc on parent module to update references
+3. Commit documentation updates with meaningful message