Architecture Decision Record

Active theme: Light

← tài-liệu

Gợi ý viết ADR tốt

Đặc điểm của một ADR tốt:

  • Lý do: Giải thích lý do thực hiện AD cụ thể đó. Điều này có thể bao gồm bối cảnh (xem bên dưới), ưu và nhược điểm của các lựa chọn tiềm năng khác nhau, so sánh tính năng, thảo luận chi phí/lợi ích, và nhiều hơn nữa.

  • Cụ thể: Mỗi ADR nên nói về một AD, không phải nhiều AD.

  • Dấu thời gian: Xác định thời điểm mỗi mục trong ADR được viết. Điều này đặc biệt quan trọng đối với các khía cạnh có thể thay đổi theo thời gian, như chi phí, lịch trình, mở rộng quy mô và những thứ tương tự.

  • Bất biến: Đừng thay đổi thông tin hiện có trong ADR. Thay vào đó, hãy sửa đổi ADR bằng cách thêm thông tin mới, hoặc thay thế ADR bằng cách tạo một ADR mới.

Đặc điểm của một phần "Bối cảnh" tốt trong ADR:

  • Giải thích tình hình của tổ chức bạn và các ưu tiên kinh doanh.

  • Bao gồm lý do và các cân nhắc dựa trên cấu thành xã hội và kỹ năng của các nhóm của bạn.

  • Bao gồm các ưu và nhược điểm liên quan, và mô tả chúng theo cách phù hợp với nhu cầu và mục tiêu của bạn.

Đặc điểm của một phần "Hệ quả" tốt trong ADR:

  • Giải thích điều gì xảy ra sau khi đưa ra quyết định. Điều này có thể bao gồm các tác động, kết quả, đầu ra, việc theo dõi tiếp, và nhiều hơn nữa.

  • Bao gồm thông tin về bất kỳ ADR tiếp theo nào. Khá phổ biến khi một ADR kích hoạt nhu cầu về thêm các ADR, chẳng hạn khi một ADR đưa ra một lựa chọn lớn bao trùm, từ đó tạo ra nhu cầu về nhiều quyết định nhỏ hơn.

  • Bao gồm bất kỳ quy trình xem xét sau hành động nào. Thông thường các nhóm xem xét từng ADR một tháng sau, để so sánh thông tin ADR với những gì đã xảy ra trong thực tế, nhằm học hỏi và phát triển.

Một ADR mới có thể thay thế một ADR trước đó:

  • Khi một AD được đưa ra thay thế hoặc làm mất hiệu lực một ADR trước đó, thì nên tạo một ADR mới