Architecture Decision Record
← Cithakan cathetan keputusan

Cithakan Cathetan Keputusan Arsitektur (ADR)

Iki cithakan kanggo ADR EdgeX Foundry.

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

Pengaju

Dhaptaren para pengaju ADR.

Format:

  • Jeneng (Organisasi)

Log Owah-owahan

Dhaptaren owah-owahan ing dokumen, kalebu status, tanggal, lan URL PR.

Status yaiku salah sijine: pending, approved, amended, deprecated.

Tanggal yaiku string ISO 8601 (YYYY-MM-DD).

PR yaiku pull request sing ngaturake owah-owahan, kalebu informasi kayata diff, kontributor, lan peninjau.

Format:

  • [Status ADR kayata approved, amended, lan sapanunggalane](URL pull request) YYYY-MM-DD

Kasus Panggunaan sing Dirujuk

Dhaptaren kabeh dokumen kasus panggunaan / kabutuhan sing gegayutan.

ADR mbutuhake paling ora siji kasus panggunaan sing gegayutan lan wis disetujoni.

Format:

  • [Jeneng Kasus Panggunaan](URL)

Tambahna katrangan yen ADR ora nanggapi kabeh kabutuhan saka sawijining kasus panggunaan.

Konteks

Njlentrehake:

  • kepriye desain iki penting sacara arsitektural - sing mbenerake ADR (tinimbang mung issue lan PR sederhana kanggo ndandani masalah)

  • pendekatan desain tingkat dhuwur (rincian dijlentrehake ing desain sing diusulake ing ngisor)

Desain sing Diusulake

Rincian desain (tanpa mlebu implementasi menawa bisa).

Garis gedhe:

  • layanan/modul sing kena pengaruh (diowahi)

  • layanan/modul anyar sing ditambah

  • pengaruh marang model lan DTO (owah-owahan/tambahan/pambusakan)

  • pengaruh marang API (owah-owahan/tambahan/pambusakan)

  • pengaruh marang konfigurasi umum (nggawe bagean anyar, owah-owahan/tambahan/pambusakan)

  • pengaruh marang devops

Pertimbangan

Cathet alternatif, kuwatir, perkara tambahan utawa gegayutan, lan pitakon sing muncul nalika rembugan ADR.

Nuduhake yen/kepriye perkara-perkara kuwi dirampungake utawa dilunakake.

Keputusan

Cathet detail implementasi penting sing wis disepakati, peringatan, pertimbangan mbesuk, masalah desain sing isih ana utawa ditundha.

Cathet bagean kabutuhan apa wae sing ora dituhoni dening desain sing diusulake.

ADR Liyane sing Gegayutan

Dhaptaren ADR sing gegayutan - kayata keputusan desain kanggo subkomponen saka sawijining fitur, desain sing dibatalake amarga desain iki, lan sapanunggalane.

Format:

  • [Judhul ADR](URL) - Relevansi

Referensi

Dhaptaren referensi tambahan.

Format:

  • [Judhul](URL)