Architecture Decision Recordແມ່ແບບບັນທຶກການຕັດສິນໃຈດ້ານສະຖາປັດຕະຍະກຳ (ADR)
ນີ້ແມ່ນແມ່ແບບສຳລັບ ADR ຂອງ EdgeX Foundry.
ແຫຼ່ງທີ່ມາ: https://docs.edgexfoundry.org/2.3/design/adr/template/
ຜູ້ສົ່ງ
ລະບຸລາຍຊື່ຜູ້ສົ່ງ ADR.
ຮູບແບບ:
- ຊື່ (ອົງກອນ)
ບັນທຶກການປ່ຽນແປງ
ລະບຸການປ່ຽນແປງຂອງເອກະສານ ລວມທັງສະຖານະ, ວັນທີ ແລະ URL ຂອງ PR.
ສະຖານະເປັນໜຶ່ງໃນ: pending, approved, amended, deprecated.
ວັນທີເປັນສະຕຣິງ ISO 8601 (YYYY-MM-DD).
PR ແມ່ນ pull request ທີ່ສົ່ງການປ່ຽນແປງ ລວມທັງຂໍ້ມູນເຊັ່ນ diff, ຜູ້ປະກອບສ່ວນ ແລະ ຜູ້ທົບທວນ.
ຮູບແບບ:
- [Status of ADR e.g. approved, amended, etc.](URL of pull request) YYYY-MM-DD
ກໍລະນີການນຳໃຊ້ທີ່ອ້າງອີງ
ລະບຸເອກະສານກໍລະນີການນຳໃຊ້ / ຄວາມຕ້ອງການທີ່ກ່ຽວຂ້ອງທັງໝົດ.
ADR ຕ້ອງມີກໍລະນີການນຳໃຊ້ທີ່ກ່ຽວຂ້ອງ ແລະ ໄດ້ຮັບການອະນຸມັດຢ່າງໜ້ອຍໜຶ່ງກໍລະນີ.
ຮູບແບບ:
- [Use Case Name](URL)
ເພີ່ມຄຳອະທິບາຍຖ້າ ADR ບໍ່ໄດ້ກ່າວເຖິງຄວາມຕ້ອງການທັງໝົດຂອງກໍລະນີການນຳໃຊ້.
ບໍລິບົດ
ອະທິບາຍ:
ການອອກແບບມີນັຍສຳຄັນຕໍ່ສະຖາປັດຕະຍະກຳແນວໃດ - ຈຶ່ງຕ້ອງມີ ADR (ແທນທີ່ຈະເປັນພຽງ issue ແລະ PR ທຳມະດາເພື່ອແກ້ບັນຫາ)
ແນວທາງການອອກແບບລະດັບສູງ (ລາຍລະອຽດຢູ່ໃນການອອກແບບທີ່ສະເໜີຂ້າງລຸ່ມ)
ການອອກແບບທີ່ສະເໜີ
ລາຍລະອຽດຂອງການອອກແບບ (ໂດຍບໍ່ເຂົ້າສູ່ການປະຕິບັດ ເມື່ອເປັນໄປໄດ້).
ໂຄງຮ່າງ:
ບໍລິການ/ໂມດູນທີ່ໄດ້ຮັບຜົນກະທົບ (ຖືກປ່ຽນແປງ)
ບໍລິການ/ໂມດູນໃໝ່ທີ່ຈະເພີ່ມ
ຜົນກະທົບຕໍ່ແບບຈຳລອງ ແລະ DTO (ການປ່ຽນແປງ/ການເພີ່ມ/ການລຶບ)
ຜົນກະທົບຕໍ່ API (ການປ່ຽນແປງ/ການເພີ່ມ/ການລຶບ)
ຜົນກະທົບຕໍ່ການຕັ້ງຄ່າທົ່ວໄປ (ການສ້າງພາກໃໝ່, ການປ່ຽນແປງ/ການເພີ່ມ/ການລຶບ)
ຜົນກະທົບຕໍ່ devops
ຂໍ້ພິຈາລະນາ
ບັນທຶກທາງເລືອກ, ຄວາມກັງວົນ, ປະເດັນເສີມ ຫຼື ປະເດັນທີ່ກ່ຽວຂ້ອງ, ແລະ ຄຳຖາມທີ່ເກີດຂຶ້ນໃນການໂຕ້ວາທີກ່ຽວກັບ ADR.
ລະບຸວ່າພວກມັນຖືກແກ້ໄຂ ຫຼື ບັນເທົາແລ້ວຫຼືບໍ່ ແລະ ແນວໃດ.
ການຕັດສິນໃຈ
ບັນທຶກລາຍລະອຽດການປະຕິບັດທີ່ສຳຄັນທີ່ຕົກລົງກັນ, ຂໍ້ຄວນລະວັງ, ຂໍ້ພິຈາລະນາໃນອະນາຄົດ, ປະເດັນການອອກແບບທີ່ເຫຼືອ ຫຼື ເລື່ອນໄວ້.
ບັນທຶກສ່ວນໃດຂອງຄວາມຕ້ອງການທີ່ການອອກແບບທີ່ສະເໜີບໍ່ໄດ້ຕອບສະໜອງ.
ADR ອື່ນທີ່ກ່ຽວຂ້ອງ
ລະບຸ ADR ທີ່ກ່ຽວຂ້ອງ - ເຊັ່ນ ການຕັດສິນໃຈອອກແບບສຳລັບອົງປະກອບຍ່ອຍຂອງຄຸນສົມບັດ, ການອອກແບບທີ່ເລີກໃຊ້ຍ້ອນການອອກແບບນີ້ ແລະ ອື່ນໆ.
ຮູບແບບ:
- [ADR Title](URL) - ຄວາມກ່ຽວຂ້ອງ
ເອກະສານອ້າງອີງ
ລະບຸເອກະສານອ້າງອີງເພີ່ມເຕີມ.
ຮູບແບບ:
- [Title](URL)