提示版本号怎么定
用语义化版本管理提示资产:输出契约不兼容的变更升主版本,行为与效果改进升次版本,措辞与错字微调升修订号。版本号的价值在于把契约变化变成可读信号,下游据此写范围约束,升级时才能预判要不要改解析代码。
基本信息
| 主版本 | 输出字段、格式等不兼容变更,下游必须适配 |
|---|---|
| 次版本 | 行为与效果改进,输出契约保持兼容 |
| 修订号 | 措辞、错字与注释类微调,无行为意图 |
| 下游约束 | 按范围锁定主版本,例如取大于等于 1.2 且小于 2.0 |
| 升级流程 | 候选版本 → 小流量灰度 → 指标对比 → 全量 |
典型使用场景
- 输出从自由文本改为 JSON:必须升主版本,下游同步改解析
- 示例增删导致风格变化:升次版本,跑回归确认通过率
- 修错别字:升修订号,仅抽查即可
- 多团队共用模板:各团队按主版本范围锁定,避免被上游意外改坏
- 灰度对比:新旧版本同时在线,按流量比例分流并比指标
版本与兼容示例
版本与兼容示例
1.x:输出契约稳定(字段名、类型、误差口径不变)
1.3.0:增加要点数组的最大条数约束,字段结构不变
2.0.0:输出由纯文本改为 JSON,下游需适配解析
调用方约束:summarize >= 1.2, < 2.0
升级流程:候选版本 → 灰度 5% → 关键指标对比 → 全量
回滚:保留上一稳定版本,开关一处切换变更类型对应版本位
| 变更 | 版本位 | 下游影响 |
|---|---|---|
| 字段名或类型变化 | 主版本 | 解析代码必须改 |
| 输出格式改结构 | 主版本 | 需兼容期与双写 |
| 提示措辞优化 | 次版本 | 无需改动,效果对比即可 |
| 补充少样本示例 | 次版本 | 关注风格与长度变化 |
| 错字修正 | 修订号 | 无 |
版本号要写进日志与追踪记录里。排错时第一件事就是确认线上跑的是哪一版,缺这个字段会让后续所有判断变成猜测。