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

Това е шаблон за ADR на EdgeX Foundry.

Изброете подаващите ADR.

Формат:

Дневник на промените

Изброете промените в документа, вкл. състояние, дата и URL на pull request.

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

Датата е низ по ISO 8601 (YYYY-MM-DD).

PR е pull request, с който е подадена промяната, и включва информация като разликите, участниците и рецензентите.

Формат:

[Състояние на ADR, напр. approved, amended и т.н.](URL на pull request) YYYY-MM-DD

Изброете всички съответни документи със случаи на употреба / изисквания.

ADR изисква поне един съответен, одобрен случай на употреба.

Формат:

Добавете обяснения, ако ADR не обхваща всички изисквания на даден случай на употреба.

Опишете:

по какъв начин проектът е архитектурно значим — което оправдава ADR (вместо просто проблем и PR за отстраняването му)
общия подход към проектирането (подробностите са описани в предложения проект по-долу)

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

Очертайте:

услуги/модули, които ще бъдат засегнати (променени)
нови услуги/модули, които ще бъдат добавени
въздействие върху моделите и DTO (промени/добавяния/премахвания)
въздействие върху API (промени/добавяния/премахвания)
въздействие върху общата конфигурация (въвеждане на нови секции, промени/добавяния/премахвания)
въздействие върху devops

Документирайте алтернативите, опасенията, допълнителните или свързаните въпроси и въпросите, възникнали в дебата по ADR.

Посочете дали/как са били разрешени или смекчени.

Документирайте всички договорени важни подробности за реализацията, уговорки, бъдещи съображения, оставащи или отложени проблеми в проекта.

Документирайте всяка част от изискванията, която не е удовлетворена от предложения проект.

Изброете всички съответни ADR — например решение за проектиране на подкомпонент на функция, проект, отхвърлен в резултат на този проект и т.н..

Формат:

Изброете допълнителни препратки.

Формат: