Thực hành tốt viết ghi chú phát hành

Khi phân phối mọi phiên bản phần mềm, chúng tôi phải viết một ghi chú phát hành. Ví dụ, đây là một số thuật ngữ tôi thêm khi tôi viết ghi chú phát hành:

• Ngày phát hành
• Giải quyết lỗi

Như vậy là đủ, hay còn gì nữa không?

Tôi nghĩ rằng những điều sau đây sẽ đưa ra một cách để thực hành tốt

// Ngày liên quan

• Ngày phát hành

// Tính năng liên quan

• Đã thêm tính năng
• Loại bỏ đặc trưng
• Tính năng thay đổi

// Lỗi liên quan

• Lỗi đã giải quyết
• Lỗi chưa giải quyết

// Phụ thuộc liên quan

• Danh sách phụ thuộc

// Kiểm tra liên quan

• Kết quả kiểm tra đơn vị
• Kết quả kiểm tra nghiệm thu

// Kiểm soát phiên bản liên quan

• Thẻ ghi chú
• Số sửa đổi

Ngoài ra, đôi khi đáng để làm nổi bật những thứ mà người dùng cuối có thể muốn thay đổi trong cấu hình hoặc quy trình làm việc của họ.

Hầu hết người dùng cuối không quan tâm đến kết quả kiểm tra. Họ hy vọng nó có chất lượng cao bất kể ghi chú phát hành nói gì.

Điều quan trọng nhất về ghi chú phát hành là lưu ý rằng mỗi câu bổ sung sẽ mất thêm 10% số người đọc. Vì vậy, bạn phải ưu tiên nghiêm ngặt những gì người dùng hiện tại của bạn cần biết về bản phát hành.

Điều quan trọng nhất về ghi chú phát hành là lưu ý rằng mỗi câu bổ sung sẽ mất thêm 10% số người đọc. Vì vậy, bạn phải ưu tiên nghiêm ngặt những gì người dùng hiện tại của bạn cần biết về bản phát hành.