architecture-template.md

1# {{Project Name}} Architecture Specification
2
3**Last Updated**: {{YYYY-MM-DD}}
4
5> **Living Document**: This architecture specification is actively maintained throughout the project lifecycle. It serves as the authoritative source for architectural decisions and should be updated when making significant architectural changes, technology stack modifications, or design pattern updates.
6>
7> **Purpose**: Provides high-level architectural guidance and technology stack decisions for AI assistants, developers, and stakeholders. Should be referenced in the main README.md as essential reading for understanding system design and architectural patterns.
8>
9> **Maintenance**: AI assistants should recommend updates when discovering architectural inconsistencies or when implementing features that require architectural changes to keep this document aligned with the actual system.
10
11## Instructions for AI Assistants
12
13When working with this architecture specification:
14
151. **Technology Stack Decisions**: Document technology choices with clear rationale and version constraints
162. **Architecture Pattern Application**: Reference UCM patterns or industry standards and note any adaptations
173. **Component Organization**: Structure components by business capability with clear interface boundaries
18
19## Overview
20
21{{Brief description of the system and its architectural approach. 1-2 paragraphs maximum.}}
22
23## Technology Stack
24
25### Core Technologies
26- **{{Technology Category}}**: {{Technology Choice}} {{Version}}+
27- **Architecture Pattern**: {{Architecture Pattern Name}} ({{Pattern Source}})
28
29### Key Dependencies
30- **{{Dependency Category}}**: {{Technology/Service}} for {{purpose}}
31
32## Architecture Patterns
33
34### {{Primary Architecture Pattern Name}}
35
36{{Brief description of the chosen architecture pattern and why it was selected.}}
37
38#### Core Principles
39- **{{Principle Name}}**: {{Brief description}}
40- **{{Principle Name}}**: {{Brief description}}
41
42#### Component Structure
43```
44{{High-level directory/component structure showing logical organization}}
45```
46
47## System Architecture
48
49### Request Flow
50```
51{{High-level flow diagram showing major components and data flow}}
52```
53
54### Component Design
55
56#### {{Component Category}}
57- **{{Component Name}}**: {{Brief responsibility description}}
58- **{{Component Name}}**: {{Brief responsibility description}}
59
60## Performance & Scalability
61
62{{Key performance optimization approaches and scaling strategies.}}
63
64## Security
65
66{{Overall security approach and key security measures.}}
67
68## Deployment
69
70{{Deployment approach and infrastructure requirements.}}
71
72---
73
74*Template created by [Utaba AI](https://utaba.ai)*  
75*Source: [architecture-template.md](https://ucm.utaba.ai/browse/utaba/main/guidance/templates/architecture-template.md)*