26 lines
718 B
Markdown
26 lines
718 B
Markdown
|
# Service Name: [Service ID]
|
||
|
|
|
||
|
|
## 1. Overview
|
||
|
|
[A brief description of what this service does and its primary responsibility.]
|
||
|
|
|
||
|
|
## 2. Key Responsibilities
|
||
|
|
- [Responsibility 1]
|
||
|
|
- [Responsibility 2]
|
||
|
|
- [Responsibility 3]
|
||
|
|
|
||
|
|
## 3. Key Data Entities
|
||
|
|
[List major database tables or domain objects managed by this service.]
|
||
|
|
- **Entity A**: [Description]
|
||
|
|
- **Entity B**: [Description]
|
||
|
|
|
||
|
|
## 4. Dependencies
|
||
|
|
- **Upstream**: [Services that call this service]
|
||
|
|
- **Downstream**: [Services called by this service]
|
||
|
|
- **Middleware**: [e.g., MySQL, Redis, Kafka]
|
||
|
|
|
||
|
|
## 5. Critical Configurations
|
||
|
|
[Key environment variables or config items.]
|
||
|
|
|
||
|
|
## 6. Common Operations / Troubleshooting
|
||
|
|
[Service-specific health check URLs, log locations, etc.]
|