fYmious/infocom-systems-design
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
871cf7e79241c6543d6def1e3dde541ae3f64406
infocom-systems-design/node_modules/@zenuml/core/docs/CONTEXT-tier2-component.md
nik 871cf7e792 add hw2
2025-10-03 22:27:28 +03:00

3.6 KiB
Raw Blame History

[COMPONENT NAME] - Component Context (Tier 2)

Note

: This is component-specific context. See root CLAUDE.md for master project context and coding standards.

Purpose

[Brief description of this component's role in the system. What problem does it solve and how does it fit into the overall architecture?]

Current Status: [Status Description] ✅/🚧/📋

[Current implementation state, what's working, what's in progress, and key milestones achieved]

Component-Specific Development Guidelines

  • [Technology/Framework]: [Specific technology requirements for this component]
  • [Architecture Pattern]: [Component-specific architectural approach]
  • [Code Organization]: [How code should be structured within this component]
  • [Integration Patterns]: [How this component integrates with others]
  • [Quality Standards]: [Component-specific quality requirements]

Key Component Structure

Core Modules ([path]/)

  • [module1]/ - [Purpose and key functionality]
    • [file1].[ext] - [Specific file purpose and key features]
    • [file2].[ext] - [Specific file purpose and key features]
  • [module2]/ - [Purpose and key functionality]
  • [module3]/ - [Purpose and key functionality]

[Secondary Structure] ([path]/)

  • [component].[ext] - [Component purpose and architecture pattern]
  • [utilities].[ext] - [Utility functions and helpers]
  • [config].[ext] - [Configuration and settings management]

[Integration Layer] ([path]/)

  • [integration1].[ext] - [External service integration patterns]
  • [integration2].[ext] - [Inter-component communication]

Implementation Highlights

[Key Feature 1]

  • [Technical Implementation]: [How this feature is implemented]
  • [Architecture Decision]: [Why this approach was chosen]
  • [Performance Considerations]: [Optimization details]
  • [Integration Points]: [How it connects to other components]

[Key Feature 2]

  • [Implementation Pattern]: [Technical implementation approach]
  • [Quality Measures]: [Testing, monitoring, error handling]
  • [Scalability Considerations]: [How it handles growth/load]

[Key Feature 3]

  • [Technical Details]: [Implementation specifics]
  • [Dependencies]: [External dependencies and integration points]
  • [Configuration]: [How it's configured and customized]

Critical Implementation Details

[Technical Pattern 1]

[Pattern Description]: [What problem this pattern solves]

// Example implementation showing the pattern
[code example demonstrating the critical implementation]

[Technical Pattern 2]

[Architecture Decision]: [Why this approach was chosen]

// Code example showing architecture implementation
[code example demonstrating the architecture]

[Integration Pattern]

[Integration Description]: [How this component integrates with others]

// Integration implementation example  
[code example showing integration patterns]

Development Notes

[Current Challenges]

  • [Challenge 1]: [Description and current approach]
  • [Challenge 2]: [Description and mitigation strategy]

[Future Considerations]

  • [Enhancement 1]: [Planned improvement and rationale]
  • [Enhancement 2]: [Future architectural evolution]

[Performance Metrics]

  • [Key Metric 1]: [Current performance and targets]
  • [Key Metric 2]: [Monitoring and optimization approach]

This component documentation provides context for AI-assisted development within [COMPONENT NAME]. For system-wide patterns and standards, reference the master CLAUDE.md file.