ййй
This commit is contained in:
@@ -0,0 +1,115 @@
|
||||
# {{title}}
|
||||
|
||||
## Summary
|
||||
- Purpose:
|
||||
- Actor:
|
||||
- Trigger:
|
||||
- Endpoint:
|
||||
- Main entities:
|
||||
- Main logic:
|
||||
- Main errors:
|
||||
- Source of truth:
|
||||
|
||||
## Назначение
|
||||
|
||||
## Контекст
|
||||
|
||||
## Технический use case
|
||||
|
||||
### Основной сценарий
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Альтернативные ветки
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Функциональные требования
|
||||
|
||||
### Request validation
|
||||
-
|
||||
|
||||
### Processing rules
|
||||
-
|
||||
|
||||
### State changes
|
||||
-
|
||||
|
||||
### Side effects
|
||||
-
|
||||
|
||||
## Contract
|
||||
|
||||
### Endpoint
|
||||
- Method:
|
||||
- Path:
|
||||
- Auth:
|
||||
- Idempotent:
|
||||
- Timeout:
|
||||
- Retry:
|
||||
|
||||
### Request
|
||||
| Field | Type | Required | Constraints | Description |
|
||||
|------|------|----------|-------------|-------------|
|
||||
| | | | | |
|
||||
|
||||
### Response
|
||||
| Field | Type | Description |
|
||||
|------|------|-------------|
|
||||
| | | |
|
||||
|
||||
### External contract refs
|
||||
- OpenAPI:
|
||||
- Schema:
|
||||
- DTO / serializer:
|
||||
- Additional refs:
|
||||
|
||||
## Errors
|
||||
|
||||
| error_id | http_code | when | client_behavior | retry |
|
||||
|----------|-----------|------|-----------------|-------|
|
||||
| | | | | |
|
||||
|
||||
## Нефункциональные требования
|
||||
|
||||
### Security
|
||||
-
|
||||
|
||||
### Observability
|
||||
- Logs:
|
||||
- Metrics:
|
||||
- Traces:
|
||||
- Audit:
|
||||
|
||||
### Reliability
|
||||
-
|
||||
-
|
||||
|
||||
### Performance
|
||||
-
|
||||
|
||||
## Связанные блоки логики
|
||||
-
|
||||
|
||||
## Связанные сущности
|
||||
-
|
||||
|
||||
## Связанный код
|
||||
|
||||
### Files
|
||||
-
|
||||
|
||||
### Symbols
|
||||
-
|
||||
|
||||
## Связанные документы
|
||||
-
|
||||
|
||||
## История изменений
|
||||
|
||||
| Date | Source | Changes |
|
||||
|------|--------|---------|
|
||||
| | | |
|
||||
@@ -0,0 +1,105 @@
|
||||
# {{title}}
|
||||
|
||||
## Summary
|
||||
- Scope:
|
||||
- Purpose:
|
||||
- Main modules:
|
||||
- Main domains:
|
||||
- Main integrations:
|
||||
- Key entrypoints:
|
||||
- Key data flows:
|
||||
- Source of truth:
|
||||
|
||||
## Назначение
|
||||
|
||||
## Контекст
|
||||
|
||||
## Границы системы
|
||||
|
||||
### In scope
|
||||
-
|
||||
|
||||
### Out of scope
|
||||
-
|
||||
|
||||
## Архитектурная схема
|
||||
|
||||
## Основные модули
|
||||
|
||||
| module | responsibility | depends_on | key_code_refs |
|
||||
|--------|----------------|------------|---------------|
|
||||
| | | | |
|
||||
|
||||
## Основные доменные области
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Основные интеграции
|
||||
|
||||
| integration | direction | purpose | protocol / transport | related_docs |
|
||||
|-------------|-----------|---------|----------------------|--------------|
|
||||
| | | | | |
|
||||
|
||||
## Основные потоки
|
||||
|
||||
### Flow 1
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Flow 2
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Архитектурные решения и ограничения
|
||||
|
||||
### Key decisions
|
||||
-
|
||||
|
||||
### Constraints
|
||||
-
|
||||
|
||||
### Risks
|
||||
-
|
||||
|
||||
## Нефункциональные аспекты
|
||||
|
||||
### Security
|
||||
-
|
||||
|
||||
### Reliability
|
||||
-
|
||||
|
||||
### Observability
|
||||
- Logs:
|
||||
- Metrics:
|
||||
- Traces:
|
||||
- Audit:
|
||||
|
||||
### Performance
|
||||
-
|
||||
|
||||
### Scalability
|
||||
-
|
||||
|
||||
## Связанные сущности
|
||||
-
|
||||
|
||||
## Связанный код
|
||||
|
||||
### Files
|
||||
-
|
||||
|
||||
### Symbols
|
||||
-
|
||||
|
||||
## Связанные документы
|
||||
-
|
||||
|
||||
## История изменений
|
||||
|
||||
| Date | Source | Changes |
|
||||
|------|--------|---------|
|
||||
| | | |
|
||||
@@ -0,0 +1,92 @@
|
||||
# {{title}}
|
||||
|
||||
## Summary
|
||||
- Domain:
|
||||
- Purpose:
|
||||
- Entity role:
|
||||
- Main attributes:
|
||||
- Lifecycle:
|
||||
- Invariants:
|
||||
- Related APIs:
|
||||
- Related logic:
|
||||
- Source of truth:
|
||||
|
||||
## Назначение
|
||||
|
||||
## Контекст
|
||||
|
||||
## Роль в доменной модели
|
||||
|
||||
## Атрибуты
|
||||
|
||||
| attribute | type | required | description | constraints |
|
||||
|-----------|------|----------|-------------|-------------|
|
||||
| | | | | |
|
||||
|
||||
## Состояния и жизненный цикл
|
||||
|
||||
### Основные состояния
|
||||
-
|
||||
|
||||
### Переходы состояний
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Инварианты и ограничения
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Связи с другими сущностями
|
||||
|
||||
| entity | relation | description |
|
||||
|--------|----------|-------------|
|
||||
| | | |
|
||||
|
||||
## Использование в системе
|
||||
|
||||
### Related API
|
||||
-
|
||||
|
||||
### Related UI
|
||||
-
|
||||
|
||||
### Related logic
|
||||
-
|
||||
|
||||
### Related integrations
|
||||
-
|
||||
|
||||
## Функциональные требования
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Нефункциональные требования
|
||||
|
||||
### Audit / history
|
||||
-
|
||||
|
||||
### Security
|
||||
-
|
||||
|
||||
### Observability
|
||||
-
|
||||
|
||||
## Связанный код
|
||||
|
||||
### Files
|
||||
-
|
||||
|
||||
### Symbols
|
||||
-
|
||||
|
||||
## Связанные документы
|
||||
-
|
||||
|
||||
## История изменений
|
||||
|
||||
| Date | Source | Changes |
|
||||
|------|--------|---------|
|
||||
| | | |
|
||||
@@ -0,0 +1,93 @@
|
||||
```md
|
||||
# {{title}}
|
||||
|
||||
## Summary
|
||||
- Purpose:
|
||||
- Trigger:
|
||||
- Inputs:
|
||||
- Outputs:
|
||||
- Main entities:
|
||||
- Main dependencies:
|
||||
- Side effects:
|
||||
- Source of truth:
|
||||
|
||||
## Назначение
|
||||
|
||||
## Контекст
|
||||
|
||||
## Технический use case
|
||||
|
||||
### Основной сценарий
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Альтернативные ветки
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Функциональные требования
|
||||
|
||||
### Preconditions
|
||||
-
|
||||
|
||||
### Processing rules
|
||||
-
|
||||
|
||||
### Validation rules
|
||||
-
|
||||
|
||||
### Output / result rules
|
||||
-
|
||||
|
||||
### Side effects
|
||||
-
|
||||
|
||||
## Ограничения и условия вызова
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Нефункциональные требования
|
||||
|
||||
### Security
|
||||
-
|
||||
|
||||
### Observability
|
||||
- Logs:
|
||||
- Metrics:
|
||||
- Traces:
|
||||
- Audit:
|
||||
|
||||
### Reliability
|
||||
-
|
||||
-
|
||||
|
||||
### Performance
|
||||
-
|
||||
|
||||
## Связанные API / UI / integration points
|
||||
-
|
||||
|
||||
## Связанные сущности
|
||||
-
|
||||
|
||||
## Связанный код
|
||||
|
||||
### Files
|
||||
-
|
||||
|
||||
### Symbols
|
||||
-
|
||||
|
||||
## Связанные документы
|
||||
-
|
||||
|
||||
## История изменений
|
||||
|
||||
| Date | Source | Changes |
|
||||
|------|--------|---------|
|
||||
| | | |
|
||||
```
|
||||
@@ -0,0 +1,97 @@
|
||||
# {{title}}
|
||||
|
||||
## Summary
|
||||
- Purpose:
|
||||
- Actor:
|
||||
- Trigger:
|
||||
- Route:
|
||||
- Main API:
|
||||
- Main entities:
|
||||
- Main logic:
|
||||
- Main states:
|
||||
- Source of truth:
|
||||
|
||||
## Назначение
|
||||
|
||||
## Контекст
|
||||
|
||||
## Технический use case
|
||||
|
||||
### Основной сценарий
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
### Альтернативные ветки
|
||||
|
||||
-
|
||||
-
|
||||
|
||||
## Описание UI
|
||||
|
||||
## UI Elements
|
||||
|
||||
| id | type | label | data_source | default / placeholder | validation | behavior |
|
||||
|----|------|-------|-------------|------------------------|------------|----------|
|
||||
| | | | | | | |
|
||||
|
||||
## Функциональные требования
|
||||
|
||||
### Input rules
|
||||
-
|
||||
|
||||
### State rules
|
||||
-
|
||||
|
||||
### Navigation rules
|
||||
-
|
||||
|
||||
### Client-side validation
|
||||
-
|
||||
|
||||
## Нефункциональные требования
|
||||
|
||||
### Security
|
||||
-
|
||||
|
||||
### Observability
|
||||
- Logs:
|
||||
- Metrics:
|
||||
- Traces:
|
||||
- Analytics:
|
||||
|
||||
### Accessibility
|
||||
-
|
||||
|
||||
### Performance
|
||||
-
|
||||
|
||||
### Feature toggles
|
||||
-
|
||||
|
||||
## Связанные API
|
||||
-
|
||||
|
||||
## Связанные блоки логики
|
||||
-
|
||||
|
||||
## Связанные сущности
|
||||
-
|
||||
|
||||
## Связанный код
|
||||
|
||||
### Files
|
||||
-
|
||||
|
||||
### Symbols
|
||||
-
|
||||
|
||||
## Связанные документы
|
||||
-
|
||||
|
||||
## История изменений
|
||||
|
||||
| Date | Source | Changes |
|
||||
|------|--------|---------|
|
||||
| | | |
|
||||
Reference in New Issue
Block a user