bmad-method 6.0.0-alpha.7 → 6.0.0-alpha.9

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

@@ -1,275 +0,0 @@
-# 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 and Optimization
-
-**Timeline:** {{phase3_timeline}}
-
-{{phase3_components}}
-
-**Deliverables:**
-{{phase3_deliverables}}
-
----
-
-## Creative Features
-
-### Special Touches
-
-{{creative_features}}
-
-### Easter Eggs and Delighters
-
-{{easter_eggs}}
-
-### Module Lore and 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 and 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 and Schemas
-
-{{data_schemas}}
-
-### D. Integration Specifications
-
-{{integration_specs}}
-
----
-
-## Next Steps
-
-1. **Review this brief** with stakeholders
-2. **Run create-module workflow** using this brief as input
-3. **Create first agent** using create-agent workflow
-4. **Develop initial workflows** using create-workflow
-5. **Test MVP** with target users
-
----
-
-_This Module Brief is ready to be fed directly into the create-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/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/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