vs2019 发行说明_如何计算发行说明

vs2019 发行说明

恭喜你！ 您已经准备好发布软件包的最新版本。 现在，您需要确保发布说明正确无误。 当然，您可以在包装盒上打一下“错误修复和性能改进”，然后每天称呼它，但这并不能真正告诉您的用户任何信息。

发行说明适用于支持和市场营销。 他们告诉您当前的用户为什么这个新版本对他们很重要，并向潜在用户展示您的软件。 因此，您想要使内容清晰，可理解，并且最重要的是相关。 没有一种编写发行说明的方法，所以这是一般性建议，而不是法令。

一种流行的趋势是使发行说明成为一种叙事，其中包含很多傻话。 如果那是您的事，那就去做吧–请记住，笑话通常是与上下文相关的，您认为搞笑的笑话可能会完全被读者所忽略。 而且，当然，您不能忘记包含重要信息。

入门

这篇文章中最重要的一点也许就是为将要阅读它们的人写发行说明。 对于面向用户的软件，请着重于面向用户的行为，而不是内部实现。 例如，说“单击'取消'按钮将使您的计算机着火”，而不是“ cancelThatThing函数中的thermalEventTrigger默认设置为True”。

尝试将每个音符限制为一两个句子。 重点是突出重要部分，而不是给出详细说明。 如果您有公开的问题跟踪器，请添加一个链接（或至少一个问题号），以便读者在有意愿时可以查找详细信息。

您不必以这种方式布置发行说明，但是我喜欢以下格式。 从版本号和发行日期开始。 对于主要版本，您可能还包括一些句子以突出显示主要主题。 例如，“此版本专注于添加电子邮件客户端，因为那是所有软件的最终最终状态。”

相容性变更

如果新版本引入了兼容性或默认行为方面的更改，请明确突出显示这些更改。 您的用户以及提供用户支持的任何人都会感谢您。 描述将要遇到的行为更改的情况，如何解决该更改以及如果用户不对更改执行操作会发生什么情况。 对于次要发行版，您可能没有任何不兼容的更改，因此可以省去本节。

功能和增强

现在是时候吹嘘您的软件所做的所有酷炫的新功能，但请记住专注于用户的观点。 例如，“该软件现在支持自动检测午餐图片并将其发布到Instagram。”

解决的问题

没有软件是完美的，这是您向读者介绍团队为使项目变得更好而付出的所有辛勤工作的部分。 用过去时写这些笔记，因为不良行为已荡然无存。 如果很清楚在何处引入了该错误，请包括该信息。 一些项目也在本节的文档中包含错误。

已知的问题

因为没有软件是完美的，所以总是会遗留一些错误。 本部分列出了这些内容。 您不必承认一切。 关注于影响功能的错误，尤其是自上一版本以来发现的错误。 用将来的时态写这些，当您解决它时，只需要更改动词时态就可以了。

翻译自: https://opensource.com/article/17/3/how-to-improve-release-notes

vs2019 发行说明