Deployment 发行说明应该如何编写？

关于如何编写发行说明，是否有任何指导方针或最佳实践？我想我是在试图找到恰当的平衡点，在不太具体的情况下提出观点。此外，与提交供公众查看的版本相比，开发人员通常会为QA团队提供更多的版本说明吗？

公共版本说明应至少包含：

• 版本号
• 所有已修复的公共bug
• 所有新增的公共功能

QA发行说明应至少包含：

• 版本号
• 所有修复的错误，包括错误编号
• 所有新增功能，包括指向设计文档的链接

考虑你的听众，试着思考他们需要什么

---

另一个需要添加的是对某些平台的新的或中断的支持。（例如，我们退出了对Win3.1的支持，并添加了Vista 64位）。

如果您有一个项目管理/问题跟踪系统，您肯定应该使用它来生成发行说明。尤其是我们在这方面非常擅长

发布点应该有几个属性，IMO：

• 记住你的听众。如果这是一个iPhone应用程序，很少有人会关心Foo类第572行的一个特定逻辑错误已经修复这一事实。但他们会非常关心“应用程序现在对加速度计敏感”
• 如果可能的话，以广泛、全面的方式总结新的开发、特性和错误修复。如果你能将这些主题联系在一起（例如“我们实现了泛型和匿名类型”），那么一个简短的宣传语是一个很好的方法，可以让人们了解全局
• 详细列出已修复的具体事项，以及指向公共bug跟踪器的链接（如果有的话）。这通常可以自动生成
• 不要提供令人痛苦的细节。添加或固定的每件事情的一个或两个线性摘要就足够了
• 始终包括特定的发布标识符（如“v.1.4.5”），视情况而定

---

我想看看流行的F/OSS项目的发行说明：

• 等等

---

所有这些项目都有可读性和平衡的发行说明。

这取决于受众。 对于技术用户（例如使用API的开发人员），您可以非常技术化。 另一方面，您创建的应用程序的高级最终用户可能只对新功能和主要更改感兴趣

---

介于两者之间的是需要详细信息的非技术用户，例如支持部门。对于这些人，您可以给出详细的描述，而不需要低层次的技术细节，例如“修复了一个记录未保存在数据库中的错误”。

我认为发布说明的一个最佳实践是自动化。如果存在修订控制系统提交消息（）的某些最佳实践，则可以通过自动脚本（）创建发行说明。这将创建非常好的发行说明：

发行说明的主要贡献者将是您的开发团队。允许开发人员和测试人员根据TFS中链接到变更集的工作项捕获任何与发行说明相关的信息是一种很好的做法

---

然后您可以使用开源项目生成发行说明。它有GUI版本和命令行版本，可以方便地安排您的发行说明报告在夜间进行。

我发现这非常有效。它为发布说明的生成和发布提供了最佳实践。

这是一个很好的问题，但如果没有一些细节，您将无法得到有用的答案。大致上你发布的内容，如何发布，谁也会提供帮助。可能会重复一些额外的要点：-以纯文本或至少html发布。不要让他们很难看到将发行说明附加到旧发行说明的顶部是很常见的。-有时，引用一些尚未解决的重要已知错误是很好的。添加得不错。我肯定会选择纯文本。但是如果你能生成发行说明，没有理由不导入html、pdf等。对此不确定。如果我搜索“ubuntu”，结果是零。：）你在哪里搜索“ubuntu”，你希望看到什么？：）也许我误解了“ReleaseNotesHub”，网站疯了。不要搜索ubuntu。他实际上是指（这也是发行说明中心）。上面的网站是疯狂的。