Architecture Decision Record
← Violezo vya rekodi za maamuzi

Kiolezo cha Rekodi ya Uamuzi wa Usanifu (ADR)

Hiki ni kiolezo cha ADR ya EdgeX Foundry.

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

Wawasilishaji

Orodhesha wawasilishaji wa ADR.

Muundo:

  • Jina (Shirika)

Kumbukumbu ya Mabadiliko

Orodhesha mabadiliko kwenye hati, ikiwa ni pamoja na hali, tarehe, na URL ya PR.

Hali ni mojawapo ya: pending, approved, amended, deprecated.

Tarehe ni mfuatano wa ISO 8601 (YYYY-MM-DD).

PR ni pull request iliyowasilisha badiliko, ikijumuisha taarifa kama tofauti, wachangiaji, na wakaguzi.

Muundo:

  • [Hali ya ADR mf. approved, amended, n.k.](URL ya pull request) YYYY-MM-DD

Visa vya Matumizi Vinavyorejelewa

Orodhesha hati zote husika za visa vya matumizi / mahitaji.

ADR inahitaji angalau kisa kimoja cha matumizi kilicho husika na kilichoidhinishwa.

Muundo:

  • [Jina la Kisa cha Matumizi](URL)

Ongeza maelezo ikiwa ADR haishughulikii mahitaji yote ya kisa cha matumizi.

Muktadha

Eleza:

  • jinsi muundo ulivyo muhimu kiusanifu - unaostahili ADR (badala ya suala rahisi na PR kurekebisha tatizo)

  • mbinu ya muundo ya kiwango cha juu (maelezo yameelezwa katika muundo uliopendekezwa hapa chini)

Muundo Uliopendekezwa

Maelezo ya muundo (bila kuingia kwenye utekelezaji inapowezekana).

Muhtasari:

  • huduma/moduli zitakazoathiriwa (kubadilishwa)

  • huduma/moduli mpya zitakazoongezwa

  • athari kwenye modeli na DTO (mabadiliko/nyongeza/uondoaji)

  • athari kwenye API (mabadiliko/nyongeza/uondoaji)

  • athari kwenye usanidi wa jumla (kuanzishwa kwa sehemu mpya, mabadiliko/nyongeza/uondoaji)

  • athari kwenye devops

Mazingatio

Andika njia mbadala, wasiwasi, masuala ya ziada au yanayohusiana, maswali yaliyoibuka katika mjadala wa ADR.

Onyesha kama/jinsi yalivyotatuliwa au kupunguzwa makali.

Uamuzi

Andika maelezo yoyote muhimu ya utekelezaji yaliyokubaliwa, tahadhari, mazingatio ya baadaye, masuala ya muundo yaliyobaki au yaliyoahirishwa.

Andika sehemu yoyote ya mahitaji isiyotimizwa na muundo uliopendekezwa.

ADR Nyingine Zinazohusiana

Orodhesha ADR zozote husika - kama uamuzi wa muundo wa kijenzi kidogo cha kipengele, muundo uliopitwa na wakati kutokana na muundo huu, n.k.

Muundo:

  • [Kichwa cha ADR](URL) - Umuhimu

Marejeleo

Orodhesha marejeleo ya ziada.

Muundo:

  • [Kichwa](URL)