什么是发布说明以及谁阅读它们?应该/可以通过为当前版本发布错误修复来实现自动化,还是需要进行人工编辑? 那么,与软件发行说明有关的最佳实践链接(推理背后)?版本说明,用于什么?
回答
发行注记到你的测试机构重要(如果有的话),让他们知道什么是在发布更改,并且需要测试。
这实际上取决于您的应用程序的构建目标和组织目标。但是,我倾向于认为发行说明必须是特定发行版中包含的重要关键附加功能,增强功能或修补程序的简要列表。
有时候,一个简单的转储错误跟踪系统信息就足够了,有时候,我发现他们需要改进。
关键是,通常发布说明被认为是“嘿看看我们做了什么”类型的变更列表。
错误修正和增加的功能。用户将阅读它们以确定是否应该去安装增量升级的麻烦,或者等到下一个版本发布,因为这个版本没有添加他们需要的任何功能,或者修复了他们使用的功能中的任何错误。
我会说他们至少需要一个人来通读他们,并确保每个音符都很有用。这取决于您的错误修复的评论有多好。
我们的发布记录是人类创建的,而不是机器创建的。封面三大主题。
中有什么版本包括 (文件列表)
如何安装它
从上一版本 (是什么改变了,特别是如果改变不是 的手册)。
项目1和2在版本和版本之间并没有很大的差别,但他们需要审查。项目3需要最多的工作。
有趣的是对这个吉姆。我通常会将项目1和项目2包含在其他文档中,而不是发行说明文件中。... – 2008-11-24 21:58:39
如果您的客户除了正常程序以外还需要采取特殊措施进行升级,版本说明和自述文件可能非常重要。警告用户/用户可能会因安装更新的补丁程序而自动发生任何数据库升级。我看到它的方式,发行说明和自述文件应该写给系统管理员的读者。因此,请包括他们想知道的事情类型:重要更改的摘要,如何安装,已知错误,您的软件可能会做的任何事情,以便让某人拉出他人的头发等。
我习惯性地阅读发行说明。我倾向于需要全面的功能更改列表(或者似乎合理),以便更好地使用新产品。
我希望看到何时解决某些重要的错误或关键安全问题。
版本注释在生产环境中也非常重要。
他们帮助回答古老的问题:
赫克目前运行到生产什么?
或者更精炼的问题:这个bug在这个版本中是否确实得到修复?
发布说明取决于您的组织。
我可以为我的组织说话。我们使用PDF格式的发布说明,每次发布clickonce或后端版本。我们向办公室经理发送说明。这是业务高层管理员(不仅是IT)使用的文档。这份文件是让他们知道发生了什么的一种方式。现在正在生产的新功能,已修复的错误以及他们可能想要向其用户解释的其他内容都发生了变化。
这是可以3〜4页之间,说明已在此版本简短的话已完成任务的文件。
当然,这是高度依赖于应用程序/服务/诸如此类的类型,
但我发现阅读我最喜欢的开发工具的发布说明等。
常常使我偶然发现不错,有趣甚至杀手锏,我很可能会错过,如果我did'nt至少浏览笔记.....好了,也许不是杀手,但你明白我的意思;-)
由于大多数电脑电力用户(现什么样的表情是...)
我从来不在乎多少与普通文档,所以这给了我
那么一点额外的东西someth荷兰国际集团除了点击,悬停和faq'ing ...
发行说明测试人员和用户知道什么是新的/改变。此外,发布说明可用作为您为其构建的客户端软件的新“版本”计费时的支持文档。 v1.31似乎更容易关联和钻取。
而不是手动编译两个列表,如果你可以使用你的发行说明,为你做它的伟大。
- 1. ASP.NET MVC - 版本说明
- 2. Magento - 使用简短说明适用于Google基本说明
- 3. 关于样本的说明
- 4. 说明“国家”是什么
- 5. 关于python脚本文件的说明
- 6. 关于bash脚本的说明
- 7. 旧版swift中用于xcode版本8.0(8A218a)的swift版本是什么?
- 8. 为什么scikitlearn说FN大于0的F1分数不明确?
- 9. 什么c#类类型声明说?
- 10. 什么是HTML 4媒体说明符
- 11. 什么是嵌套名称说明符?
- 12. scanf说明符“n”是什么数字?
- 13. 使用什么html版本?
- 14. 为什么Brew医生说XCode 6.0.1不是最新版本?
- 15. 关于注释的说明
- 16. Magento Enterprise 1.8.0版基于什么标准版本?
- 17. C语言中的声明符说明符是什么?
- 18. 关于Hmac用户认证的说明
- 19. 需要关于AutoMapper的使用说明
- 20. 格式说明用于短整型
- 21. 使用说明
- 22. iOS版 - 的cellForRowAtIndexPath代码说明
- 23. ruby脚本说明请
- 24. Places API - 文本说明
- 25. PHP代理 - 基本说明
- 26. Gradle Ear Plugin:添加没有版本说明符的模块
- 27. Rails版本说明或更改日志在哪里
- 28. 如何在nexus版本库中添加评论/说明
- 29. Docker for Windows Beta发行说明和版本历史
- 30. Verifone VMAC版本中不同功能的说明?
我将其标记为答案,因为在实践中我不认为其他用户作为整体阅读说明。其他用户倾向于阅读帮助,或工具提示和其他应用程序的位置。不过,质量检查员对测试的详细发布说明表示赞赏,至少在我的组织中他们确实会阅读它们。谢谢。 – 2009-01-14 17:50:42