选型指南 架构设计 含可复制代码

变更说明怎么写:给未来同事与现在用户的两份

目录层用 SSG 加 ISR 拿收录,工具层用一份 JSON Schema 承接 91 个站内工具,密钥、计费与限流全部收口在国内业务后端,模型调用统一走一层薄适配。这篇把我们真实的目录结构、Schema 字段定义、路由闸门、预扣结算伪代码和合规清单完整摊开。

陈
陈默架构组
2026-09-28 · 14 分钟阅读 · 8,432 次浏览

能力收窄不通知,是最伤信任的一类变更。

变更说明不是"写给审计看的"

产品做变更(AI 改提示词、换模型、调默认值 ✔)时,往往只在内部记一笔 ✗:

"更新了提示词" ✔ —— 三个月后没人知道当时为什么改 ✔,用户也完全不知道行为变了 ✔。

变更说明有两个读者 ✗→✔:未来的同事与现在的用户 ✔。写给这两类人,要求不同 ✔。

一、给未来同事的(内部变更记录)

六项,缺一项都会让后来者困惑 ✔:

```

① 动机:要解决什么问题(附证据/事故编号 ✔)

② 改了什么(具体到文件/配置项 ✔)

③ 影响面(哪些功能、哪些用户 ✔)

④ 验证方式与结果(评测集、指标前后 ✔)

⑤ 回滚方式(怎么退回上一版 ✔)

⑥ 未解决的部分(如实写 ✔)

```

第 ④ 与 ⑥ 最常被省略 ✗:没有验证结果,后人无法判断这次改动的价值 ✔;

不写未解决部分,后人会以为"已经做完" ✔。

二、给用户的(对外变更说明)

用户只关心三件事 ✔:我的用法要不要变、结果会有什么变化、出问题怎么退 ✔。

```

一句话说明变化("回答会先给结论,更短" ✔)

要不要做什么("无需操作"或"请重新确认默认设置" ✔)

如何回退("可在设置里切回详细模式" ✔)

```

要点:不要写技术细节 ✗("升级了模型版本" ✔ 对用户没意义 ✔);

要写他们能感知的差异 ✔("更长/更短""更保守/更果断" ✔)。

三、什么时候必须对外说明

· 行为显著变化(语气、长度、默认值、是否自动执行 ✔);

· 能力收窄(原来能做,现在不能 ✔ —— 这是最重要的 ✔);

· 数据使用变化(是否外发、保留多久 ✔ —— 合规要求 ✔);

· 价格或额度变化 ✔。

能力收窄不通知 ✗ 是最伤信任的一类 ✔。

四、三个反模式

· "优化了体验" ✗(等于没说 ✔);

· 只发内部邮件 ✗(用户不知道 ✔);

· 变更说完不留档 ✗(后人无从追溯 ✔)。

一条判据

> 半年后有人问"为什么这个行为是这样" ✔,你能否在10 分钟内从变更记录里找到动机与证据 ✔?

> 不能,说明变更只"发生"过,没有被记录 ✗。

本文由云枢 AI导航整理,内容以官方来源为准。

相关文章

顺序阅读

← 上一篇:把老员工的经验写进系统:规则、示例与反馈三条路
下一篇:试用额度怎么设计:按体验预算而不是成本 →

第 109 / 171 篇

术语速查 · 本页出现的 12 个词展开看中文名与一句话解释,点术语看完整条目
  • token词元:模型处理文本的最小单位,中文约 1–2 个汉字;计费与上下文长度都按它算。
  • 转写 / 字幕Transcription:把音视频人声逐句变成带时间戳的文字稿,便于做字幕与章节切分。
  • SSE服务器发送事件:服务器通过长连接持续推送增量文本,是对白逐字出现的常见实现。
  • API应用编程接口:程序之间约定的调用方式;站内工具由服务端调用,浏览器里不出现密钥。
  • CDN内容分发网络:把静态资源缓存到离用户更近的节点,缩短加载时间。
  • 缓存Cache:把结果暂存复用,复用得越多平均耗时越低;需要约定过期与刷新策略。
  • 限流Rate Limit:限制单位时间内的请求次数,防止单用户或异常流量打满服务端。
  • SSG静态站点生成:构建阶段就生成 HTML,访问时直接返回,不必每次请求都渲染。
  • ISR增量静态再生:先返回静态页,再在后台按需重新生成,兼顾速度与更新时效。
  • 灰度发布Canary Release:先让一小部分用户用新版本,确认无误再放量,出问题的爆炸半径最小。
  • 提示词Prompt:交给模型的指令文本;写清角色、任务、输入与输出格式比反复试更省。
  • 积分Credits:站内计费单位:按工具单价预扣,调用失败自动退还;单价以定价页为准。

完整解释与站内出现处见 AI 术语表(40 条)。