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

Це шаблон ADR для EdgeX Foundry.

Перелічіть авторів пропозиції ADR.

Формат:

Журнал змін

Перелічіть зміни до документа, зокрема стан, дату та URL запиту на злиття (PR).

Стан — один із: pending, approved, amended, deprecated.

Дата — рядок у форматі ISO 8601 (РРРР-ММ-ДД).

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

Формат:

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

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

Формат:

Додайте пояснення, якщо ADR не охоплює всі вимоги сценарію використання.

Опишіть:

чим проєкт є архітектурно значущим — що виправдовує ADR (на відміну від простого запиту на виправлення проблеми та PR)
високорівневий підхід до проєктування (подробиці описано нижче в пропонованому проєкті)

Подробиці проєкту (за можливості без заглиблення в реалізацію).

План:

сервіси/модулі, на які вплине (які зміняться)
нові сервіси/модулі, які буде додано
вплив на модель і DTO (зміни/додавання/вилучення)
вплив на API (зміни/додавання/вилучення)
вплив на загальну конфігурацію (створення нових розділів, зміни/додавання/вилучення)
вплив на DevOps

Задокументуйте альтернативи, занепокоєння, додаткові чи пов’язані питання, запитання, що виникли в обговоренні ADR.

Вкажіть, чи і як їх було вирішено або пом’якшено.

Задокументуйте будь-які узгоджені важливі деталі реалізації, застереження, міркування на майбутнє, нерозв’язані або відкладені питання проєктування.

Задокументуйте будь-яку частину вимог, яку пропонований проєкт не задовольняє.

Перелічіть усі релевантні ADR — наприклад, проєктне рішення для підкомпонента функції, проєкт, що застарів унаслідок цього проєкту тощо.

Формат:

Перелічіть додаткові посилання.

Формат: