1. Документирование архитектурных решений

[к списку решений]

Дата: 2025-01-21

Статус

Принято

Контекст

Требуется документировать архитектурно значимые решения проекта, включая все варианты, которые рассматривались.

Решение

Использовать формат ADR (Architecture Decision Records), описанный в статье. Статусы решений:

  • Предложено («Proposed»)
  • Принято («Accepted»)
  • Устарело («Deprecated») - со временем ситуация изменилась, нужно думать о более новом решении
  • Заменено («Superseded») - более новое решение вступило в силу, заменив данное

Что даст внедрение решения?

Файлы с именами вида НомерРешения-ИмяРешения.md, где НомерРешения имеет вид 0001, 0002 и т.д.; 4 цифры с ведущими нулями нужны для сортировки файлов по имени. Этот номер (без ведущих нулей) является уникальным ID решения.