Architecture Decision Record
← Mudelli ta' rekords ta' deċiżjoni

Mudell ta' Rekord ta' Deċiżjoni Arkitettonika (ADR)

Dan huwa mudell għall-ADR ta' EdgeX Foundry.

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

Min ressaq

Elenka min ressaq l-ADR.

Format:

  • Isem (Organizzazzjoni)

Reġistru tal-bidliet

Elenka l-bidliet fid-dokument, inkluż l-istat, id-data, u l-URL tal-PR.

L-istat huwa wieħed minn: pending, approved, amended, deprecated.

Id-data hija string ISO 8601 (YYYY-MM-DD).

Il-PR huwa l-pull request li ressaq il-bidla, inklużi informazzjoni bħad-diff, il-kontributuri, u r-reviżuri.

Format:

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

Każijiet ta' użu referuti

Elenka d-dokumenti rilevanti kollha tal-każijiet ta' użu / tar-rekwiżiti.

L-ADR jeħtieġ mill-inqas każ ta' użu rilevanti wieħed u approvat.

Format:

  • [Use Case Name](URL)

Żid spjegazzjonijiet jekk l-ADR ma jindirizzax ir-rekwiżiti kollha ta' każ ta' użu.

Kuntest

Iddeskrivi:

  • kif id-disinn huwa sinifikanti mil-lat arkitettoniku - li jiġġustifika ADR (kontra sempliċi issue u PR biex titranġa problema)

  • l-approċċ tad-disinn f'livell għoli (id-dettalji huma deskritti fid-disinn propost hawn taħt)

Disinn propost

Dettalji tad-disinn (mingħajr ma tidħol fl-implimentazzjoni fejn possibbli).

Skeda:

  • servizzi/moduli li se jiġu affettwati (mibdula)

  • servizzi/moduli ġodda li se jiżdiedu

  • impatt fuq il-mudell u d-DTO (bidliet/żidiet/tneħħijiet)

  • impatt fuq l-API (bidliet/żidiet/tneħħijiet)

  • impatt fuq il-konfigurazzjoni ġenerali (twaqqif ta' sezzjonijiet ġodda, bidliet/żidiet/tneħħijiet)

  • impatt fuq id-devops

Konsiderazzjonijiet

Iddokumenta alternattivi, tħassib, kwistjonijiet aċċessorji jew relatati, mistoqsijiet li qamu fid-dibattitu dwar l-ADR.

Indika jekk/kif ġew solvuti jew mmaljati.

Deċiżjoni

Iddokumenta kwalunkwe dettall importanti ta' implimentazzjoni li ntlaħaq ftehim dwaru, twissijiet, konsiderazzjonijiet futuri, kwistjonijiet ta' disinn li fadal jew li ġew posposti.

Iddokumenta kwalunkwe parti tar-rekwiżiti li ma ġietx sodisfatta mid-disinn propost.

ADR oħra relatati

Elenka kwalunkwe ADR rilevanti - bħal deċiżjoni ta' disinn għal sub-komponent ta' karatteristika, disinn li ġie deprekat b'riżultat ta' dan id-disinn, eċċ..

Format:

  • [ADR Title](URL) - Rilevanza

Referenzi

Elenka referenzi addizzjonali.

Format:

  • [Title](URL)