Architecture Decision Record
← Mga template ng tala ng desisyon

Template ng Architecture Decision Record (ADR)

Ito ay template para sa ADR ng EdgeX Foundry.

Pinagmulan: https://docs.edgexfoundry.org/2.3/design/adr/template/

Mga Nagsumite

Ilista ang mga nagsumite ng ADR.

Format:

  • Pangalan (Organisasyon)

Change Log

Ilista ang mga pagbabago sa dokumento, kasama ang estado, petsa, at URL ng PR.

Ang estado ay isa sa: pending, approved, amended, deprecated.

Ang petsa ay isang ISO 8601 (YYYY-MM-DD) na string.

Ang PR ay ang pull request na nagsumite ng pagbabago, kasama ang impormasyon tulad ng diff, mga contributor, at mga reviewer.

Format:

  • [Status of ADR e.g. approved, amended, etc.](URL of pull request) YYYY-MM-DD

Mga Tinutukoy na Use Case

Ilista ang lahat ng kaugnay na dokumento ng use case / requirement.

Nangangailangan ang ADR ng kahit isang kaugnay at aprubadong use case.

Format:

  • [Use Case Name](URL)

Magdagdag ng mga paliwanag kung hindi tinutugunan ng ADR ang lahat ng requirement ng isang use case.

Konteksto

Ilarawan:

  • kung paano mahalaga ang disenyo sa arkitektura - na nagbibigay-katwiran sa isang ADR (kumpara sa simpleng isyu at PR para ayusin ang problema)

  • ang mataas na antas na pamamaraan sa disenyo (inilalarawan ang mga detalye sa iminungkahing disenyo sa ibaba)

Iminungkahing Disenyo

Mga detalye ng disenyo (nang hindi pumapasok sa implementasyon hangga't maaari).

Balangkas:

  • mga serbisyo/module na maaapektuhan (babaguhin)

  • mga bagong serbisyo/module na idaragdag

  • epekto sa model at DTO (mga pagbabago/dagdag/pagtanggal)

  • epekto sa API (mga pagbabago/dagdag/pagtanggal)

  • pangkalahatang epekto sa configuration (pagtatatag ng mga bagong seksyon, mga pagbabago/dagdag/pagtanggal)

  • epekto sa devops

Mga Konsiderasyon

Idokumento ang mga alternatibo, alalahanin, pantulong o kaugnay na isyu, at mga tanong na lumitaw sa debate tungkol sa ADR.

Ipahiwatig kung/paano ang mga ito nalutas o napakalma.

Desisyon

Idokumento ang anumang napagkasunduang mahalagang detalye ng implementasyon, mga paalala, mga konsiderasyon sa hinaharap, at natitira o ipinagpaliban na isyu sa disenyo.

Idokumento ang anumang bahagi ng mga requirement na hindi natugunan ng iminungkahing disenyo.

Iba Pang Kaugnay na ADR

Ilista ang anumang kaugnay na ADR - tulad ng desisyon sa disenyo para sa sub-component ng isang feature, disenyong ipinawalang-bisa dahil sa disenyong ito, atbp..

Format:

  • [ADR Title](URL) - Kaugnayan

Mga Sanggunian

Ilista ang karagdagang sanggunian.

Format:

  • [Title](URL)