mirror of
https://github.com/MODSetter/SurfSense.git
synced 2026-04-27 01:36:30 +02:00
155 lines
2.1 KiB
Markdown
155 lines
2.1 KiB
Markdown
|
|
# Module Brief: {module_code}
|
||
|
|
|
||
|
|
**Date:** {date}
|
||
|
|
**Author:** {user_name}
|
||
|
|
**Module Code:** {module_code}
|
||
|
|
**Module Type:** {module_type}
|
||
|
|
**Status:** Ready for Development
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Executive Summary
|
||
|
|
|
||
|
|
{module_vision}
|
||
|
|
|
||
|
|
**Module Category:** {module_category}
|
||
|
|
**Target Users:** {target_users}
|
||
|
|
**Complexity Level:** {complexity_level}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Module Identity
|
||
|
|
|
||
|
|
### Module Code & Name
|
||
|
|
|
||
|
|
- **Code:** `{module_code}`
|
||
|
|
- **Name:** `{module_name}`
|
||
|
|
|
||
|
|
### Core Concept
|
||
|
|
|
||
|
|
{module_identity}
|
||
|
|
|
||
|
|
### Personality Theme
|
||
|
|
|
||
|
|
{personality_theme}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Module Type
|
||
|
|
|
||
|
|
**Type:** {module_type}
|
||
|
|
|
||
|
|
{module_type_explanation}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Unique Value Proposition
|
||
|
|
|
||
|
|
**What makes this module special:**
|
||
|
|
|
||
|
|
{unique_value_proposition}
|
||
|
|
|
||
|
|
**Why users would choose this module:**
|
||
|
|
|
||
|
|
{value_proposition_details}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## User Scenarios
|
||
|
|
|
||
|
|
### Target Users
|
||
|
|
|
||
|
|
{target_users}
|
||
|
|
|
||
|
|
### Primary Use Case
|
||
|
|
|
||
|
|
{primary_use_case}
|
||
|
|
|
||
|
|
### User Journey
|
||
|
|
|
||
|
|
{user_journey}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Agent Architecture
|
||
|
|
|
||
|
|
### Agent Count Strategy
|
||
|
|
|
||
|
|
{agent_count_strategy}
|
||
|
|
|
||
|
|
### Agent Roster
|
||
|
|
|
||
|
|
| Agent | Name | Role | Expertise |
|
||
|
|
|-------|------|------|-----------|
|
||
|
|
{agent_roster_table}
|
||
|
|
|
||
|
|
### Agent Interaction Model
|
||
|
|
|
||
|
|
{agent_interaction_model}
|
||
|
|
|
||
|
|
### Agent Communication Style
|
||
|
|
|
||
|
|
{agent_communication_style}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Workflow Ecosystem
|
||
|
|
|
||
|
|
### Core Workflows (Essential)
|
||
|
|
|
||
|
|
{core_workflows}
|
||
|
|
|
||
|
|
### Feature Workflows (Specialized)
|
||
|
|
|
||
|
|
{feature_workflows}
|
||
|
|
|
||
|
|
### Utility Workflows (Support)
|
||
|
|
|
||
|
|
{utility_workflows}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Tools & Integrations
|
||
|
|
|
||
|
|
### MCP Tools
|
||
|
|
|
||
|
|
{mcp_tools}
|
||
|
|
|
||
|
|
### External Services
|
||
|
|
|
||
|
|
{external_services}
|
||
|
|
|
||
|
|
### Integrations with Other Modules
|
||
|
|
|
||
|
|
{module_integrations}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Creative Features
|
||
|
|
|
||
|
|
### Personality & Theming
|
||
|
|
|
||
|
|
{creative_personality}
|
||
|
|
|
||
|
|
### Easter Eggs & Delighters
|
||
|
|
|
||
|
|
{easter_eggs}
|
||
|
|
|
||
|
|
### Module Lore
|
||
|
|
|
||
|
|
{module_lore}
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
1. **Review this brief** — Ensure the vision is clear
|
||
|
|
2. **Run create-module workflow** — Build the module structure
|
||
|
|
3. **Create agents** — Use create-agent workflow for each agent
|
||
|
|
4. **Create workflows** — Use create-workflow workflow for each workflow
|
||
|
|
5. **Test module** — Install and verify functionality
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
_brief created on {date} by {user_name} using the BMAD Module workflow_
|