Перейти к содержанию

Записи архитектурных решений

Эта папка — индекс и дом для записей архитектурных решений (ADR). ADR фиксируют долговечные решения, которые дорого отменять или легко неверно понять позже. Они не заменяют описание текущей архитектуры: обновляйте его, когда принятое решение меняет реализованную архитектуру.

Когда нужна ADR

Создайте ADR для таких решений:

  • новое или изменённое направление зависимостей модуля, сборки или пакета;
  • перенос владения между компонентами или репозиториями;
  • сохраняемый формат, стабильный идентификатор, сериализация или стратегия миграции;
  • стратегия платформы, сборки или развёртывания;
  • контракт проверки или CI, который становится авторитетным;
  • принятие или замена базовой зависимости.

Небольшие локальные решения реализации обычно ADR не требуют.

Имена и жизненный цикл

Используйте NNNN-short-kebab-case-title.md, начиная с 0001. Создавайте записи командой embraion adr new "<title>": она копирует 0000-template.md, выбирает следующий свободный номер и добавляет запись в индекс ниже. Номера ADR не используются повторно.

Статусы:

  • Proposed: на рассмотрении, не авторитетна;
  • Accepted: управляет новой работой;
  • Superseded: заменена более поздней ADR со ссылками в обе стороны;
  • Deprecated: сохранена для истории, но больше не рекомендуется;
  • Rejected: рассмотрена и явно не принята.

Принятая ADR неизменна, кроме исправлений опечаток и ссылок, а также метаданных статуса и замены. Чтобы изменить решение, добавьте новую ADR, которая объясняет и заменяет старую.

Индекс

ADR Статус Решение
0000-template.md Шаблон Скопируйте этот файл, когда записываете решение.
0001-git-is-a-prerequisite-git-mechanics-live-in-one-place.md Accepted Git — предварительное требование; механика Git собрана в одном месте

Last updated: 2026-10-07 11:10 UTC