massive update and guidance.
This commit is contained in:
76
ai/templates/architecture-template.md
Normal file
76
ai/templates/architecture-template.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Architecture for {PRD Title}
|
||||
|
||||
Status: { Draft | Approved }
|
||||
|
||||
## Technical Summary
|
||||
|
||||
{ Short 1-2 paragraph }
|
||||
|
||||
## Technology Table
|
||||
|
||||
Table listing choices for languages, libraries, infra, etc...
|
||||
|
||||
<example>
|
||||
| Technology | Description |
|
||||
| ------------ | ------------------------------------------------------------- |
|
||||
| Kubernetes | Container orchestration platform for microservices deployment |
|
||||
| Apache Kafka | Event streaming platform for real-time data ingestion |
|
||||
| TimescaleDB | Time-series database for sensor data storage |
|
||||
| Go | Primary language for data processing services |
|
||||
| GoRilla Mux | REST API Framework |
|
||||
| Python | Used for data analysis and ML services |
|
||||
</example>
|
||||
|
||||
## Architectural Diagrams
|
||||
|
||||
{ Mermaid Diagrams to describe key flows interactions or architecture to be followed during implementation, infra provisioning, and deployments }
|
||||
|
||||
## Data Models, API Specs, Schemas, etc...
|
||||
|
||||
{ As needed - may not be exhaustive - but key ideas that need to be retained and followed into the stories }
|
||||
|
||||
<example>
|
||||
### Sensor Reading Schema
|
||||
|
||||
```json
|
||||
{
|
||||
"sensor_id": "string",
|
||||
"timestamp": "datetime",
|
||||
"readings": {
|
||||
"temperature": "float",
|
||||
"pressure": "float",
|
||||
"humidity": "float"
|
||||
},
|
||||
"metadata": {
|
||||
"location": "string",
|
||||
"calibration_date": "datetime"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</example>
|
||||
|
||||
## Project Structure
|
||||
|
||||
{ Diagram the folder and file organization structure along with descriptions }
|
||||
|
||||
```
|
||||
├ /src
|
||||
├── /services
|
||||
│ ├── /gateway # Sensor data ingestion
|
||||
│ ├── /processor # Data processing and validation
|
||||
│ ├── /analytics # Data analysis and ML
|
||||
│ └── /notifier # Alert and notification system
|
||||
├── /deploy
|
||||
│ ├── /kubernetes # K8s manifests
|
||||
│ └── /terraform # Infrastructure as Code
|
||||
└── /docs
|
||||
├── /api # API documentation
|
||||
└── /schemas # Data schemas
|
||||
```
|
||||
|
||||
## Infrastructure
|
||||
|
||||
## Deployment Plan
|
||||
|
||||
## Change Log
|
||||
Reference in New Issue
Block a user