概述
自动生成的发布说明常含内部术语且顺序混乱,直接影响读者理解。逐条核对是否真的发布、把破坏性变更与所需动作置顶、为其补充迁移步骤、去除面向内部的内容,并按读者区分版本,可让说明真正起到沟通作用。
关键步骤
- 对照实际发布核对每条条目。
- 把破坏性变更与所需动作置于最前。
- 为破坏性变更补充迁移步骤与链接。
- 去除内部噪声并澄清术语。
验证
- 每条破坏性变更都有迁移步骤。
- 无描述未实际发布内容的条目。
- 目标读者可无障碍阅读。
- 内外部版本分离。
决策点
生成文本必须经编辑,它通常含内部术语且未按影响排序;面向外部的说明应与内部变更日志分开。
适用范围
本条目围绕「发布说明质量评审工作流」给出可复制的步骤、验证方式与常见问题,适合需要按此流程落地的工程团队。执行时请结合自身上下文调整命令与阈值,并在变更前后留存证据,便于后续复核与回滚。
建议在正式环境落地前先在预发或隔离环境演练一遍,把关键观测指标与负责人一并记录,确保出现异常时能快速定位并恢复。
# review the generated draft
sed -n '1,80p' RELEASE_NOTES.md
# verify each entry against the merged PRs before publishing