发行说明Release Notes：为什么需要它们以及如何编写它们

与客户的沟通至关重要，开发团队不应E仅将这项任务留给营销和销售。即使是开发团队也应该通过文档来接触客户。

软件产品需要文档才能充分发挥其潜力，但您是否知道有一种特定类型的文档可以同时增强您的产品、提高采用率并同时为客户提供帮助

当然，我们谈论的是发行说明，或者，因为它们可能被称为更改日志。

什么是发行说明Release Notes？

当产品（如 SaaS）不断更新时，您需要一种方式让客户知道发生了什么变化。当然，他们可以登录您的产品并自行查找，但另一种方法是发布发行说明。您可以使用特殊的发行说明软件来发布您的文档或只是将它们添加到您的网站。

发行说明通常包含软件更新的名称及其效果的描述以及其他重要信息，但我们稍后将详细讨论发行说明中应包含的内容。

您通常会让客户知道更新适用于哪个系统版本、任何新功能以及是否需要升级。

总而言之，发行说明是向客户传达产品价值并向他们展示您正在不断开发产品的好方法。

发行说明在软件开发中的重要性

我们将更详细地了解发行说明的重要性。

与用户沟通

发行说明是与用户沟通的重要方式，因为它们准确地显示了软件系统的变化情况。如果客户登录您的软件并发现他们最喜欢的功能已被更改或删除，他们可能会感到有点震惊。发行说明允许您传达更改的方式和原因。

文件和历史记录

更新产品固然很棒，但您需要将其记录为文档，以确保每个人都知道产品是如何更改的。例如，您的软件的潜在买家将能够查看历史记录，了解您的产品是如何发展的，并了解它正在不断改进，这表明您的团队努力满足用户的需求。

用户采用率和参与度

如果您想推动新功能的采用，您需要确保您的用户了解它。如果用户了解新功能并积极发布解释和促进任何更改的内容，那么您就可以保持用户的参与度。如果用户知道为什么某个特定功能可以使他们受益，他们就更有可能采用该功能并保留在您的产品中。

反馈和迭代开发

当您发布发行说明时，您可以征求用户的反馈，了解他们对更改的感受。建立开放的对话可以使您的产品更贴近客户，并允许您进行迭代开发，而不是冒着未来版本损害您的市场份额的风险。

透明度和信任

当然，借助 SaaS，可以在不通知客户的情况下自动推出产品更新，但发行说明有助于创建透明度和信任。如果您出于某种原因逐步淘汰某项功能并降低客户流失的可能性，这一点尤其重要。

支持和故障排除

如果您的新版本中存在尚未修复的错误，发行说明可以帮助您提供支持和解决已知问题，从而减轻客户支持团队的负担。客户明白您已经意识到任何问题并正在努力解决它们，而不是觉得您正在开发劣质产品。

开发团队内的协作

开发团队可以与其他部门（例如产品和技术作家）协作发布发行说明。发行说明对所有这些团队都有好处，因为它们针对的是采用新功能的客户，而各方都对此有利害关系。

法律和合规要求

虽然发行说明不是强制性的，但在更新软件以扩展用例时，它们对于法律和合规性要求可能很重要。客户需要确信使用新版本软件所固有的任何风险。

有效发行说明的组成部分

现在，我们将看看包含无效发行说明所需的所有内容。

版本信息

包括您的发行版适用的特定版本，以便用户知道发行说明是否适用于他们。

发布日期

出于参考目的，请包含发布日期，以便用户知道发布的时间。

清晰简洁的总结

为避免用户必须滚动浏览文字墙，请包含清晰简洁的更新摘要。

详细变更日志

在这里，您可以更深入地了解变更日志，包括进行变更的方式和原因，以及任何重要的技术细节。

写作风格和语气

尽管发行说明是正式文档，您可能仍然希望使用友好的风格和语气来传达您的更新。

用户影响和好处

