SuperClaude/Templates/Template_Mode_System_Architecture.md

297 lines
11 KiB
Markdown
Raw Normal View History

# {Mode Name} Mode
## Core Principles
- [Primary Principle]: [Description with measurable outcomes]
- [Secondary Principle]: [Description with validation criteria]
- [Tertiary Principle]: [Description with quality gates]
- [Quality Principle]: [Description with enforcement mechanisms]
## Architecture Layers
### Layer 1: {Foundation Layer} ([Scope Description])
- **Scope**: [Operating scope and boundaries]
- **States**: [Available states and transitions]
- **Capacity**: [Operational limits and thresholds]
- **Integration**: [How this layer connects to others]
### Layer 2: {Coordination Layer} ([Scope Description])
- **Scope**: [Operating scope and boundaries]
- **Structure**: [Organizational patterns and hierarchies]
- **Persistence**: [State management and durability]
- **Coordination**: [Inter-layer communication patterns]
### Layer 3: {Orchestration Layer} ([Scope Description])
- **Scope**: [Operating scope and boundaries]
- **Features**: [Advanced capabilities and coordination]
- **Management**: [Resource and dependency management]
- **Intelligence**: [Decision-making and optimization]
### Layer 4: {Enhancement Layer} ([Scope Description])
- **Scope**: [Operating scope and boundaries]
- **Features**: [Progressive and iterative capabilities]
- **Optimization**: [Performance and quality improvements]
- **Analytics**: [Measurement and feedback loops]
## {Primary System} Detection and Creation
### Automatic Triggers
- [Trigger Category 1]: [Description with examples]
- [Trigger Category 2]: [Description with detection patterns]
- [Trigger Category 3]: [Description with keyword patterns]
- [Scope Indicators]: [Description with complexity thresholds]
### {Primary System} State Management
- **{state_1}** {emoji}: [Description and transition criteria]
- **{state_2}** {emoji}: [Description and constraints]
- **{state_3}** {emoji}: [Description and dependency handling]
- **{state_4}** {emoji}: [Description and completion criteria]
## Related Flags
### {Primary Delegation} Flags
**`--{primary-flag} [{option1}|{option2}|{option3}]`**
- Enable {system} for {capability description}
- **{option1}**: [Description and use cases]
- **{option2}**: [Description and use cases]
- **{option3}**: [Description and intelligent behavior]
- Auto-activates: [Threshold conditions]
- [Performance benefit]: [Quantified improvement metrics]
**`--{control-flag} [n]`**
- Control [parameter description] (default: [N], range: [min-max])
- [Dynamic behavior]: [Description of adaptive behavior]
- [Safety feature]: [Description of protection mechanisms]
### {Secondary System} Flags
**`--{orchestration-flag} [{mode1}|{mode2}|{mode3}]`**
- Control {orchestration system} activation
- **{mode1}**: [Auto-activation criteria and behavior]
- **{mode2}**: [Override conditions and use cases]
- **{mode3}**: [Disable conditions and fallback behavior]
- [Performance metric]: [Quantified improvement through intelligence]
**`--{strategy-flag} [{strategy1}|{strategy2}|{strategy3}|{strategy4}]`**
- Select {orchestration system} strategy
- **{strategy1}**: [Description and optimal use cases]
- **{strategy2}**: [Description and complexity handling]
- **{strategy3}**: [Description and adaptive behavior]
- **{strategy4}**: [Description and enterprise-scale handling]
**`--{delegation-flag} [{type1}|{type2}|{type3}]`**
- Control how {system} delegates work to {subsystem}
- **{type1}**: [Description and granularity]
- **{type2}**: [Description and organizational approach]
- **{type3}**: [Description and functional approach]
### {Enhancement System} Flags
**`--{enhancement-flag}`**
- Enable {enhancement capability} for {target operations}
- Auto-activates: [Keyword detection and operation types]
- Compatible operations: [List of compatible commands/operations]
- Default: [Default behavior and validation approach]
**`--{control-param} [n]`**
- Control [parameter description] (default: [N], range: [min-max])
- Overrides [intelligent behavior description]
**`--{interaction-flag}`**
- Enable [interaction type] between [system components]
- [Behavior description]: [Detailed interaction patterns]
- [Benefit description]: [User control and guidance capabilities]
## Auto-Activation Thresholds
- **{Primary System}**: [Threshold conditions with logical operators]
- **{Orchestration System}**: [Complex multi-condition thresholds]
- **{Enhancement System}**: [Keyword and pattern detection criteria]
## Document Persistence
**{Comprehensive description}** with {automated features} and {analytics capabilities}.
### Directory Structure
```
ClaudeDocs/{PrimaryCategory}/{SecondaryCategory}/
├── {Subcategory1}/ # {Description}
├── {Subcategory2}/ # {Description}
├── {Subcategory3}/ # {Description}
├── {Subcategory4}/ # {Description}
└── Archives/ # {Description}
```
### Summary Documents
```
ClaudeDocs/Summary/
├── {summary-type1}-{identifier}-{YYYY-MM-DD-HHMMSS}.md
├── {summary-type2}-{project}-{YYYY-MM-DD-HHMMSS}.md
├── {summary-type3}-{project}-{YYYY-MM-DD-HHMMSS}.md
└── {summary-type4}-{session-id}-{YYYY-MM-DD-HHMMSS}.md
```
### File Naming Convention
```
{operation-type}-{category}-{YYYY-MM-DD-HHMMSS}.md
Examples:
- {example1}-{category}-2024-12-15-143022.md
- {example2}-{category}-2024-12-15-143045.md
- {example3}-{category}-2024-12-15-143108.md
- {example4}-{category}-2024-12-15-143131.md
```
### {Summary Category} Summaries
```
{summary-format1}-{identifier}-{YYYY-MM-DD-HHMMSS}.md
{summary-format2}-{project}-{YYYY-MM-DD-HHMMSS}.md
{summary-format3}-{project}-{YYYY-MM-DD-HHMMSS}.md
{summary-format4}-{session-id}-{YYYY-MM-DD-HHMMSS}.md
```
### Metadata Format
```yaml
---
operation_type: [{type1}|{type2}|{type3}|{type4}]
timestamp: 2024-12-15T14:30:22Z
session_id: session_abc123
{complexity_metric}: 0.85
{primary_metrics}:
{metric1}: {strategy/mode}
{metric2}: 3
{metric3}: 0.78
{metric4}: 0.92
{secondary_analytics}:
{metric5}: 5
{metric6}: 0.65
{metric7}: 0.72
{metric8}: 0.88
{performance_analytics}:
{metric9}: 0.45
{metric10}: 0.96
{metric11}: 0.71
{metric12}: 0.38
---
```
### Persistence Workflow
#### {Primary Summary} Generation
1. **{Detection Step}**: [Description of trigger detection]
2. **{Analysis Step}**: [Description of metrics calculation]
3. **{Generation Step}**: [Description of summary creation]
4. **{Cross-Reference Step}**: [Description of linking and relationships]
5. **{Knowledge Step}**: [Description of pattern documentation]
#### {Secondary Summary}
1. **{Tracking Step}**: [Description of process monitoring]
2. **{Metrics Step}**: [Description of performance measurement]
3. **{Pattern Step}**: [Description of pattern identification]
4. **{Documentation Step}**: [Description of summary generation]
5. **{Best Practices Step}**: [Description of pattern documentation]
### Integration Points
#### Quality Gates Integration
- **Step 2.5**: [Description of mid-process validation]
- **Step 7.5**: [Description of completion validation]
- **Continuous**: [Description of real-time monitoring]
- **Post-{Process}**: [Description of comprehensive analytics]
## Integration Points
### {Framework} Integration
- **{Integration Type 1}**: [Description and coordination patterns]
- **{Integration Type 2}**: [Description and compatibility requirements]
- **{Integration Type 3}**: [Description and cross-system coordination]
- **{Integration Type 4}**: [Description and workflow orchestration]
### {Cross-System} Coordination
- **{Coordination Type 1}**: [Description and interaction patterns]
- **{Coordination Type 2}**: [Description and shared capabilities]
- **{Coordination Type 3}**: [Description and complementary functionality]
- **{Coordination Type 4}**: [Description and unified workflows]
### Quality Gates Integration
- **Step {N}.5**: [Description of validation point integration]
- **Step {M}.5**: [Description of completion verification]
- **Continuous**: [Description of ongoing monitoring]
- **{Specialized}**: [Description of specialized validation]
## Configuration
```yaml
{mode_name}:
activation:
automatic: {true|false}
{threshold_type}: 0.{N}
detection_patterns:
{pattern_type1}: ["{pattern1}", "{pattern2}", "{pattern3}"]
{pattern_type2}: [{keyword1}, {keyword2}, {keyword3}]
{pattern_type3}: [{indicator1}, {indicator2}, {indicator3}]
{system1}_coordination:
{param1}: {default_value}
{param2}: [{option1}, {option2}, {option3}]
{param3}: {behavior_description}
{param4}: {intelligence_feature}
{system2}_integration:
{feature1}: {true|false}
{feature2}: {value}
{feature3}: {configuration}
{feature4}: {coordination_setting}
{analytics_system}:
{metric1}: {target_value}
{metric2}: {measurement_approach}
{metric3}: {optimization_setting}
{metric4}: {reporting_configuration}
{performance_tuning}:
{param1}: {performance_value}
{param2}: {efficiency_setting}
{param3}: {resource_limit}
{param4}: {optimization_approach}
{persistence_config}:
enabled: true
directory: "ClaudeDocs/{Category}/"
auto_save: true
{feature1}:
- {type1}
- {type2}
- {type3}
{feature2}: yaml
{feature3}: {retention_period}
```
## Related Documentation
- **{Primary Implementation}**: [Description and reference]
- **{Secondary Integration}**: [Description and cross-reference]
- **{Framework Reference}**: [Description and coordination guide]
- **{Quality Standards}**: [Description and validation reference]
---
## Template Usage Notes
**Mode Classification Requirements:**
- **system-architecture**: Multi-layer systems with complex orchestration, extensive flag systems, and comprehensive integration
- **Category: orchestration**: Advanced coordination and management capabilities
- **Complexity: advanced**: Sophisticated logic, multiple integration points, comprehensive analytics
- **Scope: framework**: Deep integration with SuperClaude framework and cross-system coordination
**Key Architectural Elements:**
1. **Multi-Layer Architecture**: Hierarchical system organization with clear layer boundaries and interactions
2. **Extensive Flag Systems**: Complex flag coordination with delegation, orchestration, and enhancement capabilities
3. **Auto-Activation Logic**: Sophisticated threshold systems with multi-condition evaluation
4. **Comprehensive Persistence**: Advanced documentation with metadata, analytics, and cross-referencing
5. **Framework Integration**: Deep quality gate integration and cross-system coordination
6. **Performance Analytics**: Comprehensive metrics collection and optimization tracking
**Template Customization Guidelines:**
- Replace `{Mode Name}` with actual mode name
- Customize layer descriptions based on actual architecture
- Adapt flag systems to match mode capabilities
- Configure persistence structure for mode requirements
- Align integration points with framework standards
- Adjust configuration YAML to mode specifications