pig-farm-controller/bmad/bmb/workflows/module-brief/template.md

# 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_