workflows indicate web_bundle file inclusions

This commit is contained in:
Brian Madison
2025-09-29 20:19:14 -05:00
parent 023edd1b7b
commit 9934224230
147 changed files with 740 additions and 478 deletions

View File

@@ -2,7 +2,7 @@
## 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 build-module workflow.
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
@@ -61,9 +61,9 @@ module-brief/
## Workflow Process
### Phase 1: Foundation & Context (Steps 1-3)
### Phase 1: Foundation and Context (Steps 1-3)
**Mode Selection & Input Gathering**
**Mode Selection and Input Gathering**
- Choose operational mode (Interactive, Express, YOLO)
- Check for and optionally load existing brainstorming results
@@ -101,7 +101,7 @@ module-brief/
- Define input-process-output flows for each workflow
- Assess complexity levels and implementation priorities
### Phase 3: Validation & User Experience (Steps 6-7)
### Phase 3: Validation and User Experience (Steps 6-7)
**User Journey Mapping**
@@ -110,7 +110,7 @@ module-brief/
- Validate end-to-end functionality and value delivery
- Identify potential friction points and optimization opportunities
**Technical Planning & Requirements**
**Technical Planning and Requirements**
- Assess data requirements and storage needs
- Map integration points with other modules and external systems
@@ -133,27 +133,27 @@ module-brief/
- Prioritize features and capabilities by value and complexity
- Create clear milestones and success checkpoints
### Phase 5: Enhancement & Risk Management (Steps 10-12)
### Phase 5: Enhancement and Risk Management (Steps 10-12)
**Creative Features & Special Touches** (Optional)
**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 & Mitigation**
**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 & Export Preparation**
**Final Review and Export Preparation**
- Comprehensive review of all brief sections
- Validation against quality and completeness criteria
- Preparation for seamless handoff to build-module workflow
- Preparation for seamless handoff to create-module workflow
- Export readiness confirmation with actionable specifications
## Output
@@ -161,7 +161,7 @@ module-brief/
### Generated Files
- **Module Brief Document**: Comprehensive planning document at `{output_folder}/module-brief-{module_code}-{date}.md`
- **Strategic Specifications**: Ready-to-implement blueprint for build-module workflow
- **Strategic Specifications**: Ready-to-implement blueprint for create-module workflow
### Output Structure
@@ -178,7 +178,7 @@ The module brief contains detailed specifications across multiple sections:
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 & References** - Inspiration sources, similar modules, technical references
12. **Resources and References** - Inspiration sources, similar modules, technical references
## Requirements
@@ -203,7 +203,7 @@ The module brief contains detailed specifications across multiple sections:
### After Completion
1. **Use as Blueprint** - Feed the brief directly into build-module workflow for implementation
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
@@ -254,10 +254,10 @@ To customize this workflow:
For issues or questions:
- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
- 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 `build-module/module-structure.md`
- Consult module structure guide at `create-module/module-structure.md`
---

View File

@@ -8,7 +8,7 @@
- [ ] Target users are clearly defined
- [ ] Unique value proposition is articulated
## Vision & Concept
## Vision and Concept
- [ ] Problem being solved is clearly stated
- [ ] Solution approach is explained
@@ -80,9 +80,9 @@
## Implementation Readiness
- [ ] Brief provides enough detail for build-module workflow
- [ ] Agent specifications sufficient for build-agent workflow
- [ ] Workflow descriptions ready for build-workflow
- [ ] 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

View File

@@ -249,15 +249,15 @@ For each risk, note mitigation strategy.
<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>
<action>Ensure module brief is ready for create-module workflow</action>
Ask if they want to:
1. Proceed directly to build-module workflow
1. Proceed directly to create-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>
<action>Highlight that this brief can be fed directly into create-module workflow!</action>
<template-output>final_brief</template-output>
</step>

View File

@@ -144,7 +144,7 @@ How we'll know the module is successful:
**Deliverables:**
{{phase2_deliverables}}
### Phase 3: Polish & Optimization
### Phase 3: Polish and Optimization
**Timeline:** {{phase3_timeline}}
@@ -161,11 +161,11 @@ How we'll know the module is successful:
{{creative_features}}
### Easter Eggs & Delighters
### Easter Eggs and Delighters
{{easter_eggs}}
### Module Lore & Theming
### Module Lore and Theming
{{module_lore}}
@@ -209,7 +209,7 @@ How we'll know the module is successful:
---
## Resources & References
## Resources and References
### Inspiration Sources
@@ -235,7 +235,7 @@ How we'll know the module is successful:
{{detailed_workflow_specs}}
### C. Data Structures & Schemas
### C. Data Structures and Schemas
{{data_schemas}}
@@ -248,14 +248,14 @@ How we'll know the module is successful:
## 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
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 build-module workflow for scaffolding and implementation._
_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}}

View File

@@ -15,7 +15,7 @@ date: system-generated
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_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"
@@ -26,5 +26,11 @@ validation: "{installed_path}/checklist.md"
# Output configuration
default_output_file: "{output_folder}/module-brief-{{module_code}}-{{date}}.md"
# No special tools required
required_tools: []
web_bundle:
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"
web_bundle_files:
- "bmad/bmb/workflows/module-brief/instructions.md"
- "bmad/bmb/workflows/module-brief/template.md"
- "bmad/bmb/workflows/module-brief/checklist.md"