4.9 KiB
[FEATURE NAME] Documentation (Tier 3)
This file documents [feature/module] patterns, architectural decisions, and implementations within [component name].
[Feature] Architecture Overview
[Architecture Decision Title]
Context: [Situation that led to this architectural decision]
Decision: [What was decided and implemented]
Reasoning:
- [Benefit 1]: [Why this approach provides this benefit]
- [Benefit 2]: [Technical or business advantage]
- [Benefit 3]: [Performance or maintainability benefit]
- [Benefit 4]: [Developer experience or operational benefit]
Consequences:
- [Positive outcome from this decision]
- [Technical improvement achieved]
- [Operational or maintenance benefit]
- [User experience enhancement]
[Feature] Implementation Patterns
[Implementation Pattern 1]
File Organization:
[feature-directory]/
├── [file1].[ext] # [Purpose and responsibility]
├── [file2].[ext] # [Purpose and responsibility]
├── [file3].[ext] # [Purpose and responsibility]
└── [file4].[ext] # [Purpose and responsibility]
Architecture Benefits:
- [Benefit 1]: [How this organization provides this benefit]
- [Benefit 2]: [Technical advantage of this structure]
- [Benefit 3]: [Maintainability or scalability benefit]
- [Benefit 4]: [Developer experience improvement]
[Implementation Pattern 2]
Architecture Decision: [Technical approach taken]
Context: [Background and requirements that led to this approach]
Decision: [Specific implementation choice made]
Reasoning:
- [Technical Reason]: [Why this was the best technical choice]
- [Performance Reason]: [Performance benefits]
- [Maintainability Reason]: [Long-term maintenance benefits]
- [Integration Reason]: [How it integrates with other components]
Implementation Details:
// [Description of what this code demonstrates]
[detailed code example showing the implementation pattern]
[Implementation Pattern 3]
[Pattern Name]: [Description of the pattern]
// [Code example title]
[comprehensive code example showing the pattern in action]
Implementation Benefits:
- [Benefit 1]: [Specific advantage this implementation provides]
- [Benefit 2]: [Performance or reliability improvement]
- [Benefit 3]: [Developer experience enhancement]
[Technical Domain] Implementation
[Technical Feature 1]
[Feature Description]: [What this feature does and why it's important]
Architecture Pattern:
// [Description of the architectural approach]
[code example demonstrating the architecture]
Key Implementation Details:
- [Detail 1]: [Important implementation consideration]
- [Detail 2]: [Technical constraint or optimization]
- [Detail 3]: [Integration or performance consideration]
[Technical Feature 2]
Implementation Approach: [How this feature is implemented]
// [Code example description]
[detailed implementation example]
Technical Considerations:
- [Consideration 1]: [Important technical factor]
- [Consideration 2]: [Performance or scalability factor]
- [Consideration 3]: [Maintenance or testing consideration]
[Integration/Communication] Patterns
[Integration Pattern 1]
Context: [When and why this integration pattern is used]
Implementation:
// [Integration example description]
[code showing integration implementation]
Benefits:
- [Integration Benefit 1]: [How this improves system integration]
- [Integration Benefit 2]: [Performance or reliability improvement]
[Integration Pattern 2]
Pattern Description: [What problem this integration pattern solves]
// [Integration code example]
[implementation showing integration pattern]
Performance & Optimization Details
[Performance Optimization 1]
Optimization: [What was optimized and how]
- Before: [Previous performance characteristics]
- After: [Improved performance metrics]
- Implementation: [How the optimization was achieved]
[Performance Optimization 2]
Technical Improvement: [Specific performance enhancement]
- Impact: [Measurable improvement achieved]
- Method: [Technical approach used]
- Trade-offs: [Any compromises made for the optimization]
Error Handling & Edge Cases
[Error Scenario 1]
Scenario: [What error condition this handles] Handling: [How the error is detected and managed] Recovery: [How the system recovers from this error]
[Error Scenario 2]
Edge Case: [Unusual condition that needs handling]
Solution: [How the implementation handles this case]
Validation: [How this handling is tested or verified]
This feature documentation provides detailed implementation context for AI-assisted development. For broader component context, see the component-level CONTEXT.md file.