Architecture Decision Record
← Шаблоны записей решений

Шаблон записи архитектурного решения (ADR)

Это шаблон ADR для EdgeX Foundry.

Источник: https://docs.edgexfoundry.org/2.3/design/adr/template/

Авторы заявки

Перечислите авторов ADR.

Формат:

  • Имя (Организация)

Журнал изменений

Перечислите изменения документа, включая состояние, дату и URL запроса на слияние.

Состояние — одно из: pending, approved, amended, deprecated.

Дата — строка ISO 8601 (YYYY-MM-DD).

PR — запрос на слияние, которым было внесено изменение, включая такую информацию, как diff, участники и рецензенты.

Формат:

  • [Состояние ADR, например approved, amended и т. д.](URL запроса на слияние) YYYY-MM-DD

Связанные сценарии использования

Перечислите все уместные документы со сценариями использования / требованиями.

Для ADR требуется как минимум один уместный утверждённый сценарий использования.

Формат:

  • [Название сценария использования](URL)

Добавьте пояснения, если ADR не охватывает все требования сценария использования.

Контекст

Опишите:

  • чем проект архитектурно значим, что оправдывает ADR (в отличие от простой задачи и PR для исправления проблемы)

  • общий подход к проектированию (подробности описаны в предлагаемом проекте ниже)

Предлагаемый проект

Подробности проекта (по возможности без перехода к реализации).

План:

  • службы/модули, на которые повлияют (будут изменены)

  • новые службы/модули, которые будут добавлены

  • влияние на модель и DTO (изменения/добавления/удаления)

  • влияние на API (изменения/добавления/удаления)

  • влияние на общую конфигурацию (создание новых разделов, изменения/добавления/удаления)

  • влияние на devops

Соображения

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

Укажите, были ли они и как именно разрешены или смягчены.

Решение

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

Задокументируйте любую часть требований, не удовлетворённую предлагаемым проектом.

Другие связанные ADR

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

Формат:

  • [Название ADR](URL) — уместность

Ссылки

Перечислите дополнительные ссылки.

Формат:

  • [Название](URL)