Поделиться через

Запись решения об архитектуре

  • Статья

Запись решения архитектуры (ADR) является одним из наиболее важных результатов архитектора решения. Эта запись документирует архитектурные решения, принятые на протяжении всего процесса проектирования. Он также предоставляет конкретные контекстные обоснование и последствия для каждого решения.

ADR документирует все ключевые решения, включая альтернативы, которые вы исключили, для архитектурно значимых требований. Журнал включает требования и ограничения в документированные эффекты принятия решения.

Реализация ADR

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

Предлагаемые характеристики отдельной записи

  • Будьте согласованы с анатомией каждой записи. Создайте шаблон записи и последовательно следуйте ему.

    Запись должна содержать согласованные элементы, такие как:

    • Оператор проблемы с контекстом
    • Варианты, которые рассматриваются
    • Результат принятия решений
      • Включение важных компромиссов, принятых с этим решением
      • Запишите уровень достоверности решения. Иногда архитектурно значительное решение принимается с относительно низкой уверенностью. Документируя, что статус низкой достоверности может оказаться полезным для будущих решений о пересмотре.

  • Разорвать одно решение на несколько, если архитектурное решение приведет к нескольким этапам, таким как краткосрочные, промежуточные, долгосрочные подходы. Запишите каждый этап в качестве собственной записи принятия решений.

  • Избегайте скрытия последствий принятия решений намеренно или случайно.

  • Сохраняйте записи пити, утверждающие, по теме и фактуальные.

  • Избегайте принятия решений в руководствах по проектированию. Если доступно больше оправданий или идей проектирования, предоставьте ссылку на документ в качестве дополнительного материала, но решение должно быть ясно и автономно без этого материала.

Репозиторий документации по рабочей нагрузке

Этот журнал должен быть легко доступен и храниться открыто с помощью документации рабочей нагрузки.

Архитектор может помочь группе рабочей нагрузки достичь рекомендаций по операционному превосходству, помогая создать и сохранить документ и репозиторий активов. Архитекторы помогают командам поместить все свои ресурсы в репозиторий, например в этот журнал принятия решений. Они также поощряют унифицированное внедрение единого источника истины для использования для справки, аудита и реагирования на инциденты.

Следующие шаги

Контрольный список архитектора

Дополнительные ресурсы

Примеры шаблонов см. в организации GitHub для записи архитектурных решений.