版本内容清单要同时回答四个问题:这个版本交付了哪些需求、修掉了哪些缺陷、动了哪些配置、对外怎么说明。模板以一张主表承载条目,字段按需求、缺陷、配置、发布说明四组排列,再配字段说明表和填写示例,保证同一字段在三处口径一致。适用范围是版本交付与后续维护,适合研发、测试、运维和发布负责人共同填写。
要点总览(TL;DR)
- 模板以一张主表承载版本条目,字段按版本基本信息、需求条目、缺陷条目、配置条目、发布说明五组排列,需求、缺陷、配置各占一行,发布说明作为版本级信息填写。
- 字段说明表逐项给出含义、取数来源和填写口径,需求编号与缺陷编号引用原系统编号,验收结论与修复状态分别对应需求验收和缺陷处理结果。
- 必填判定以“缺失后是否导致无法追溯或无法回退”为原则:版本号、需求编号、缺陷编号、配置项名称、关联环境、发布范围、回退方式为必填;缺失时在发布评审前阻断,或以例外记录说明原因和批准人。
- 填写示例展示条目之间互相指认的写法:有条件通过的验收结论附条件,延期修复的缺陷与已知问题对应,配置变更按环境分行并支撑回退方式。
- 模板可随团队规模增删辅助字段,但追溯与回退相关字段不建议删除;模板本身应有版本标识和变更记录,并定期复核长期为空或口径不一致的字段。
可复制空白模板:版本内容清单主表
下表可直接粘贴到文档或表格工具中使用。每一行代表一个版本条目,同一版本的多条需求、缺陷、配置各占一行;发布说明类字段属于版本级信息,可在该版本首行填写,或在表下单独设一块版本信息区。列头前的分组标记用于对照,实际使用时可以保留为分组行或改为颜色区分。
| 分组 | 字段 | 填写内容 |
|---|---|---|
| 版本基本信息 | 版本号 | |
| 版本基本信息 | 版本名称 / 主题 | |
| 版本基本信息 | 计划发布日期 | |
| 版本基本信息 | 清单维护人 | |
| 需求条目 | 需求编号 | |
| 需求条目 | 需求名称 | |
| 需求条目 | 需求负责人 | |
| 需求条目 | 验收结论 | |
| 缺陷条目 | 缺陷编号 | |
| 缺陷条目 | 缺陷描述 | |
| 缺陷条目 | 严重程度 | |
| 缺陷条目 | 修复状态 | |
| 配置条目 | 配置项名称 | |
| 配置条目 | 变更内容 | |
| 配置条目 | 关联环境 | |
| 配置条目 | 变更单号 / 记录链接 | |
| 发布说明 | 发布范围 | |
| 发布说明 | 已知问题 | |
| 发布说明 | 回退方式 | |
| 发布说明 | 对外说明摘要 |
如果团队习惯一张横向宽表,可把上述字段转为列,每行一条需求或缺陷,配置与发布说明字段在行内重复填写或留空,由版本级信息区统一承载。两种排布的内容完全一致,选择哪种取决于填写人数和评审方式:多人并行填写时,纵向条目式更不容易互相覆盖。
字段说明:每个字段填什么、从哪里取
字段说明的作用是让不同填写人对同一列给出同一种答案。下表逐字段给出含义、取数来源和填写口径,其中取数来源按常见研发管理分工描述,团队可映射到自己实际使用的需求库、缺陷库、配置管理记录和发布记录。
| 字段 | 含义 | 取数来源 | 填写口径 |
|---|---|---|---|
| 版本号 | 本次发布的唯一标识 | 发布计划或版本管理记录 | 与制品、发布单上的版本号保持一致,不自行改写格式 |
| 版本名称 / 主题 | 面向团队和用户的版本简称 | 版本规划文档 | 一句话概括版本重点,避免只写日期 |
| 计划发布日期 | 约定的对外或对内发布时间 | 发布计划 | 延期时更新此字段并保留原计划日期记录 |
| 清单维护人 | 对本清单完整性负责的人 | 版本负责人指定 | 填写到人,便于评审时追溯 |
| 需求编号 | 需求在需求库中的唯一编号 | 需求库或需求工作项 | 直接引用原编号,不另起编号体系 |
| 需求名称 | 需求的简短标题 | 需求库 | 与需求库标题一致,便于检索核对 |
| 需求负责人 | 对该需求交付负责的人 | 需求库中的负责人字段 | 填写当前负责人,转交后同步更新 |
| 验收结论 | 需求是否通过验收及结论 | 测试或验收记录 | 用“通过 / 有条件通过 / 未通过”等固定取值,附一句条件说明 |
| 缺陷编号 | 缺陷在缺陷库中的唯一编号 | 缺陷库 | 引用原编号;同一缺陷多次回归时保留原编号 |
| 缺陷描述 | 缺陷的现象概述 | 缺陷库标题 | 写现象和影响范围,不写修复方案 |
| 严重程度 | 缺陷对业务的影响等级 | 缺陷库严重程度字段 | 沿用团队既有等级定义,不临时改级 |
| 修复状态 | 缺陷在本版本中的处理结果 | 缺陷库状态 | 区分“已修复”“延期修复”“不修复并说明原因” |
| 配置项名称 | 本次发生变更的配置对象 | 配置管理记录 | 写到可定位的粒度,如服务名、配置文件、环境参数 |
| 变更内容 | 配置改了什么 | 变更单或提交记录 | 写变更前后的关键差异,不写“优化配置”这类笼统描述 |
| 关联环境 | 变更生效的环境 | 环境清单 | 明确测试、预发、生产等环境,跨环境变更分行填写 |
| 变更单号 / 记录链接 | 变更的审批或记录凭据 | 变更管理系统 | 填写可回溯的编号或链接,便于审计 |
| 发布范围 | 本次发布影响的模块、用户或区域 | 发布计划 | 写清全量还是灰度、涉及哪些端 |
| 已知问题 | 发布时仍未解决且需告知的问题 | 缺陷库与测试结论 | 每条写现象、影响和临时规避方式 |
| 回退方式 | 发布异常时的回退路径 | 发布方案或运维手册 | 写清回退触发条件、操作步骤和责任人 |
| 对外说明摘要 | 面向用户或客户的版本说明 | 发布说明文档 | 用业务语言描述变化,不暴露内部编号 |
容易混淆的几组字段需要单独约定口径。“需求编号”和“缺陷编号”都要求引用原系统编号,区别在于需求条目回答“交付了什么”,缺陷条目回答“修掉了什么”,同一件事不应在两处重复登记。“修复状态”和“验收结论”都带结论性质,前者针对缺陷的处理结果,后者针对需求的验收结果,填写时不要互相替代。“关联环境”描述配置变更生效的位置,“发布范围”描述版本影响的对象,两者一个偏技术、一个偏业务,跨环境发布时尤其要分开写。
当清单条目来自多个系统时,字段的取数来源决定了清单能否被核对。需求与缺陷条目通常直接对应需求库和缺陷库中的工作项,配置条目对应变更记录,发布说明对应发布文档。以 ONES 为例,ONES Project 覆盖需求管理、任务管理、缺陷管理等场景,需求可编写并自定义状态与属性,缺陷可提交到对应项目或迭代并跟踪修复情况;清单中的需求编号、缺陷编号、修复状态可以从这些工作项直接对应过来。发布说明部分可放在 ONES Wiki 中维护,文档支持关联任务、插入工作项列表,并记录页面版本、支持查看与回滚,便于发布说明与清单条目互相对照。
必填与选填:哪些字段不能空
必填判定可以遵循一条原则:缺失后是否会导致版本内容无法追溯或无法回退。会导致的字段设为必填,只影响阅读便利的字段设为选填。下表给出建议划分,团队可结合发布节奏和审计要求调整。
| 字段 | 建议 | 理由与适用场景 |
|---|---|---|
| 版本号 | 必填 | 没有版本号,清单无法与制品和发布单对应 |
| 计划发布日期 | 必填 | 用于判断清单是否在发布前完成评审 |
| 清单维护人 | 必填 | 明确完整性责任,评审时可找到对接人 |
| 需求编号、需求名称 | 必填 | 需求条目存在即须可追溯,缺编号则无法回查 |
| 验收结论 | 必填 | 未给结论的需求不应进入发布范围 |
| 缺陷编号、严重程度、修复状态 | 必填 | 决定已知问题清单和是否可发布 |
| 配置项名称、变更内容、关联环境 | 必填 | 缺失则无法判断变更影响面和回退范围 |
| 发布范围、回退方式 | 必填 | 发布说明的核心内容,缺失会直接影响发布执行 |
| 版本名称 / 主题 | 选填 | 便于沟通,内部小版本可省略 |
| 需求负责人 | 选填 | 条目较少时可由维护人统一对接 |
| 缺陷描述 | 选填 | 编号可回查时,描述用于快速阅读 |
| 变更单号 / 记录链接 | 选填 | 有审计要求或变更审批流程时转为必填 |
| 已知问题 | 选填 | 无遗留问题时填“无”,不建议留空 |
| 对外说明摘要 | 选填 | 仅对外发布或客户可见版本需要 |
必填字段缺失时,建议在发布评审前阻断清单通过,而不是带着空缺进入发布。处理方式有两种:一是补齐字段后再提交评审;二是确有客观原因无法补齐时,在清单末尾的例外记录区写明缺失字段、原因、影响评估和批准人,由版本负责人确认后放行。例外记录本身也应作为版本归档的一部分保留,便于事后复盘。选填字段在适用场景出现时应转为必填,例如有对外发布安排时,“对外说明摘要”就不再是可选项。
填写示例:一个版本的完整清单
以下为演示情景,用于展示字段如何协同表达一个版本的内容,不代表任何真实项目数据。示例版本为某内部系统的 3.2.0 版本,包含两条需求、两条缺陷、两条配置变更和一段发布说明。
| 分组 | 字段 | 示例填写 |
|---|---|---|
| 版本基本信息 | 版本号 | 3.2.0 |
| 版本基本信息 | 版本名称 / 主题 | 订单查询性能优化 |
| 版本基本信息 | 计划发布日期 | 2025-06-18 |
| 版本基本信息 | 清单维护人 | 发布负责人 A |
| 需求条目 | 需求编号 | REQ-1042 |
| 需求条目 | 需求名称 | 订单列表支持按时间范围筛选 |
| 需求条目 | 需求负责人 | 产品经理 B |
| 需求条目 | 验收结论 | 通过 |
| 需求条目 | 需求编号 | REQ-1057 |
| 需求条目 | 需求名称 | 订单详情页加载耗时降至 1 秒内 |
| 需求条目 | 需求负责人 | 后端负责人 C |
| 需求条目 | 验收结论 | 有条件通过:仅覆盖主流程,异常分支下版本继续观察 |
| 缺陷条目 | 缺陷编号 | BUG-2210 |
| 缺陷条目 | 缺陷描述 | 筛选条件切换后列表未刷新 |
| 缺陷条目 | 严重程度 | 高 |
| 缺陷条目 | 修复状态 | 已修复,回归通过 |
| 缺陷条目 | 缺陷编号 | BUG-2233 |
| 缺陷条目 | 缺陷描述 | 导出文件在数据量较大时超时 |
| 缺陷条目 | 严重程度 | 中 |
| 缺陷条目 | 修复状态 | 延期修复,下版本处理 |
| 配置条目 | 配置项名称 | 订单查询服务超时参数 |
| 配置条目 | 变更内容 | 查询超时由 3 秒调整为 5 秒 |
| 配置条目 | 关联环境 | 预发、生产 |
| 配置条目 | 变更单号 / 记录链接 | CHG-0318 |
| 配置条目 | 配置项名称 | 订单列表缓存开关 |
| 配置条目 | 变更内容 | 默认开启,缓存有效期 60 秒 |
| 配置条目 | 关联环境 | 生产 |
| 配置条目 | 变更单号 / 记录链接 | CHG-0321 |
| 发布说明 | 发布范围 | 全量用户,Web 端与移动端同步生效 |
| 发布说明 | 已知问题 | 大数据量导出仍可能超时,建议分批导出 |
| 发布说明 | 回退方式 | 关闭缓存开关并回滚超时参数,触发条件为查询错误率超过阈值 |
| 发布说明 | 对外说明摘要 | 订单查询速度提升,支持按时间范围筛选 |
这份示例体现了几个防遗漏的写法。需求 REQ-1057 的验收结论写“有条件通过”并附条件,避免把未完全验证的需求当成完全通过;缺陷 BUG-2233 的修复状态写“延期修复”而不是留空,使已知问题与发布说明中的“大数据量导出仍可能超时”形成对应;配置条目按环境分行,回退方式直接引用这两个配置项,使回退操作有据可依。填写时保持这种“条目之间互相指认”的习惯,清单才真正起到核对作用。
调整与维护:按团队情况增删字段
模板需要随团队规模、发布节奏和审计要求调整,但调整应有边界。可增删的通常是辅助性字段:小团队可去掉“需求负责人”“缺陷描述”,条目少时由维护人统一对接;发布频繁的团队可增加“发布窗口”“灰度比例”字段;有审计要求的团队应把“变更单号 / 记录链接”转为必填,并增加“审批人”“审批时间”。不建议删除的是版本号、需求编号、缺陷编号、配置项名称、关联环境、发布范围和回退方式,这些字段承担追溯和回退功能,删掉后清单就失去核对价值。
版本归档与字段版本管理建议同步进行。每个版本发布后,将填写完成的清单随发布记录一并归档,文件名包含版本号和发布日期;模板本身也应有版本标识,例如在表头注明“模板 v1.2”,并在模板变更记录中写明增删了哪些字段、从哪个版本开始生效。这样回看历史清单时,能判断当时的字段口径,避免用新模板去解读旧清单。
定期复核字段有效性可以放在版本复盘或季度回顾中进行,检查三件事:哪些字段长期为空、哪些字段经常需要临时补充说明、哪些字段的取值在不同填写人之间不一致。长期为空的选填字段可以考虑删除,经常补充说明的字段说明口径不清需要细化,取值不一致的字段应补充枚举值或填写示例。复核结论更新到模板变更记录中,模板才能保持长期可用。
如果清单在 ONES 中承载,需求与缺陷条目可直接对应 ONES Project 中的工作项,清单文档放在 ONES Wiki 中维护,利用文档关联任务和页面版本记录,使清单条目、发布说明与工作项状态保持对应;模板本身也可通过页面模板库固化为制式文档,减少每次新建清单时的字段遗漏。
常见问题
版本内容清单和发布说明文档有什么区别,需要各维护一份吗?
两者关注点不同。版本内容清单面向内部核对,逐条列出需求、缺陷、配置变更和发布说明字段,回答“这个版本到底包含什么、能不能回退”;发布说明文档面向读者,用业务语言描述变化和已知问题。实践中可以只维护清单,把“对外说明摘要”作为发布说明的素材来源;也可以清单与发布说明各一份,但需保证版本号、发布范围、已知问题在两处一致。若清单放在 ONES Wiki 中维护,文档可关联任务并插入工作项列表,发布说明与清单条目能互相对照,减少两处口径不一致。
小团队发布频率高,逐条填写清单会不会负担过重?
可以按发布类型分级。常规小版本保留版本号、需求编号、缺陷编号、配置项名称、关联环境、发布范围、回退方式等必填字段,省略需求负责人、缺陷描述等辅助字段;涉及对外发布或重大变更的版本再补齐对外说明摘要和变更单号。清单维护人可由发布负责人兼任,条目少时不必单独设人。关键是必填字段不留空,辅助字段按需填写,而不是每次发布都填满所有列。
配置变更没有走变更单,清单里“变更单号 / 记录链接”怎么填?
该字段在无审计要求时属于选填,可填写其他可回溯的凭据,例如提交记录、工单编号或配置管理记录中的条目链接。若团队有变更审批流程,应把该字段转为必填,并补齐审批记录后再进入发布评审。确实无法补齐时,在清单末尾的例外记录区写明缺失原因、影响评估和批准人,随版本归档保留,便于事后复盘。
清单里的需求编号、缺陷编号必须和原系统一致吗?
建议直接引用原系统编号,不另起编号体系。清单的价值在于能回查,编号一旦改写,核对时就要多一步映射,容易出错。需求条目对应需求库或需求工作项,缺陷条目对应缺陷库,同一件事不在两处重复登记。以 ONES 为例,需求可编写并自定义状态与属性,缺陷可提交到对应项目或迭代并跟踪修复情况,清单中的编号和状态可以从这些工作项直接对应过来。
模板用了一段时间后,怎么判断哪些字段该删、哪些该补?
在版本复盘或季度回顾时检查三类情况:长期为空的选填字段可以考虑删除;经常需要临时补充说明的字段说明口径不清,应细化填写说明或增加示例;不同填写人取值不一致的字段,应补充枚举值或固定取值。复核结论写入模板变更记录,注明增删字段和生效版本。版本号、需求编号、缺陷编号、配置项名称、关联环境、发布范围、回退方式承担追溯和回退功能,不建议删除。
