Service
Назначение
<ServiceName> владеет <bounded context/owned state> и предоставляет <capabilities>.
Metadata
| Поле | Значение |
|---|---|
| Статус | draft / approved / deprecated |
| Owning team | <team> |
| Domain | <domain> |
| Data classification | <Public/Internal/Sensitive/Mixed> |
| Runtime criticality | <low/medium/high/mission-critical> |
Ownership
| Artifact | Owner/Rule |
|---|---|
| PostgreSQL schema | <schema> |
| API areas | <public/admin/internal/callback> |
| Owned entities | <entity list> |
| Produced events | <events> |
| Consumed events | <events> |
| Search indexes | <indexes/none> |
| Analytics facts | <facts/none> |
Ответственность И Границы
- Что сервис делает:
<list>. - Что сервис не делает:
<list>. - Какие данные являются source of truth:
<list>. - Какие реплики или projections допускаются:
<list>.
Зависимости
| Зависимость | Тип | Зачем Нужна | Failure mode |
|---|---|---|---|
<dependency> | service/db/queue/cache/external system | <purpose> | <impact> |
Проекты
src/services/<service-name>/
<Service>.Api/
<Service>.Application/
<Service>.Domain/
<Service>.Infrastructure/
<Service>.Background/
<Service>.Migrator/
<Service>.Contracts/
Основные Сущности
| Entity | Назначение | Source Of Truth | Документ |
|---|---|---|---|
<Entity> | <purpose> | <service> | <link> |
API
- Public:
<links or not applicable>; - Admin:
<links or not applicable>; - Internal:
<links or not applicable>; - Callbacks:
<links or not applicable>.
Events И Consumers
| Type | Name | Topic | Назначение | Link |
|---|---|---|---|---|
| Produced | <event> | <topic> | <purpose> | <link> |
| Consumed | <event> | <topic> | <purpose> | <link> |
Runtime И Эксплуатация
| Область | Требование |
|---|---|
| Health checks | <live/ready/startup endpoints> |
| SLO/SLA | <targets> |
| Dashboard | <link> |
| Alerts | <link/list> |
| Runbooks | <links> |
| Feature flags | <critical flags or none> |
Безопасность
- Основные actor types:
<list>. - Permission model:
<link>. - Sensitive data classes:
<list>. - Audit requirements:
<rule>. - Tenant isolation rule:
<rule>.
Известные Ограничения И Assumptions
<assumption><limitation>
Обратные ссылки
Автоссылки: где используется этот документ.
- index.md (4): Шаблоны Документации, Calendar Service, Notifications Service, Rewards Service
- documentation-file-templates.md (1): Индекс Шаблонов Документации
Связанные Документы
<architecture links><service docs><runbooks><dashboards>