定义
版本说明(release notes)是随每次软件发布向用户说明新增功能、变更、修复与已知事项的文档,常见形式包括项目里的 changelog 文件与 GitHub Release 页面。
工作方式
维护者按版本整理变更条目,通常配合版本号(常用语义化版本)标注每次发布;Keep a Changelog 惯例把条目分为新增、变更、弃用、移除、修复与安全等类别。
使用场景
用户据此判断是否升级、升级会带来什么影响;排查问题时也常对照版本说明定位行为变化发生在哪个版本。
易混概念
语义化版本规范的是版本号本身,版本说明解释版本内容;bug 修复是版本说明中最常见的一类条目。