Документация: README и ADR

Код рассказывает «что», доки — «почему» и «как запустить». Хорошая документация экономит часы каждому новому в проекте, включая вас через полгода.

README, который читают

• что делает проект (2 строки, без воды);
• как запустить: npm i → npm run dev, переменные env;
• структура и где лежит главное;
• как тестировать и деплоить, ссылки на доку авторов.

ADR — память решений

# ADR-007: кэшировать каталог через Redis
Дата: 2026-04-12
Контекст: чтений каталога в 50 раз больше записей
Решение: Redis с инвалидацией по тегу
Альтернативы: Nginx-кэш (нет инвалидации), без кэша (медленно)
Итог: p95 упал с 300 мс до 25 мс