Files
voidea/template/docs/decision-log.md
T

58 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Decision Log
Лёгкий трекер каждодневных решений.
В отличие от ADR (фиксируют архитектуру), Decision Log фиксирует **контекст** — почему мы сделали тот или иной выбор.
Через 3 месяца никто не вспомнит "почему мы взяли SQLite", а Decision Log напомнит.
---
## Формат записи
```markdown
## {YYYY-MM-DD}: {Решение}
**Контекст:** {Почему встал вопрос, какие были ограничения}
**Решение:** {Что выбрали}
**Альтернативы:** {Что рассматривали, почему не взяли}
**Кто:** {Кто принял решение}
**Статус:** {действует | пересмотреть через N | заменено}
```
---
## Пример
```markdown
## 2026-05-10: Выбрали SQLite для разработки
**Контекст:** У команды Windows, PostgreSQL требует установки и настройки.
На старте важна скорость — поднять проект за 5 минут, а не за час.
**Решение:** SQLite + aiosqlite для локальной разработки.
PostgreSQL — только на production.
**Альтернативы:**
- PostgreSQL + Docker — работает, но Docker не у всех
- PostgreSQL native — адская установка на Windows
**Кто:** @owner
**Статус:** действует. Пересмотреть перед production.
```
---
## Когда создавать запись
- Выбрали технологию (БД, провайдер, фреймворк)
- Отложили функциональность (не делаем OAuth сейчас)
- Изменили подход (было sessions, стало JWT)
- Архитектурный компромисс (знаем что не идеально, но время поджимает)
---
## [ASK]
- Вести Decision Log в Markdown или в YAML? (Markdown — читаемость)
- Хранить в репозитории или в Notion/wiki? (в репозитории — git history + доступность)
- Кто заполняет? (тот, кто принял решение, сразу)