npm - bmad-method - Versions diffs - 6.0.0-alpha.9 → 6.0.1 - Mend

bmad-method 6.0.0-alpha.9 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (931) hide show

package/src/modules/bmb/workflows/module-brief/checklist.md DELETED Viewed

@@ -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:** {name}
-**Date:** {date}

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

@@ -1,267 +0,0 @@
-# Module Brief Instructions
-<critical>The workflow execution engine is governed by: {project-root}/{bmad_folder}/core/tasks/workflow.xml</critical>
-<critical>You MUST have already loaded and processed: {project-root}/{bmad_folder}/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/src/modules/bmb/workflows/module-brief/template.md DELETED Viewed

@@ -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/src/modules/bmb/workflows/module-brief/workflow.yaml DELETED Viewed

@@ -1,31 +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_folder}/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_folder}/"
-  - module_examples: "{project-root}/{bmad_folder}/bmb/workflows/create-module/module-structure.md"
-# Module path and component files
-installed_path: "{project-root}/{bmad_folder}/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
-web_bundle: false # BMB workflows run locally in BMAD-METHOD project