用途
发布说明(Release Notes)以突出价值、激发期待的方式向用户传达产品变更。与变更日志(changelog,记录技术层面的变更)不同,发布说明将变更转化为用户收益。优秀的发布说明帮助用户发现新能力、理解改进,并相信问题正在被解决。
何时使用
- 向客户发布产品更新
- 向内部利益相关者传达变更
- 准备应用商店更新描述
- 撰写面向客户的邮件公告
- 为支持和销售团队记录变更
何时不使用
- 你是在向内部利益相关者更新进展,而非宣布已发布的变更 -> 使用 foundation-stakeholder-update
- 你需要面向开发者的技术变更记录 -> 保留工程变更日志;本技能将变更转化为用户收益
- 你在协调发布就绪状态,而非传达发布本身 -> 使用 deliver-launch-checklist
- 没有用户可见的内容发布(纯内部重构):勉强寻找收益的发布说明会侵蚀信任;跳过本周期或并入下一个周期
使用方式
当被要求创建发布说明时,遵循以下步骤:
-
收集变更日志:收集本次发布包含的所有变更:功能、改进和缺陷修复。基于工程变更日志、已完成工单或拉取请求描述进行。
-
识别亮点:选择1-3个值得重点展示的变更。这些应是用户会注意到且最关心的变更。以最具影响力的变更开头。
-
转化为收益:用用户价值重写每个变更。不要写“为搜索结果添加了分页”,而应写“通过改进的搜索更快找到所需内容,可处理大量结果集”。聚焦用户现在能做什么或什么变得更好了。
-
分类变更:将剩余变更归入清晰类别:新功能、改进和缺陷修复。在每个类别内,按影响力排序(最有价值的在前)。
-
撰写便于扫读的描述:每项应为1-2句话。以收益开头,可选地后接“如何实现”。用户会扫读发布说明——让每一行都有价值。
-
说明已知问题:如果有已知限制或问题,保持透明。用户欣赏诚实,这也能减少支持负担。
-
预告即将推出(可选):如合适,暗示接下来会有什么。这能建立期待并展示势头,但不要过度承诺。
输出格式
使用 references/TEMPLATE.md 中的模板来组织输出。完整的发布说明填写模板各部分:亮点;新功能;改进;缺陷修复;已知问题;即将推出(可选);以及反馈。
质量检查清单
在最终确定前,验证:
- 亮点展示1-3个最具影响力的变更
- 每项以用户收益开头,而非技术描述
- 语言无术语,所有用户都能理解
- 各项简洁(每项1-2句话)
- 缺陷修复提及所解决的问题
- 没有内部术语、工单ID或代码名称泄露;每一行读起来都是面向客户的
示例
完整示例见 references/EXAMPLE.md。