发行说明最佳做法

#1 楼

我区分发行说明和发行内容。 （具体术语并不重要，您可以使用与我不同的术语）。

发行说明是一个外部使用的文档，可帮助用户了解发行中的新增功能。它通常描述新功能。它可能会或可能不会描述错误修复，具体取决于产品，客户类型以及公司希望做到的透明性。有些产品有发行说明；其他版本则没有。

发布内容是内部消耗的文档，可促进项目团队之间的沟通。它可能从对发行版主要主题的高级描述，功能列表，或者可能是重要的已修复错误的列表开始。

要回答您的问题，您需要将发行说明校准为您的质量检查和执行团队的需求。他们的需求可能有所不同。您的高管可能只希望对项目进行高层次的描述，而您的质量保证团队可能对高层次的主题的关注要比实际功能和重大固定错误少。 （如今，我怀疑公司在错误统计方面比在书面文档中更依赖错误跟踪系统。）

您没有提到您的客户服务团队。也许您没有一个，或者您的质量保证团队还负责客户服务。客户服务可能需要两种文件。

#2 楼

我可以根据自己的经验列出。发行说明需要包含以下内容


发行功能的详细信息-此发行版是否是功能附件/错误修复/更改请求
运行构建的先决条件-任何满足以下条件的先决条件必须先进行构建安装后才能使用构建环境-您可能具有一些用于DB，IIS，Biztalk的脚本。调出脚本目标来安装/运行将很有用。
脚本执行-如果构建需要停机，则为关键步骤指定安装时间会很有用。这样可以很好地了解安装时间，并可以估计生产停机时间
日志文件路径/构建错误-检查错误/疑难解答的路径（如果有已知问题/错误，请致电

）这些是我发现对QA团队，生产团队和产品管理团队有用的项目。

希望对您有所帮助。.

#3 楼

我们使用2种不同类型的发行说明，具体取决于它是软件的常规发行版，还是中间版本。

通常，我负责的软件每年会有一个主要发行版，并且随附完整的文档（用户手册，在线帮助等）。
对于此发行版，发行说明包含一个部分，列出了新功能和已修改的功能以及错误修复。对于新功能和修改后的功能，还有指向文档的某种链接，例如“有关此功能的更多信息，请参见用户手册的第3.2章。”对于中间版本，由于错误修复或功能而必须这样做，而客户急需其迫切需要等到下一个主要版本发行版中，除了新增/修改的功能和错误修复的列表之外，还从用户角度描述了如何使用新增或修改的功能。该信息将包含在该软件的下一个主要版本的文档（用户手册，发行说明）中。漏洞修复也是如此，这使得必须更改用户界面或处理软件的方式。

#4 楼

由于我的公司与多个客户一起工作，并且发行版可能会基于安装中的自定义功能而影响所有客户，因此我们使用发给开发和项目管理团队的发行说明来：


沟通修复了哪些错误
传达了发行版附带的新功能
传达了发行版
指定哪个客户端受发行版影响最大
传达了SVN修订并合并目标

然后，我们的支持项目经理将获取这些发行说明，并使用“已客户端化”以供公众使用的详细信息更新我们的产品更新页面。

#5 楼

这项调查/项目ARENA：自动生成发行说明的方法非常有趣，它试图通过科学工程学的论点来回答问题，另外还提供了一个在线工具，网址为https://seers.utdallas.edu/ARENA/

此外，由于研究总是有限的，所以我会挑选一些随机的高亮发行说明（请参阅列表），然后指定您的说明。


https：/ /www.xilinx.com/support/documentation/sw_manuals/xilinx2019_1/ug973-vivado-release-notes-install-license.pdf

https://docs.microsoft.com/zh-cn/ Windows / WSL /发行说明
https://developer.apple.com/documentation/ios_ipados_release_notes/ios_ipados_13_4_release_notes
https://www.st.com/content/ccc/resource/technical/document/ release_note / b2 / 02 / 4b / e3 / 81/32/49 / c4 / DM00107607.pdf / files / DM00107607.pdf / jcr：content / translations / zh.DM00107607.pdf

我的背景是十多年的研发工作，使我受益匪浅。从另一个角度来看，发行说明似乎对项目没有重大影响，即，如果发行说明的质量不同，则风险仍然很低。客户或PM等利益相关者当然会要求他们。我也没有将发行说明视为质量检查或规范活动中使用或依赖的主要文档。思考评估。我认为它们是配置管理的一部分。