用途:为产品编写更新日志(Changelog)与发布说明(Release Notes),并规范版本号变更的对外沟通。
主要能力与写法: 面向用户的更新日志:以收益开头,例如写“You can now export to PDF”,而不是“Added PDF export module”;按 New、Improved、Fixed 分组;省略用户不关心的内部改动;为新功能附上文档链接。 面向开发者的更新日志:遵循 Keep a Changelog 格式;按 Added、Changed、Deprecated、Removed、Fixed、Security 分组;引用 issue/PR 编号;显著标出破坏性变更。 语义化版本沟通:Major(2.0)为“Big update”,需要迁移指南;Minor(1.5)为“New features”,向后兼容;Patch(1.5.1)为“Bug fixes”,不含新功能。
反模式(应避免):只写“Various bug fixes and performance improvements”而不具体说明;在面向用户的说明中使用技术术语;条目缺少日期;把更新日志写成单纯的 git commit 消息堆砌。
限制:资料未提供具体工具、安装命令、平台支持或收费信息。