提示变更日志是什么
提示变更日志是放在提示文件旁边的记录文件:每次改动写清版本号、日期、改了什么、为什么改、评测结果如何、影响哪些链路、怎么回滚。它的作用是让「提示改了」这件事变成可追溯的工程动作。没有它,线上行为变化时只能靠记忆推测是哪次改动引起的,回滚也不知道该退到哪一版。
基本信息
| 存放位置 | 与提示文件同目录,随版本库一起提交,便于对照 diff |
|---|---|
| 必备字段 | 改动内容、动机、评测结果、影响面、回滚方式 |
| 编号规则 | 与提示版本一一对应,不跳号、不复用 |
| 归档要求 | 旧版本保留可检索的快照,而非只有文字描述 |
典型使用场景
- 上线评审:评审人只看日志就能了解这次改动的动机与风险
- 问题定位:线上指标异常时,对照日志快速锁定可疑改动
- 回滚决策:日志里的回滚方式说明要退到哪一版、影响哪些调用方
- 交接与审计:新同事无需翻聊天记录即可理解每次改动的原因
- 复盘材料:把「改了但没测」这类过程问题暴露出来
CHANGELOG 示例
CHANGELOG 示例
# ## v12 (2026-10-11)
# - 改动:抽取规则新增「合计行不算明细」条款
# - 动机:E4 错误中 12 例为合计行误入明细
# - 评测:golden-v3 主指标 +1.8 分;回归集全过;解析率不变
# - 成本:平均输入 token 由 1180 升至 1240
# - 影响面:仅订单抽取链路,其他链路不受影响
# - 回滚:保留 v11 快照,热回滚 5 分钟内生效
# - 责任人:<name> 关联单号:<ticket>必备字段与作用
| 字段 | 作用 | 缺失后果 |
|---|---|---|
| 改动内容 | 说明改了什么,可与 diff 对照 | 评审时只能靠猜 |
| 动机 | 说明为什么改,来自哪类错误 | 后续无从判断条款是否还有必要 |
| 评测结果 | 给出指标变化与回归结论 | 无法证明改动是有效的 |
| 影响面 | 列出受影响的链路与调用方 | 回滚时漏掉依赖方 |
| 回滚方式 | 说明退到哪版、多久生效 | 出问题后处理时间被拉长 |
日志与快照要交叉引用:只写「回退到上一版」而仓库里没有对应快照,回滚时才发现无版本可退。版本号是连接两端的唯一凭据。
紧急线上修改也要补记:先改后补是允许的,但不回写仓库与日志就会形成长期不一致,下一次发布时这些改动会被覆盖丢失。