bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.20

package/bmad/bmb/workflows/module-brief/checklist.md

@@ -1,116 +0,0 @@
-# Module Brief Validation Checklist
-
-## Core Identity
-
-- [ ] Module code follows kebab-case convention
-- [ ] Module name is clear and memorable
-- [ ] Module category is identified
-- [ ] Target users are clearly defined
-- [ ] Unique value proposition is articulated
-
-## Vision and Concept
-
-- [ ] Problem being solved is clearly stated
-- [ ] Solution approach is explained
-- [ ] Module scope is well-defined
-- [ ] Success criteria are measurable
-
-## Agent Architecture
-
-- [ ] At least one agent is defined
-- [ ] Each agent has a clear role and purpose
-- [ ] Agent personalities are defined (if using personality themes)
-- [ ] Agent interactions are mapped (for multi-agent modules)
-- [ ] Key commands for each agent are listed
-
-## Workflow Ecosystem
-
-- [ ] Core workflows (2-3) are identified
-- [ ] Each workflow has clear purpose
-- [ ] Workflow complexity is assessed
-- [ ] Input/output for workflows is defined
-- [ ] Workflow categories are logical
-
-## User Experience
-
-- [ ] Primary use case is documented
-- [ ] User scenarios demonstrate value
-- [ ] User journey is realistic
-- [ ] Learning curve is considered
-- [ ] User feedback mechanism planned
-
-## Technical Planning
-
-- [ ] Data requirements are identified
-- [ ] Integration points are mapped
-- [ ] Dependencies are listed
-- [ ] Technical complexity is assessed
-- [ ] Performance requirements stated
-
-## Development Roadmap
-
-- [ ] Phase 1 MVP is clearly scoped
-- [ ] Phase 2 enhancements are outlined
-- [ ] Phase 3 polish items listed
-- [ ] Timeline estimates provided
-- [ ] Deliverables are specific
-
-## Risk Management
-
-- [ ] Technical risks identified
-- [ ] Usability risks considered
-- [ ] Scope risks acknowledged
-- [ ] Mitigation strategies provided
-- [ ] Open questions documented
-
-## Creative Elements (Optional)
-
-- [ ] Personality theme is consistent (if used)
-- [ ] Special features add value
-- [ ] Module feels cohesive
-- [ ] Fun elements don't compromise functionality
-
-## Documentation Quality
-
-- [ ] All sections have content (no empty placeholders)
-- [ ] Writing is clear and concise
-- [ ] Technical terms are explained
-- [ ] Examples are provided where helpful
-- [ ] Next steps are actionable
-
-## Implementation Readiness
-
-- [ ] Brief provides enough detail for create-module workflow
-- [ ] Agent specifications sufficient for create-agent workflow
-- [ ] Workflow descriptions ready for create-workflow
-- [ ] Resource requirements are clear
-- [ ] Success metrics are measurable
-
-## Final Validation
-
-- [ ] Module concept is viable
-- [ ] Scope is achievable
-- [ ] Value is clear
-- [ ] Brief is complete
-- [ ] Ready for development
-
-## Issues Found
-
-### Critical Issues
-
-<!-- Must be fixed before proceeding to build -->
-
-### Recommendations
-
-<!-- Suggested improvements -->
-
-### Nice-to-Haves
-
-<!-- Optional enhancements -->
-
----
-
-**Validation Complete:** ⬜ Yes / ⬜ With Issues / ⬜ Needs Revision
-
-**Validated By:** **\*\*\*\***\_**\*\*\*\***
-**Date:** **\*\*\*\***\_**\*\*\*\***

package/bmad/bmb/workflows/module-brief/instructions.md

@@ -1,267 +0,0 @@
-# Module Brief Instructions
-
-<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
-<critical>You MUST have already loaded and processed: {project-root}/bmad/bmb/workflows/module-brief/workflow.yaml</critical>
-<critical>Communicate in {communication_language} throughout the module brief creation process</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_name}</action>
-<action>Ensure module brief is ready for create-module workflow</action>
-
-<ask>Would {user_name} like to:
-
-1. Proceed directly to create-module workflow
-2. Save and refine later
-3. Generate additional planning documents
-   </ask>
-
-<action>Inform {user_name} in {communication_language} that this brief can be fed directly into create-module workflow</action>
-
-<template-output>final_brief</template-output>
-</step>
-
-</workflow>

package/bmad/bmb/workflows/module-brief/workflow.yaml

@@ -1,29 +0,0 @@
-# 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"
-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/create-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"
-
-standalone: true
-# Web bundle configuration

package/bmad/bmb/workflows/module-brief/workflow.yaml.bak

