Trình tạo ghi chú phát hành miễn phí

Ghi chú phát hành là gì?

Ghi chú phát hành là bản tóm tắt ngắn gọn về những thay đổi trong phiên bản mới của sản phẩm: tính năng mới, cải tiến và sửa lỗi, được viết để người đọc biết họ có thể làm gì ngay bây giờ. Trình tạo ghi chú phát hành biến danh sách thô mà đội ngũ của bạn đã có, chẳng hạn như commit hoặc ticket, thành bản tóm tắt đó, để ghi chú được phát hành cùng lúc với bản cập nhật thay vì một tuần sau đó.

Ghi chú phát hành tốt cho khách hàng biết lý do tại sao bản cập nhật quan trọng với họ. Thông báo commit cho lập trình viên biết mã nào đã thay đổi. Công việc ở đây là chuyển đổi từ cái này sang cái kia.

Ghi chú phát hành hay changelog?

Mọi người thường dùng các từ này một cách linh hoạt. Một cách phân chia hữu ích:

Công cụ này cũng hoạt động như một trình tạo changelog: tạo ghi chú cho mỗi bản phát hành và thêm chúng vào đầu trang changelog của bạn.

Những gì cần đưa vào ghi chú phát hành

• Tiêu đề kèm sản phẩm và phiên bản: “Ghi chú phát hành Acme Analytics 3.2”.
• Tóm tắt một dòng: một hoặc hai thay đổi mà hầu hết người đọc quan tâm.
• Mới, Cải tiến, Sửa lỗi: theo thứ tự đó, bỏ qua các phần trống.
• Gạch đầu dòng ưu tiên lợi ích: người dùng có thể làm gì bây giờ, không phải mã làm gì.
• Thay đổi gây lỗi (Breaking changes): chính xác những gì người dùng cần làm, được nêu rõ ràng.
• Liên kết: đến bài viết trợ giúp hoặc video cho bất kỳ nội dung nào cần giải thích.

Ví dụ ngắn về ghi chú phát hành

Ba commit, “feat: export reports to CSV”, “fix: dashboard timezone off by one hour” và “chore: bump dependencies”, có thể trở thành:

Acme Analytics 3.2
Giờ đây bạn có thể mang báo cáo đi bất cứ đâu và bảng điều khiển hiển thị thời gian chính xác.

Mới

• Xuất CSV: tải xuống bất kỳ báo cáo nào dưới dạng tệp CSV để mở trong Excel hoặc Google Sheets.

Sửa lỗi

• Thời gian trên bảng điều khiển: biểu đồ hiện sử dụng múi giờ của bạn một cách chính xác.

Bản cập nhật dependency bị lược bỏ trong phiên bản dành cho khách hàng vì người dùng sẽ không nhận thấy. Phiên bản nội bộ vẫn giữ lại nó.

Cách chuẩn bị các thay đổi cho trình tạo

Bạn không cần phải dọn dẹp danh sách trước, nhưng một vài thói quen sẽ tạo ra ghi chú tốt hơn. Dán mỗi thay đổi trên một dòng, dù đó là thông báo commit, tiêu đề ticket hay một câu. Giữ các tiền tố thông thường như “feat:” và “fix:” nếu bạn sử dụng chúng; chúng giúp phân loại các thay đổi thành mục mới và sửa lỗi. Thêm một từ ngữ cảnh vào các mục khó hiểu, ví dụ “fix: export (CSV was empty for large reports)”. Điền tên sản phẩm và phiên bản để tiêu đề sẵn sàng xuất bản. Sau đó chạy hai lần nếu bạn cần cả hai phiên bản: một cho khách hàng, một cho đội ngũ nội bộ.

Các phương pháp hay nhất cho ghi chú phát hành

Viết cho người sử dụng sản phẩm

“Báo cáo tải nhanh hơn” tốt hơn “Tối ưu hóa trình lập kế hoạch truy vấn”. Hãy đặt tên tính năng như cách nó xuất hiện trong giao diện.

Dẫn dắt bằng những gì quan trọng nhất

Đặt thay đổi mà hầu hết mọi người sẽ nhận thấy lên trước. Các sửa lỗi nhỏ có thể nằm trên một dòng ở cuối.

Cho thấy tính năng mới

Ảnh chụp màn hình hoặc video ngắn về tính năng mới có tác dụng hơn một đoạn văn. Hãy liên kết bài viết trợ giúp giải thích về nó.

Xuất bản theo lịch trình mà mọi người có thể tìm thấy

Giữ mọi bản phát hành trên một trang changelog, mới nhất trước, để khách hàng và đội ngũ hỗ trợ của bạn luôn biết nơi cần tìm.

Những sai lầm phổ biến trong ghi chú phát hành

• Dán nguyên văn nhật ký commit, bao gồm cả số ticket và biệt ngữ.
• Ẩn một thay đổi gây lỗi (breaking change) ở giữa danh sách.
• Liệt kê mọi thay đổi nội bộ trong ghi chú dành cho khách hàng.
• Hứa hẹn ngày tháng hoặc tính năng không có trong bản phát hành.

Trình tạo chỉ bao gồm các thay đổi từ danh sách của bạn và sẽ không thêm ngày tháng mà bạn không cung cấp, nhưng hãy kiểm tra từng mục trước khi xuất bản.