产品与设计
写用户真正会读的产品更新日志与发布说明时如何分类、措辞…
适用于撰写 release notes、changelog、产品更新、功能公告和版本说明,让用户看得懂、愿意读。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 38/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 55/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 60/100 ×0.15
适用场景
写用户真正会读的产品更新日志与发布说明时特定
解决思路
- 按标准分类组织条目:New(绿色,✨/🆕,全新功能)、Improved(蓝色,⚡/🔧,现有功能增强)、Fixed(黄/橙色,🐛/🔨,缺陷修复)、Removed(红色,🗑️/⚠️,弃用或移除)、Security(紫色,🔒,安全补丁)。
- 分类判定规则:New = 用户以前完全做不到的事;Improved = 用户原本能做、现在更好/更快/更简单;Fixed = 原本坏了、现在正常。不要用“Updated”,因为它没有意义——要明确是 improved 还是 fixed。
- 每条条目按固定结构写:分类标签 → 面向用户的标题 → 用户现在能做什么 → 怎么做 → 变化了什么 → 配图。
- 使用面向用户的措辞:写用户能 DO 什么,而不是你 BUILT 了什么;以“You can now…”/“Reports now…”/“Fixed an issue where…”开头;包含收益而非仅机制;使用现在时。
- 避免内部语言:不要写“Implemented batch processing queue…”“Refactored the ReportExporter class…”“Fixed bug in CSV serialization (PR #4521)”这类内容。
- 版本号采用语义化版本 MAJOR.MINOR.PATCH:MAJOR 用于破坏性变更或重大改版;MINOR 用于向后兼容的新功能;PATCH 用于缺陷修复和小改进。
- 持续部署的 SaaS 产品可采用日期式版本号,如 2026-02-08、2026.02.08 或 February 8, 2026。
- Changelog 页面结构:标题 # Changelog,按日期分节(## February 8, 2026),日期下按 New/Improved/Fixed 等分类列出条目,条目用加粗功能名 + 破折号说明 + 可选 [Learn more →](link)。
- 按变更类型决定是否配图:新 UI 功能配截图;UI 改版配前后对比;新工作流配分步截图或短视频;性能提升配改进图表;复杂功能配动图或视频演示。
- 用 CLI 生成配图:用 belt app run infsh/agent-browser 对运行中的应用截图;用 belt app run infsh/stitch-images 做前后对比(direction: horizontal);用 belt app run bytedance/seededit-3-0-i2i 加红圈标注;用 belt app run falai/flux-dev-lora 生成功能公告横幅。
- 破坏性变更需特殊处理:明确 What changed、What you need to do(编号步骤 + 迁移指南链接)、Timeline(现在/某日/某日各阶段行为),并提供支持联系方式。
- 按渠道分发:Changelog 页面放完整细节(每次发布);应用内通知放 1-2 行摘要(新功能、破坏性变更);邮件放精选亮点和配图(重大版本,月度/季度);博客放深度背景(大型发布);社交媒体放单个功能亮点;Slack/Discord 放简短公告(若有社区)。
- 社交媒体片段格式:🆕 New in [Product]: [Feature Name],1-2 句说明现在能做什么,附截图或演示视频,加 Try it now → [link]。
- 写作要做的:把相关变更分组;把最大/最受期待的变化放最前;复杂功能链接到文档;标注“By popular request:”说明是谁要求的;破坏性变更给出迁移路径;每条都标日期。
- 写作不要做的:不要写“various bug fixes”,要么列具体修复要么省略;不要包含内部引用(PR 号、工单 ID、分支名);不要只说“Updated [feature]”而不说怎么变;不要列没人关心的变更(依赖升级、内部重构);不要提交日志式堆砌——一条 changelog 条目可能对应很多 commit。
- 按产品类型确定频率:持续部署的 SaaS 每周批量;有重大功能的 SaaS 每次功能发布(配博客);版本化软件每个版本发布(绑定 semver);API 每个版本 + 弃用通知(含迁移指南);移动应用每次应用商店发布(与商店 What's New 一致)。
- 避免常见错误:开发者语言(用户看不懂)→ 写用户能做什么;“Bug fixes and improvements”(零信息)→ 列具体修复;无日期(无法判断新旧)→ 每条标日期;无配图(用户跳过文字)→ 主要功能配截图;破坏性变更被埋没(用户发现太晚)→ 显著警告 + 时间线;把 commit log 当 changelog(嘈杂无用)→ 筛选并重写。
适用边界 · 注意事项
- 没有安装 inference.sh CLI(belt)时,无法执行文中生成配图的命令。
- 变更属于依赖升级、内部重构等用户不关心的内容时,不应写入 changelog。
- 没有面向用户的实际功能变化时,不要为凑数发布更新日志。