@@ -1,27 +0,0 @@
-# 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"
-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/create-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"
-# Web bundle configuration

package/bmad/bmb/workflows/redoc/README.md

@@ -1,87 +0,0 @@
-# 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

package/bmad/bmb/workflows/redoc/checklist.md

@@ -1,99 +0,0 @@
-# ReDoc Workflow Validation Checklist
-
-## Initialization and Setup
-
-- [ ] All BMAD convention documents loaded and understood
-- [ ] Target path validated and exists
-- [ ] Target type correctly identified (module/workflow/agent/folder)
-- [ ] Documentation execution plan created with reverse-tree order
-
-## File Analysis
-
-- [ ] All files in target scope read completely (no offset/limit usage)
-- [ ] Existing README.md files detected and last-redoc-date parsed
-- [ ] Massive folders (>10 items) identified for catalog document creation
-- [ ] Documentation depth levels calculated correctly
-
-## Leaf-Level Documentation (Workflows)
-
-- [ ] Each workflow's ALL files read: workflow.yaml, instructions.md, template.md, checklist.md
-- [ ] README.md includes frontmatter with current last-redoc-date
-- [ ] Description is 2-4 paragraphs of technical writer quality
-- [ ] Focuses on DISTINCTIVE features, not BMAD boilerplate conventions
-- [ ] Includes "Usage" section with invocation command
-- [ ] Includes "Inputs" and "Outputs" sections where applicable
-- [ ] Succinct and precise language used throughout
-
-## Leaf-Level Documentation (Agents)
-
-- [ ] Each agent file read completely including XML structure, commands, persona
-- [ ] README.md includes frontmatter with current last-redoc-date
-- [ ] Description is 1-3 paragraphs of technical writer quality
-- [ ] Lists all available commands clearly
-- [ ] Explains when to use this agent
-- [ ] Highlights unique capabilities vs standard agent patterns
-
-## Mid-Level Documentation (Folders)
-
-- [ ] All child README.md files read before generating folder README
-- [ ] Workflows categorized logically if massive folder (>10 items)
-- [ ] Agents categorized by type if massive folder (>10 items)
-- [ ] Catalog documents (WORKFLOWS-CATALOG.md, AGENTS-CATALOG.md) created for massive folders
-- [ ] Catalog documents include frontmatter with last-redoc-date
-- [ ] Folder README.md references catalog if one exists
-- [ ] Folder README.md is succinct (1-2 paragraphs + listings/links)
-- [ ] Notable/commonly-used items highlighted
-
-## Root Module Documentation
-
-- [ ] Module config.yaml read and understood
-- [ ] Workflows and agents folder READMEs read before creating root README
-- [ ] Root README includes frontmatter with current last-redoc-date
-- [ ] Module purpose clearly stated in 2-3 sentences
-- [ ] Links to /workflows/README.md and /agents/README.md included
-- [ ] 2-3 key workflows mentioned with context
-- [ ] 2-3 key agents mentioned with context
-- [ ] Configuration section highlights UNIQUE settings only
-- [ ] Usage section explains invocation patterns
-- [ ] BMAD convention knowledge applied (describes only distinctive aspects)
-
-## Quality Standards
-
-- [ ] All documentation uses proper BMAD terminology
-- [ ] Technical writer quality: clear, concise, professional
-- [ ] No placeholder text or generic descriptions remain
-- [ ] All links are valid and correctly formatted
-- [ ] Frontmatter syntax is correct and dates are current
-- [ ] No redundant explanation of standard BMAD patterns
-
-## Validation and Reporting
-
-- [ ] All planned documentation items created/updated
-- [ ] Frontmatter dates verified as current across all files
-- [ ] File paths and internal links validated
-- [ ] Summary report generated with counts and coverage
-- [ ] Files skipped (if any) documented with reasons
-
-## Git Diff Analysis (Optional Step)
-
-- [ ] last-redoc-date timestamps extracted correctly
-- [ ] Git log queried for changes since last redoc
-- [ ] Modified files identified and reported
-- [ ] Findings presented clearly to user
-
-## Final Validation
-
-- [ ] Documentation Coverage
-  - All README.md files in scope created/updated
-  - Catalog documents created where needed
-  - No documentation gaps identified
-
-- [ ] Execution Quality
-  - Reverse-tree order followed (leaf → root)
-  - Autonomous execution (minimal user prompts)
-  - Only clarification questions asked when truly necessary
-
-- [ ] Output Quality
-  - Technical precision maintained throughout
-  - Succinct descriptions (no verbose explanations)
-  - Professional documentation standards met