Добавил документацию и описание репозитория
This commit is contained in:
@@ -0,0 +1,22 @@
|
||||
# Спецификации
|
||||
|
||||
Живые документы о том, как устроена система — целевое и актуальное
|
||||
состояние. В отличие от ADR, спецификации **изменяемы**: их правят по
|
||||
мере развития проекта и держат в соответствии с кодом. В отличие от
|
||||
черновиков, описывают принятое и реализуемое, а не идеи.
|
||||
|
||||
## Соглашения
|
||||
|
||||
- Имя файла — `kebab-topic.md`, без дат (дата живёт в git-истории).
|
||||
- Одна спецификация — одна тема.
|
||||
- Если решение требует объяснения «почему именно так» с долгим следом —
|
||||
заведи ADR и сошлись на него из спецификации.
|
||||
|
||||
## Записи
|
||||
|
||||
- [architecture.md](architecture.md) — общее устройство: компоненты,
|
||||
поток, машина состояний, хранилище, конфигурация.
|
||||
- [recognition.md](recognition.md) — распознавание контента и модель
|
||||
уверенности.
|
||||
- [jellyfin-layout.md](jellyfin-layout.md) — конвенции именования файлов
|
||||
Jellyfin, в которые раскладываем.
|
||||
Reference in New Issue
Block a user