如何写出发行说明？

Question

关于如何编写发行说明,是否有任何指导方针或最佳实践？我想我正在努力找到适当的平衡点,而不是太具体.此外,开发人员通常会为QA团队提供更多的发布说明,而不是提交给公众查看的发布说明吗？

Answer 1

公开发行说明至少应包含:

• 发布,buildnumber
• 所有固定的公共错误
• 所有增加的公共功能

质量保证发布说明至少应包含:

• 发布,buildnumber
• 所有修复的错误,包括错误号
• 所有添加的功能,包括设计文档的链接

考虑您的受众并尝试思考他们需要什么.

另外要添加的是对某些平台的新支持或停止支持.(例如,我们退出了对Win3.1的支持并添加了Vista 64位).

Answer 2

我将看一下流行的F/OSS项目的发行说明:

• 火狐
• GIMP
• Ubuntu的
• Android的
• TeamCity的
• 等等

所有这些项目都具有相当可读和平衡的发行说明.

Answer 3

如果您有项目管理/问题跟踪系统,那么您肯定应该使用它来生成发布说明.Trac和Redmine尤其擅长这一点.

发布点应该有一些属性,IMO:

• 记住你的观众.如果这是一个iPhone应用程序,很少有人会关心Foo类中第572行的特定逻辑错误是固定的.但他们会非常关心"应用程序现在对加速计敏感".
• 如果可能的话,以广泛,全面的方式总结新的开发,功能和错误修正.如果你可以将这些主题绑定在一起(例如"我们实现了泛型和匿名类型"),那么简单介绍一下这是一个让人们了解大局的好方法.
• 列出已修复的特定内容,以及指向公共错误跟踪器的链接(如果有).这通常可以自动生成.
• 不要提供令人难以忍受的细节.添加或修复每件事物的单行或双行摘要应该足够了.
• 始终包含特定的版本标识符(例如"v.1.4.5").