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

package/src/modules/bmb/workflows-legacy/edit-module/instructions.md

@@ -0,0 +1,340 @@
+# Edit Module - Module Editor 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/edit-module/workflow.yaml</critical>
+<critical>This workflow uses ADAPTIVE FACILITATION - adjust your communication based on context and user needs</critical>
+<critical>The goal is COLLABORATIVE IMPROVEMENT - work WITH the user, not FOR them</critical>
+<critical>Communicate all responses in {communication_language}</critical>
+
+<workflow>
+
+<step n="1" goal="Load and deeply understand the target module">
+<ask>What is the path to the module source you want to edit?</ask>
+
+<action>Load the module directory structure completely:
+
+- Scan all directories and files
+- Load config.yaml
+- Load README.md
+- List all agents in agents/ directory
+- List all workflows in workflows/ directory
+- Identify any custom structure or patterns
+  </action>
+
+<action>Load ALL module documentation to inform understanding:
+
+- Module structure guide: {module_structure_guide}
+- Study reference modules: BMM, BMB, CIS
+- Understand BMAD module patterns and conventions
+  </action>
+
+<action>Analyze the module deeply:
+
+- Identify module purpose and role in BMAD ecosystem
+- Understand agent organization and relationships
+- Map workflow organization and dependencies
+- Evaluate config structure and completeness
+- Check documentation quality and currency
+- Assess installer configuration (if source module)
+- Identify cross-module integrations
+- Evaluate against best practices from loaded guides
+  </action>
+
+<action>Reflect understanding back to {user_name}:
+
+Present a warm, conversational summary adapted to the module's complexity:
+
+- What this module provides (its purpose and value in BMAD)
+- How it's organized (agents, workflows, structure)
+- What you notice (strengths, potential improvements, issues)
+- How it fits in the larger BMAD ecosystem
+- Your initial assessment based on best practices
+
+Be conversational and insightful. Help {user_name} see their module through your eyes.
+</action>
+
+<ask>Does this match your understanding of what this module should provide?</ask>
+<template-output>module_understanding</template-output>
+</step>
+
+<step n="2" goal="Discover improvement goals collaboratively">
+<critical>Understand WHAT the user wants to improve and WHY before diving into edits</critical>
+
+<action>Engage in collaborative discovery:
+
+Ask open-ended questions to understand their goals:
+
+- What prompted you to want to edit this module?
+- What feedback have you gotten from users of this module?
+- Are there specific agents or workflows that need attention?
+- Is the module fulfilling its intended purpose?
+- Are there new capabilities you want to add?
+- How well does it integrate with other modules?
+- Is the documentation helping users understand and use the module?
+
+Listen for clues about:
+
+- Structural issues (poor organization, hard to navigate)
+- Agent/workflow issues (outdated, broken, missing functionality)
+- Configuration issues (missing fields, incorrect setup)
+- Documentation issues (outdated, incomplete, unclear)
+- Integration issues (doesn't work well with other modules)
+- Installer issues (installation problems, missing files)
+- User experience issues (confusing, hard to use)
+  </action>
+
+<action>Based on their responses and your analysis from step 1, identify improvement opportunities:
+
+Organize by priority and user goals:
+
+- CRITICAL issues blocking module functionality
+- IMPORTANT improvements enhancing user experience
+- NICE-TO-HAVE enhancements for polish
+
+Present these conversationally, explaining WHY each matters and HOW it would help.
+</action>
+
+<action>Collaborate on priorities:
+
+Don't just list options - discuss them:
+
+- "I noticed {{issue}} - this could make it hard for users to {{problem}}. Want to address this?"
+- "The module could be more {{improvement}} which would help when {{use_case}}. Worth exploring?"
+- "Based on what you said about {{user_goal}}, we might want to {{suggestion}}. Thoughts?"
+
+Let the conversation flow naturally. Build a shared vision of what "better" looks like.
+</action>
+
+<template-output>improvement_goals</template-output>
+</step>
+
+<step n="3" goal="Facilitate improvements collaboratively" repeat="until-user-satisfied">
+<critical>Work iteratively - improve, review, refine. Never dump all changes at once.</critical>
+<critical>For agent and workflow edits, invoke specialized workflows rather than doing inline</critical>
+
+<action>For each improvement area, facilitate collaboratively:
+
+1. **Explain the current state and why it matters**
+   - Show relevant sections of the module
+   - Explain how it works now and implications
+   - Connect to user's goals from step 2
+
+2. **Propose improvements with rationale**
+   - Suggest specific changes that align with best practices
+   - Explain WHY each change helps
+   - Provide examples from reference modules: {bmm_module_dir}, {bmb_module_dir}, {cis_module_dir}
+   - Reference agents from: {existing_agents_dir}
+   - Reference workflows from: {existing_workflows_dir}
+   - Reference the structure guide's patterns naturally
+
+3. **Collaborate on the approach**
+   - Ask if the proposed change addresses their need
+   - Invite modifications or alternative approaches
+   - Explain tradeoffs when relevant
+   - Adapt based on their feedback
+
+4. **Apply changes appropriately**
+   - For agent edits: Invoke edit-agent workflow
+   - For workflow edits: Invoke edit-workflow workflow
+   - For module-level changes: Make directly and iteratively
+   - Show updates and confirm satisfaction
+     </action>
+
+<action>Common improvement patterns to facilitate:
+
+**If improving module organization:**
+
+- Discuss how the current structure serves (or doesn't serve) users
+- Propose reorganization that aligns with mental models
+- Consider feature-based vs type-based organization
+- Plan the reorganization steps
+- Update all references after moving files
+
+**If updating module configuration:**
+
+- Review current config.yaml fields
+- Check for missing standard fields (user_name, communication_language, output_folder)
+- Add module-specific fields as needed
+- Remove unused or outdated fields
+- Ensure config is properly documented
+
+**If managing agents:**
+
+- Ask which agent needs attention and why
+- For editing existing agent: <invoke-workflow path="{agent_editor}">
+- For adding new agent: Guide creation and integration
+- For removing agent: Confirm, remove, update references
+- Ensure all agent references in workflows remain valid
+
+**If managing workflows:**
+
+- Ask which workflow needs attention and why
+- For editing existing workflow: <invoke-workflow path="{workflow_editor}">
+- For adding new workflow: Guide creation and integration
+- For removing workflow: Confirm, remove, update agent references
+- Ensure all workflow files are properly organized
+
+**If improving documentation:**
+
+- Review current README and identify gaps
+- Discuss what users need to know
+- Update module overview and purpose
+- List agents and workflows with clear descriptions
+- Add usage examples if helpful
+- Ensure installation/setup instructions are clear
+
+**If setting up cross-module integration:**
+
+- Identify which workflows from other modules are needed
+- Show how to reference workflows properly: {project-root}/_bmad/{{module}}/workflows/{{workflow}}/workflow.yaml
+- Document the integration in README
+- Ensure dependencies are clear
+- Consider adding example usage
+
+**If updating installer (source modules only):**
+
+- Review installer script for correctness
+- Check web bundle configurations
+- Verify all files are included
+- Test installation paths
+- Update module metadata
+  </action>
+
+<action>When invoking specialized workflows:
+
+Explain why you're handing off:
+
+- "This agent needs detailed attention. Let me invoke the edit-agent workflow to give it proper focus."
+- "The workflow editor can handle this more thoroughly. I'll pass control there."
+
+After the specialized workflow completes, return and continue:
+
+- "Great! That agent/workflow is updated. Want to work on anything else in the module?"
+  </action>
+
+<action>Throughout improvements, educate when helpful:
+
+Share insights from the guides naturally:
+
+- "The module structure guide recommends {{pattern}} for this scenario"
+- "Looking at how BMM organized this, we could use {{approach}}"
+- "The BMAD convention is to {{pattern}} which helps with {{benefit}}"
+
+Connect improvements to broader BMAD principles without being preachy.
+</action>
+
+<ask>After each significant change:
+
+- "Does this organization feel more intuitive?"
+- "Want to refine this further, or move to the next improvement?"
+- "How does this change affect users of the module?"
+  </ask>
+
+<template-output>improvement_implementation</template-output>
+</step>
+
+<step n="4" goal="Validate improvements holistically">
+<action>Run comprehensive validation conversationally:
+
+Don't just check boxes - explain what you're validating and why it matters:
+
+- "Let me verify the module structure is solid..."
+- "Checking that all agent workflow references are valid..."
+- "Making sure config.yaml has all necessary fields..."
+- "Validating documentation is complete and accurate..."
+- "Ensuring cross-module references work correctly..."
+  </action>
+
+<action>Load validation checklist: {installed_path}/checklist.md</action>
+<action>Check all items from checklist systematically</action>
+
+<check if="validation_issues_found">
+  <action>Present issues conversationally:
+
+Explain what's wrong and implications:
+
+- "I found {{issue}} which could cause {{problem}} for users"
+- "The {{component}} needs {{fix}} because {{reason}}"
+
+Propose fixes immediately:
+
+- "I can fix this by {{solution}}. Should I?"
+- "We have a couple options here: {{option1}} or {{option2}}. Thoughts?"
+  </action>
+
+<action>Fix approved issues and re-validate</action>
+</check>
+
+<check if="validation_passes">
+  <action>Confirm success warmly:
+
+"Excellent! Everything validates cleanly:
+
+- Module structure is well-organized
+- All agent and workflow references are valid
+- Configuration is complete
+- Documentation is thorough and current
+- Cross-module integrations work properly
+- Installer is correct (if applicable)
+
+Your module is in great shape."
+</action>
+</check>
+
+<template-output>validation_results</template-output>
+</step>
+
+<step n="5" goal="Review improvements and guide next steps">
+<action>Create a conversational summary of what improved:
+
+Tell the story of the transformation:
+
+- "We started with {{initial_state}}"
+- "You wanted to {{user_goals}}"
+- "We made these key improvements: {{changes_list}}"
+- "Now your module {{improved_capabilities}}"
+
+Highlight the impact:
+
+- "This means users will experience {{benefit}}"
+- "The module is now more {{quality}}"
+- "It follows best practices for {{patterns}}"
+  </action>
+
+<action>Guide next steps based on changes made:
+
+If structure changed significantly:
+
+- "Since we reorganized the structure, you should update any external references to this module"
+
+If agents or workflows were updated:
+
+- "The updated agents/workflows should be tested with real user interactions"
+
+If cross-module integration was added:
+
+- "Test the integration with {{other_module}} to ensure it works smoothly"
+
+If installer was updated:
+
+- "Test the installation process to verify all files are included correctly"
+
+If this is part of larger BMAD work:
+
+- "Consider if patterns from this module could benefit other modules"
+
+Be a helpful guide to what comes next, not just a task completer.
+</action>
+
+<ask>Would you like to:
+
+- Test the edited module by invoking one of its agents
+- Edit a specific agent or workflow in more detail
+- Make additional refinements to the module
+- Work on a different module
+  </ask>
+
+<template-output>completion_summary</template-output>
+</step>
+
+</workflow>

package/src/modules/bmb/workflows-legacy/edit-module/workflow.yaml

@@ -0,0 +1,34 @@
+# Edit Module - Module Editor Configuration
+name: "edit-module"
+description: "Edit existing BMAD modules (structure, agents, workflows, documentation) while following all best practices"
+author: "BMad"
+
+# Critical variables load from config_source
+config_source: "{project-root}/_bmad/bmb/config.yaml"
+communication_language: "{config_source}:communication_language"
+user_name: "{config_source}:user_name"
+
+# Required Data Files - Critical for understanding module conventions
+module_structure_guide: "{project-root}/_bmad/bmb/workflows/create-module/module-structure.md"
+
+# Related workflow editors
+agent_editor: "{project-root}/_bmad/bmb/workflows/edit-agent/workflow.yaml"
+workflow_editor: "{project-root}/_bmad/bmb/workflows/edit-workflow/workflow.yaml"
+
+# Reference examples - for learning patterns
+bmm_module_dir: "{project-root}/_bmad/bmm/"
+bmb_module_dir: "{project-root}/_bmad/bmb/"
+cis_module_dir: "{project-root}/_bmad/cis/"
+existing_agents_dir: "{project-root}/_bmad/*/agents/"
+existing_workflows_dir: "{project-root}/_bmad/*/workflows/"
+
+# Module path and component files
+installed_path: "{project-root}/_bmad/bmb/workflows/edit-module"
+template: false # This is an action workflow - no template needed
+instructions: "{installed_path}/instructions.md"
+validation: "{installed_path}/checklist.md"
+
+standalone: true
+
+# Web bundle configuration
+web_bundle: false # BMB workflows run locally in BMAD-METHOD project

package/src/modules/bmb/workflows-legacy/module-brief/README.md

@@ -0,0 +1,264 @@
+# Module Brief Workflow
+
+## Overview
+
+The Module Brief workflow creates comprehensive blueprints for building new BMAD modules using strategic analysis and creative vision. It serves as the essential planning phase that transforms initial ideas into detailed, actionable specifications ready for implementation with the create-module workflow.
+
+## Key Features
+
+- **Strategic Module Planning** - Comprehensive analysis from concept to implementation roadmap
+- **Multi-Mode Operation** - Interactive, Express, and YOLO modes for different planning needs
+- **Creative Vision Development** - Guided process for innovative module concepts and unique value propositions
+- **Architecture Design** - Detailed agent and workflow ecosystem planning with interaction models
+- **User Journey Mapping** - Scenario-based validation ensuring practical usability
+- **Technical Planning** - Infrastructure requirements, dependencies, and complexity assessment
+- **Risk Assessment** - Proactive identification of challenges with mitigation strategies
+- **Implementation Roadmap** - Phased development plan with clear deliverables and timelines
+
+## Usage
+
+### Basic Invocation
+
+```bash
+workflow module-brief
+```
+
+### With Brainstorming Input
+
+```bash
+# If you have brainstorming results from previous sessions
+workflow module-brief --input brainstorming-session-2024-09-26.md
+```
+
+### Express Mode
+
+```bash
+# For quick essential planning only
+workflow module-brief --mode express
+```
+
+### Configuration
+
+The workflow uses standard BMB configuration:
+
+- **output_folder**: Where the module brief will be saved
+- **user_name**: Brief author information
+- **communication_language**: Language for brief generation
+- **date**: Automatic timestamp for versioning
+
+## Workflow Structure
+
+### Files Included
+
+```
+module-brief/
+├── workflow.yaml           # Configuration and metadata
+├── instructions.md         # Step-by-step execution guide
+├── template.md            # Module brief document structure
+├── checklist.md           # Validation criteria
+└── README.md              # This file
+```
+
+## Workflow Process
+
+### Phase 1: Foundation and Context (Steps 1-3)
+
+**Mode Selection and Input Gathering**
+
+- Choose operational mode (Interactive, Express, YOLO)
+- Check for and optionally load existing brainstorming results
+- Gather background context and inspiration sources
+
+**Module Vision Development**
+
+- Define core problem the module solves
+- Identify target user audience and use cases
+- Establish unique value proposition and differentiators
+- Explore creative themes and personality concepts
+
+**Module Identity Establishment**
+
+- Generate module code (kebab-case) with multiple options
+- Create compelling, memorable module name
+- Select appropriate category (Domain-Specific, Creative, Technical, Business, Personal)
+- Define optional personality theme for consistent agent character
+
+### Phase 2: Architecture Planning (Steps 4-5)
+
+**Agent Architecture Design**
+
+- Plan agent team composition and roles
+- Define agent archetypes (Orchestrator, Specialist, Helper, Creator, Analyzer)
+- Specify personality traits and communication styles
+- Map key capabilities and signature commands
+
+**Workflow Ecosystem Design**
+
+- Categorize workflows by purpose and complexity:
+  - **Core Workflows**: Essential value-delivery functions (2-3)
+  - **Feature Workflows**: Specialized capabilities (3-5)
+  - **Utility Workflows**: Supporting operations (1-3)
+- Define input-process-output flows for each workflow
+- Assess complexity levels and implementation priorities
+
+### Phase 3: Validation and User Experience (Steps 6-7)
+
+**User Journey Mapping**
+
+- Create detailed user scenarios and stories
+- Map step-by-step usage flows through the module
+- Validate end-to-end functionality and value delivery
+- Identify potential friction points and optimization opportunities
+
+**Technical Planning and Requirements**
+
+- Assess data requirements and storage needs
+- Map integration points with other modules and external systems
+- Evaluate technical complexity and resource requirements
+- Document dependencies and infrastructure needs
+
+### Phase 4: Success Planning (Steps 8-9)
+
+**Success Metrics Definition**
+
+- Establish module success criteria and performance indicators
+- Define quality standards and reliability requirements
+- Create user experience goals and feedback mechanisms
+- Set measurable outcomes for module effectiveness
+
+**Development Roadmap Creation**
+
+- Design phased approach with MVP, Enhancement, and Polish phases
+- Define deliverables and timelines for each phase
+- Prioritize features and capabilities by value and complexity
+- Create clear milestones and success checkpoints
+
+### Phase 5: Enhancement and Risk Management (Steps 10-12)
+
+**Creative Features and Special Touches** (Optional)
+
+- Design easter eggs and delightful user interactions
+- Plan module lore and thematic consistency
+- Add personality quirks and creative responses
+- Develop backstories and universe building
+
+**Risk Assessment and Mitigation**
+
+- Identify technical, usability, and scope risks
+- Develop mitigation strategies for each risk category
+- Plan contingency approaches for potential challenges
+- Document decision points and alternative paths
+
+**Final Review and Export Preparation**
+
+- Comprehensive review of all brief sections
+- Validation against quality and completeness criteria
+- Preparation for seamless handoff to create-module workflow
+- Export readiness confirmation with actionable specifications
+
+## Output
+
+### Generated Files
+
+- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md`
+- **Strategic Specifications**: Ready-to-implement blueprint for create-module workflow
+
+### Output Structure
+
+The module brief contains detailed specifications across multiple sections:
+
+1. **Executive Summary** - Vision, category, complexity, target users
+2. **Module Identity** - Core concept, value proposition, personality theme
+3. **Agent Architecture** - Agent roster, roles, interaction models
+4. **Workflow Ecosystem** - Core, feature, and utility workflow specifications
+5. **User Scenarios** - Primary use cases, secondary scenarios, user journey
+6. **Technical Planning** - Data requirements, integrations, dependencies
+7. **Success Metrics** - Success criteria, quality standards, performance targets
+8. **Development Roadmap** - Phased implementation plan with deliverables
+9. **Creative Features** - Special touches, easter eggs, module lore
+10. **Risk Assessment** - Technical, usability, scope risks with mitigation
+11. **Implementation Notes** - Priority order, design decisions, open questions
+12. **Resources and References** - Inspiration sources, similar modules, technical references
+
+## Requirements
+
+- **Creative Vision** - Initial module concept or problem domain
+- **Strategic Thinking** - Ability to plan architecture and user experience
+- **Brainstorming Results** (optional) - Previous ideation sessions enhance planning quality
+
+## Best Practices
+
+### Before Starting
+
+1. **Gather Inspiration** - Research similar tools, modules, and solutions in your domain
+2. **Run Brainstorming Session** - Use ideation techniques to generate initial concepts
+3. **Define Success Criteria** - Know what "successful module" means for your context
+
+### During Execution
+
+1. **Think User-First** - Always consider the end user experience and value delivery
+2. **Be Specific** - Provide concrete examples and detailed specifications rather than abstractions
+3. **Validate Early** - Use user scenarios to test if the module concept actually works
+4. **Plan Iteratively** - Start with MVP and build complexity through phases
+
+### After Completion
+
+1. **Use as Blueprint** - Feed the brief directly into create-module workflow for implementation
+2. **Review with Stakeholders** - Validate assumptions and gather feedback before building
+3. **Update as Needed** - Treat as living document that evolves with implementation learnings
+4. **Reference During Development** - Use as north star for design decisions and scope management
+
+## Troubleshooting
+
+### Common Issues
+
+**Issue**: Stuck on module concept or vision
+
+- **Solution**: Use creative prompts provided in the workflow
+- **Check**: Review existing modules for inspiration and patterns
+
+**Issue**: Agent or workflow architecture too complex
+
+- **Solution**: Focus on MVP first, plan enhancement phases for additional complexity
+- **Check**: Validate each component against user scenarios
+
+**Issue**: Technical requirements unclear
+
+- **Solution**: Research similar modules and their implementation approaches
+- **Check**: Consult with technical stakeholders early in planning
+
+**Issue**: Scope creep during planning
+
+- **Solution**: Use phased roadmap to defer non-essential features
+- **Check**: Regularly validate against core user scenarios and success criteria
+
+## Customization
+
+To customize this workflow:
+
+1. **Modify Template Structure** - Update template.md to add new sections or reorganize content
+2. **Extend Creative Prompts** - Add domain-specific ideation techniques in instructions.md
+3. **Add Planning Tools** - Integrate additional analysis frameworks or planning methodologies
+4. **Customize Validation** - Enhance checklist.md with specific quality criteria for your context
+
+## Version History
+
+- **v1.0.0** - Initial release
+  - Comprehensive strategic module planning
+  - Multi-mode operation (Interactive, Express, YOLO)
+  - Creative vision and architecture design tools
+  - User journey mapping and validation
+  - Risk assessment and mitigation planning
+
+## Support
+
+For issues or questions:
+
+- Review the workflow creation guide at `/_bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
+- Study existing module examples in `/_bmad/` for patterns and inspiration
+- Validate output using `checklist.md`
+- Consult module structure guide at `create-module/module-structure.md`
+
+---
+
+_Part of the BMad Method v6 - BMB (Builder) Module_