用户并不总是喜欢更改，因此包含对用户的影响和好处来解释进行更新的原因会很有帮助。重点关注新的更新将如何改善他们的生活并提供更多的价值。

文档和支持链接

您可能有更广泛的用户指南和文档可以链接到，特别是对于需要更多解释的复杂更改，因此请务必包含它们，以及联系您的支持团队的能力。

视觉效果（可选）

包含屏幕截图或其他视觉效果可以是让发行说明变得生动并向用户传达更改的好方法，尤其是在演示如何使用新功能时。

已知的问题

有时，您可能需要发布包含已知问题的更新，在这种情况下，最好通知您的用户以提高透明度，以防他们遇到问题。让他们知道您正在努力修复它们。

反馈机制

提供反馈机制，例如电子邮件或社区论坛的链接，用户可以在其中表达自己的意见。发行说明应该是持续对话的一部分，您认真对待用户的反馈。

确定信息的优先顺序

将最重要的信息放在第一位，以便您的用户有机会在感到无聊之前吸收它！如果您有更多话要说，但又不想在发行说明中让用户不知所措，您可以稍后链接到更多信息。

发行说明的写作风格和语气

除了需要在发行说明中包含的基本信息之外，您还应该在文档中采用特定的风格和语气。

以受众为中心的方法

请记住，一切都与用户有关，因此在编写发行说明时采用以受众为中心的方法。这意味着关注对用户的影响，使用他们能够理解的语言，并表达对他们观点的欣赏。

清晰简单

最重要的是，保持简单明了。用户来这里不是为了阅读有关您的软件产品的论文，而是为了以简单的方式访问必要的信息。为了简洁，删除不必要的文字和解释。

积极鼓励的语气

改变是困难的，在撰写发行说明时，您应该努力采用积极和鼓励的语气，强调为什么改变是必要和重要的。拥抱所有用户并帮助他们采用您的新功能。

避免负面语言

另一方面，避免使用让用户感到沮丧的负面语言。不要说“不幸的是，我们不得不停止此功能”，因为这会让用户感觉他们错过了一些东西。相反，您可以尝试“我们正在将我们的产品朝以下方向发展”。

一致性

阅读发行说明可能有点麻烦，因此每次发布新更新时请确保文档保持一致。当用户知道期望什么（包括易于理解的格式）时，他们更有可能与您的笔记互动。

以用户为中心的语言

编写发行说明时，请务必使用用户的语言，以确保他们理解您的解释。如果您在内部将您的功能称为“小部件”，但用户将其称为“助手”，那么如果您不符合用户的期望，则可能会造成混乱。

参与度和兴奋度

请记住，发行说明不仅仅是一份枯燥的文档，而是一个对新更新感到兴奋的机会！向用户传达您的兴奋之情，让他们热衷于尝试新功能并使用同一产品实现更多目标。发行说明为您的用户展示了巨大的性价比。

用户利益

同样，谈论新版本的好处会给用户留下积极的印象。如果产品没有产生有益的影响，您不太可能会更改产品，因此在谈论您的更新时要传达这一点。

避免过多的技术细节

对于大多数观众来说，过多的技术细节会分散注意力，也是不必要的。您最了解您的用户并掌握他们的技术熟练程度，因此在解释您的更新时尽量不要陷入细节。如果必须使用技术术语，请考虑是否解释它们的含义。

透明度

最糟糕的事情就是在发行说明中误导用户。即使您担心负面反馈，也要诚实地对待所做的改变。通过坦率和透明，用户将更有可能信任您并相信您的行为符合他们的最佳利益。

鼓励用户反馈

尽管用户反馈并不总是积极的，但您应该在发行说明中鼓励用户反馈，因为文档是对话的一部分。包含电子邮件链接或类似内容是收集有关新版本的反馈并了解用户对该产品的真实想法的绝佳机会。

发行说明的 3 个绝佳示例

现在，我们将看看在发行说明领域处于领先地位的五家公司。

