Architecture Decision Record
← Templat rekod keputusan

Templat Rekod Keputusan Seni Bina (ADR)

Ini ialah templat untuk ADR EdgeX Foundry.

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

Penghantar

Senaraikan penghantar ADR.

Format:

  • Nama (Organisasi)

Log Perubahan

Senaraikan perubahan pada dokumen, termasuk keadaan, tarikh dan URL PR.

Keadaan ialah salah satu daripada: pending, approved, amended, deprecated.

Tarikh ialah rentetan ISO 8601 (YYYY-MM-DD).

PR ialah pull request yang menghantar perubahan itu, termasuk maklumat seperti diff, penyumbang dan penyemak.

Format:

  • [Status ADR cth. approved, amended dan sebagainya](URL pull request) YYYY-MM-DD

Kes Penggunaan yang Dirujuk

Senaraikan semua dokumen kes penggunaan / keperluan yang relevan.

ADR memerlukan sekurang-kurangnya satu kes penggunaan yang relevan dan diluluskan.

Format:

  • [Nama Kes Penggunaan](URL)

Tambah penjelasan jika ADR tidak menangani semua keperluan kes penggunaan.

Konteks

Huraikan:

  • bagaimana reka bentuk itu signifikan dari segi seni bina - menjamin ADR (berbanding isu dan PR mudah untuk membetulkan masalah)

  • pendekatan reka bentuk peringkat tinggi (butiran diterangkan dalam reka bentuk yang dicadangkan di bawah)

Reka Bentuk yang Dicadangkan

Butiran reka bentuk (tanpa memasuki pelaksanaan jika boleh).

Rangka:

  • perkhidmatan/modul yang akan terkesan (diubah)

  • perkhidmatan/modul baharu yang akan ditambah

  • kesan model dan DTO (perubahan/tambahan/pembuangan)

  • kesan API (perubahan/tambahan/pembuangan)

  • kesan konfigurasi am (penubuhan bahagian baharu, perubahan/tambahan/pembuangan)

  • kesan devops

Pertimbangan

Dokumenkan alternatif, kebimbangan, isu sampingan atau berkaitan, soalan yang timbul dalam perbahasan ADR.

Nyatakan sama ada/bagaimana ia diselesaikan atau dilembutkan.

Keputusan

Dokumenkan sebarang butiran pelaksanaan penting yang dipersetujui, kaveat, pertimbangan masa hadapan, isu reka bentuk yang tinggal atau ditangguhkan.

Dokumenkan mana-mana bahagian keperluan yang tidak dipenuhi oleh reka bentuk yang dicadangkan.

ADR Berkaitan Lain

Senaraikan sebarang ADR yang relevan - seperti keputusan reka bentuk untuk subkomponen sesuatu ciri, reka bentuk yang dimansuhkan akibat reka bentuk ini dan sebagainya.

Format:

  • [Tajuk ADR](URL) - Kerelevanan

Rujukan

Senaraikan rujukan tambahan.

Format:

  • [Tajuk](URL)