发行说明和变更日志有什么区别？

Question

软件包通常随变更日志 and/or 发行说明一起提供。它们之间有什么区别？它们是否应该包含在新版本的发布中？

Answer 1

是的，我认为您可以将两者都包含在新版本中。

对我来说，主要区别在于，在发行说明中，您可以用更全面的语言解释新增内容或更改内容。

在变更日志的情况下，您必须添加变更的更多技术细节，例如将带有 link 的提交消息添加到 diff 或带有 links 的 PR 到技术讨论中。

Answer 2

要直接回答您的问题，您可以将两者都包含在您的软件版本中。

Release notes 是一组交付给客户的文档，旨在提供对产品或服务新版本发布的详细描述。这些工件通常由营销团队或产品所有者创建，包含功能摘要、错误修复、用例和其他支持 material。发行说明用作用户文档之外更改内容的快速指南。

相反，changelogs 是按时间倒序排列的新功能、增强功能、错误和其他更改的综合列表。变更日志通常 link 针对变更管理系统中的特定问题或功能请求，也可能包括 link 提供变更的开发人员。