Индекс Шаблонов Документации
Раздел docs/99-templates является нормативным источником шаблонов. Этот файл оставлен как короткий индекс и точка входа из старых ссылок.
Основные Шаблоны
- Индекс шаблонов
- ADR Template
- API Method Template
- Command/Query Template — правило CQRS (api-method/consumer ссылаются на него)
- Consumer Template
- Entity Template
- Event Contract Template
- Model Template
- Runbook Template
- Service README Template
- Task Specification Template
- System Scenario Template
Связанные Правила
- Общие требования к документам — реестр «один дом на концепт», алгоритм, диаграммы.
- Правила документирования алгоритма — каноничная структура раздела
## Алгоритм(на реальном SDKTalent.Common.*).
Правило Использования
- Для нового документа сначала выбирается шаблон из
docs/99-templates. - Если подходящего шаблона нет, сначала расширяется
docs/99-templates, затем создается рабочий документ. - Локальные ad hoc форматы без обновления общего шаблона запрещены.