GEO GUIDE

更新日志怎么写:面向用户而非面向系统

直接结论:更新日志回答「这对我有什么影响」。写法:按用户可见的变化分组(新功能/改进/修复)、描述影响而非实现细节、每条一句话可读完。不写「内部重构」「性能优化」这类用户无感的条目——除非性能提升是用户可感知的。

分组

  • 新功能:用户能用的新能力。
  • 改进:已有能力的体验或性能提升(用户可感知的)。
  • 修复:用户遇到过的 bug——内部 bug 不写。

写法

  • 描述影响而非实现:「导出速度提升 3 倍」而非「重构了导出模块」。
  • 每条一句话可读完,附文档或指南链接(如有)。
  • 破坏性变更单独分组并置顶——升级前用户需要知道什么会变。

不写的

  • 内部重构、依赖升级、代码清理——用户无感的条目不进日志。
  • 没有用户可见变化的小版本——空日志比噪音好。