27 lines
1.7 KiB
Markdown
27 lines
1.7 KiB
Markdown
# Спецификации
|
|
|
|
Живые документы о том, как устроена система — целевое и актуальное
|
|
состояние. В отличие от ADR, спецификации **изменяемы**: их правят по
|
|
мере развития проекта и держат в соответствии с кодом. В отличие от
|
|
черновиков, описывают принятое и реализуемое, а не идеи.
|
|
|
|
## Соглашения
|
|
|
|
- Имя файла — `kebab-topic.md`, без дат (дата живёт в git-истории).
|
|
- Одна спецификация — одна тема.
|
|
- Если решение требует объяснения «почему именно так» с долгим следом —
|
|
заведи ADR и сошлись на него из спецификации.
|
|
|
|
## Записи
|
|
|
|
- [architecture.md](architecture.md) — общее устройство: компоненты,
|
|
транспорты, хранилище, раскладка, деплой.
|
|
- [workflow.md](workflow.md) — жизненный цикл загрузки: машина состояний,
|
|
переходы, сопоставление состояний qBittorrent.
|
|
- [recognition.md](recognition.md) — распознавание контента и модель
|
|
уверенности.
|
|
- [review-ux.md](review-ux.md) — ревью раскладки человеком: UI/UX-сценарии
|
|
на случай, когда система не уверена.
|
|
- [jellyfin-layout.md](jellyfin-layout.md) — конвенции именования файлов
|
|
Jellyfin, в которые раскладываем.
|