1. Baklib 巴克利布

Baklib是一个流行的文档和基于知识的平台，可帮助组织有效地创建、管理和发布文档。为了让用户了解情况并突出持续改进和新功能，Baklib 定期更新发行说明。这些发行说明是用户、管理员和开发人员的宝贵资源，提供有关更新、增强功能、错误修复和新功能的详细信息。

2. Blackthorn

Blackthorn 是一种积极开发和维护的软件产品或应用程序。为了让用户、管理员和利益相关者了解最新的更新、增强功能和错误修复，开发团队定期发布发行说明。这些发行说明对于提供透明度、展示改进承诺以及确保用户了解可能影响其软件使用的更改至关重要。

3.Serverless360

Serverless360是一个用于管理和监控无服务器应用程序的综合平台，例如基于 Microsoft Azure Functions、逻辑应用程序和服务总线构建的应用程序。为了让用户群了解最新更新、功能增强和错误修复，Serverless360 开发团队定期发布发行说明。这些发行说明对于提供透明度、展示改进承诺以及确保用户了解可能影响其平台使用的更改至关重要。

发行说明中的挑战和解决方案

您在编写发行说明时可能会遇到一些挑战，因此现在我们针对常见障碍提供一些解决方案。

平衡细节与简洁

为您的用户提供他们需要的尽可能多的细节，同时保持简短。这可以通过分解发行说明并允许用户跳到他们感兴趣的功能或更新来实现。

管理期望

新版本令人兴奋，但请确保不要让用户抱有太大希望。让他们知道他们可以实现什么以及他们是否需要升级到更高的计划才能获得福利。

处理负面反馈

即使收到负面反馈，也要保持优雅和感激。发行说明可能会引起争议，因为并非每个人都喜欢您所做的更改。接受一些人的欢迎需要不断改进你的产品。

沟通技术变更

必须清楚地传达支持软件更新的技术变更，尤其是当您的产品依赖于 API 和类似功能时。如果您的受众是开发人员，请清楚地传达新要求并共享规范，以避免干扰开发活动。

确保无障碍

每个人都应该可以访问您的发行说明，包括那些互联网连接速度慢或能见度较低的人。如果您包含图像和视频，请确保也可以通过文本访问相同的信息。

及时发布说明

不要等到几周或几个月之后才发布发行说明。尝试将他们的发布时间与您的软件的新版本一起发布，否则您会让您的用户感到困惑和失望。如果您的发行说明迟到了，请承认您的迟到，并在未来尝试通过优先发布和发布来加快速度。

保持一致性

特别是对于更复杂的发行说明，保持一致性是关键。如果用户知道会发生什么，他们将更有可能参与并了解有关新更新的更多信息。您可以期望的最好结果是用户在收件箱中查找您的季度更新。当您的发行说明有多个贡献者时，使用模板是关键。

处理复杂的变化

当您需要传达复杂的变更时，您可以将它们分解成更小的块。单独解决您已解决的每个功能和问题，以确保用户不会不知所措。

获取用户反馈

用户可能并不总是有动力提供反馈，但您可以通过确认反馈何时刺激了新功能和改进来鼓励更多反馈。这表明您重视用户反馈并将其纳入您的产品路线图。

归档和编目发行说明

对于想要了解您的产品开发情况的潜在客户来说，能够回顾过去的发行说明非常重要。建立一个档案来展示开发过程并编目您的发行说明。

如果您对软件产品进行了更改，那么是时候庆祝了！确保您通过发行说明与客户一起标记新版本，以便他们知道他们正在获得价值，并且您正在倾听他们的反馈。

编写发行说明的方法有正确和错误之分，但有一点是肯定的：它们是产品文档中不可或缺的一部分。确保每个人，从开发人员到产品人员再到技术作家，都知道他们的重要性。

与用户建立持续的对话，解释更改并让他们提交反馈，这对于推动产品采用和客户忠诚度至关重要。