Có bất kỳ loại nguyên tắc hoặc phương pháp hay nhất nào về cách ghi chú phát hành phải được viết không? Tôi đoán tôi đang cố gắng tìm sự cân bằng hợp lý giữa việc đưa ra điểm mà không quá cụ thể. Ngoài ra, nhà phát triển có thường cung cấp ghi chú phát hành nhiều hơn cho nhóm QA so với ghi chú phát hành cho chế độ xem công khai không?Ghi chú phát hành nên được viết như thế nào?
Trả lời
ghi chú phát hành công cộng nên chứa ít nhất:
- phát hành, buildnumber
- tất cả các lỗi nào cố định
- tất cả các tính năng công cộng thêm
QA ghi chú phát hành nên chứa ít nhất:
- rele ase, buildnumber
- tất cả các lỗi cố định bao gồm lỗi số
- tất cả các tính năng bổ sung bao gồm các liên kết đến thiết kế tài liệu
Cân nhắc khán giả của bạn và cố gắng nghĩ những gì họ cần.
Một điều khác cần thêm là hỗ trợ mới hoặc không được hỗ trợ cho một số nền tảng nhất định. (Ví dụ, chúng tôi bỏ hỗ trợ cho Win3.1 và thêm Vista 64 bit).
Một số điểm bổ sung: - Xuất bản ở dạng văn bản thuần túy hoặc ít nhất là html . Đừng khiến họ khó xem. - Việc thêm ghi chú phát hành lên đầu ghi chú phát hành cũ là điều phổ biến. - Đôi khi tốt khi đề cập đến các lỗi đã biết chưa được giải quyết. –
Ngoài ra tốt đẹp. Tôi chắc chắn sẽ đi cho văn bản đơn giản. Nhưng nếu bạn có thể tạo ghi chú phát hành, không có lý do gì để không inlcude html, pdf, v.v. –
Nếu bạn có hệ thống theo dõi quản lý dự án/vấn đề, bạn chắc chắn sẽ sử dụng hệ thống đó để tạo ghi chú phát hành của mình. Trac và Redmine nói riêng là rất tốt.
điểm phát hành nên có một vài thuộc tính, IMO:
- Ghi khán giả của bạn. Nếu đây là một ứng dụng iPhone, rất ít người sẽ quan tâm đến thực tế là một lỗi logic cụ thể trên dòng 572 trong lớp Foo đã được sửa. Nhưng họ sẽ quan tâm rất nhiều về "ứng dụng hiện nay nhạy cảm với gia tốc".
- Tóm tắt các sự phát triển, tính năng và sửa lỗi mới theo cách rộng, có thể quét được nếu có thể. Nếu bạn có thể liên kết các chủ đề này với nhau theo chủ đề (ví dụ: "chúng tôi đã triển khai generics và các loại ẩn danh"), một sự lúng túng ngắn về điều đó là một cách hay để cung cấp cho mọi người bức tranh lớn.
- Nhập các mục cụ thể đã được sửa, với các liên kết tới trình theo dõi lỗi công khai của bạn, nếu có. Điều này thường có thể được tạo tự động.
- Không cung cấp chi tiết đầy đủ. Tóm tắt một hoặc hai lớp của mỗi thứ được thêm vào hoặc cố định là đủ.
- Luôn bao gồm số nhận dạng phát hành cụ thể (ví dụ: "v.1.4.5"), nếu phù hợp.
Nó thực sự phụ thuộc vào khán giả. Đối với người dùng kỹ thuật (ví dụ nhà phát triển sử dụng API của bạn), bạn có thể rất kỹ thuật. Ở đầu người dùng cuối cao cấp khác của ứng dụng bạn đã tạo có thể chỉ quan tâm đến các tính năng mới và thay đổi lớn.
Giữa những người dùng không có kỹ thuật cũng cần chi tiết, ví dụ như bộ phận hỗ trợ. Đối với những người bạn có thể đưa ra một mô tả chi tiết mà không có các chi tiết kỹ thuật ở mức độ thấp, ví dụ như "Sửa lỗi mà bản ghi không được lưu trong cơ sở dữ liệu."
Một phương pháp hay nhất với ghi chú phát hành theo ý kiến của tôi là tự động hóa. Nếu có một số phương pháp hay nhất cho hệ thống kiểm soát sửa đổi gửi tin nhắn (http://drupal.org/node/52287), bạn có thể tạo ghi chú phát hành bằng tập lệnh tự động (http://cvs.drupal.org/viewvc.py/drupal/contributions/tricks/cvs-release-notes/). Điều này sẽ tạo ra các ghi chú phát hành thực sự tốt đẹp: http://drupal.org/node/226165
Cộng tác viên chính của Ghi chú phát hành sẽ là nhóm phát triển của bạn. Đó là một thực hành tốt để cho phép các nhà phát triển và người thử nghiệm của bạn nắm bắt bất kỳ thông tin ghi chú phát hành nào liên quan đến công việc của bạnCác mục được liên kết với các thay đổi trong TFS.
Sau đó, bạn có thể sử dụng dự án nguồn mở như http://tfschangelog.codeplex.com để tạo ghi chú phát hành. Nó có phiên bản GUI và một phiên bản dòng lệnh giúp bạn dễ dàng lập lịch báo cáo ghi chú phát hành hàng đêm.
- 1. Ghi chú phát hành, để làm gì?
- 2. Tại sao tôi nên thực hành Phát triển theo hướng thử nghiệm và tôi nên bắt đầu như thế nào?
- 3. Team Foundation Server Tự động phát hành Ghi chú thế hệ
- 4. Tôi nên chèn nhiều bản ghi như thế nào?
- 5. Ghi chú phát hành hoặc thay đổi đường ray ở đâu
- 6. Cách tạo ghi chú đàn ghi chú
- 7. Các biểu thức boolean nên được viết bằng PHP như thế nào?
- 8. Tôi nên sử dụng Mercurial như một nhà phát triển đơn lẻ như thế nào?
- 9. Tôi nên phát hiện loại MIME của tệp được tải lên trong ASP.NET như thế nào?
- 10. Catch Android Ghi chú App Giống như Vòng menu
- 11. Tôi nên đại diện cho AST được chú thích bằng thông tin bổ sung như thế nào?
- 12. Phiên bản thử nghiệm JDK đầu tiên được phát hành như thế nào?
- 13. Làm thế nào để phát hành MPMoviePlayerController?
- 14. Môi trường QA nên được thiết lập như thế nào?
- 15. Theo dõi git-flow bạn nên xử lý hotfix của bản phát hành trước đó như thế nào?
- 16. Làm thế nào để viết idempotent hoạt động ghi?
- 17. Trình tối ưu OpenGL hiện đại nên được viết như thế nào để tương thích với nhau?
- 18. Loại lỗi nào nên dừng hệ thống, trong hệ thống web php được phát hành?
- 19. Tôi nên viết "trang lưu trữ" hoặc "chỉ mục danh mục" với html5 như thế nào?
- 20. Nên sử dụng strace như thế nào?
- 21. Phát một ghi chú duy nhất với DirectMusic
- 22. UIButton - chúng ta có nên phát hành hay không?
- 23. Tôi nên sử dụng Tệp Perl :: Temp như thế nào?
- 24. Tôi nên học cách viết các chương trình như thế nào?
- 25. Mã Android gốc được viết cho ARM chạy trên x86 như thế nào?
- 26. Phát hiện tệp batch được thực thi như thế nào
- 27. Ứng dụng Trello iPhone được phát triển như thế nào?
- 28. Khi nào, ở đâu và hàng đợi nên được sử dụng như thế nào?
- 29. @ Chú thích được tạo, chúng tôi sử dụng nó như thế nào?
- 30. Bản phát hành được xử lý như thế nào đối với các thuộc tính giữ lại @synthesized?
Câu hỏi hay nhưng không có một số chi tiết cụ thể, bạn sẽ không nhận được câu trả lời hữu ích. Gần như những gì bạn đang phát hành, làm thế nào và ai cũng sẽ giúp đỡ. –
bản sao có thể có của [Ghi chú phát hành, điều gì?] (Http://stackoverflow.com/questions/315628/release-notes-what-for) – lindelof