Architecture Decision Record

Active theme: Light

← เอกสาร

ข้อเสนอแนะในการเขียน ADR ที่ดี

ลักษณะของ ADR ที่ดี:

  • เหตุผล: อธิบายว่าทำไมจึงดำเนิน AD ซึ่งอาจรวมถึงบริบท (ดูด้านล่าง) ข้อดีข้อเสียของทางเลือกที่เป็นไปได้ต่าง ๆ การเปรียบเทียบฟีเจอร์ การอภิปรายต้นทุนและผลประโยชน์ และอื่น ๆ

  • เฉพาะเจาะจง: แต่ละ ADR ควรเกี่ยวกับ AD หนึ่งรายการ ไม่ใช่หลาย AD

  • มีการประทับเวลา: ระบุว่ารายการแต่ละรายการใน ADR เขียนเมื่อใด ซึ่งสำคัญเป็นพิเศษสำหรับแง่มุมที่อาจเปลี่ยนไปตามเวลา เช่น ต้นทุน กำหนดการ การขยาย และอื่น ๆ

  • แก้ไขไม่ได้: อย่าเปลี่ยนข้อมูลที่มีอยู่ใน ADR ให้แก้ไข ADR โดยเพิ่มข้อมูลใหม่แทน หรือแทนที่ ADR ด้วยการสร้าง ADR ใหม่

ลักษณะของส่วน "บริบท" ที่ดีใน ADR:

  • อธิบายสถานการณ์ขององค์กรและลำดับความสำคัญทางธุรกิจ

  • รวมเหตุผลและข้อพิจารณาที่อิงจากองค์ประกอบทางสังคมและทางเทคนิคของทีม

  • รวมข้อแลกเปลี่ยนที่เกี่ยวข้อง แสดงในคำที่ตรงกับความต้องการและเป้าหมาย

ลักษณะของส่วน "ผลที่ตามมา" ที่ดีใน ADR:

  • อธิบายสิ่งที่ตามมาจากการตัดสินใจ ซึ่งอาจรวมถึงผลกระทบ ผลลัพธ์ ผลงานส่งมอบ การดำเนินการติดตามผล และอื่น ๆ

  • รวมข้อมูลเกี่ยวกับ ADR ที่ตามมา เป็นเรื่องที่พบได้ค่อนข้างบ่อยที่ ADR หนึ่งทำให้เกิดความจำเป็นต้องมี ADR เพิ่มเติม เช่น เมื่อ ADR หนึ่งเลือกทางเลือกใหญ่ครอบคลุม ก็อาจก่อให้เกิดความจำเป็นต้องมีการตัดสินใจย่อยลงมา

  • รวมกระบวนการทบทวนย้อนหลัง เป็นเรื่องปกติที่ทีมจะทบทวนแต่ละ ADR หลังหนึ่งเดือน เปรียบเทียบข้อมูล ADR กับสิ่งที่เกิดขึ้นจริง แล้วเรียนรู้และเติบโตจากสิ่งนั้น

ADR ใหม่อาจแทนที่ ADR ก่อนหน้า:

  • เมื่อมีการทำ AD ที่แทนที่หรือทำให้ ADR ก่อนหน้าเป็นโมฆะ ควรเขียน ADR ใหม่