跨项目字段不一致,往往从第一张需求表就开始积累:同一个“优先级”在不同项目里有三种取值,同一个“负责人”在报表里对不上号。本文提供一套可直接复制使用的研发平台字段字典参考模板,包含字段主表、枚举值附表和变更记录表三张空白表,并逐列说明填写口径、划分必填与选填、给出一条完整填写示例,最后说明模板落地到平台后的裁剪与维护方法。字段台账需要长期维护时,可以放在 ONES 的项目配置与文档协作体系中承载。
要点总览(TL;DR)
- 跨项目字段字典的核心是一张统一字段台账,以字段ID为主键,记录字段名称、业务含义、数据类型、取值范围、必填规则、适用范围、来源映射与变更记录。
- 模板由三张表组成:字段主表、枚举值附表、变更记录表,三表通过字段ID关联,可先复制到表格工具完成评审再进入平台配置。
- 必填列按四条标准判定:跨项目共用、参与统计或流转、对接外部系统、涉及责任归属;选填列在字段确实不涉及该维度时填“无”,留空表示尚未确认。
- 落地后按裁剪、新增、变更、核对四类动作维护,坚持每个字段有负责人、每次变更先登记后配置,并按季度核对台账与平台配置的一致性。
- 台账可放在 ONES Wiki 的页面模板中维护并利用页面版本记录回滚,字段在平台中的实际配置在项目配置中完成,配置变更后回填台账。
可复制空白字段字典模板
模板由三张表组成:主表记录字段本身,枚举附表记录取值范围,变更记录表记录字段的演化历史。三张表通过“字段ID”关联,复制到表格工具或平台文档中即可开始填写。建议先在表格工具中建好台账、完成评审,再进入平台做字段配置,避免边配边改造成口径漂移。
表一:字段字典主表
| 字段ID | 字段名称 | 业务含义 | 数据类型 | 长度/精度 | 取值范围/枚举来源 | 必填规则 | 默认值 | 校验规则 | 适用项目/工作项类型 | 适用阶段 | 来源系统 | 目标字段映射 | 同步方向 | 负责人 | 状态 | 生效版本 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
表二:字段取值枚举附表
| 字段ID | 枚举编码 | 枚举显示名 | 业务定义 | 排序 | 是否启用 | 生效版本 | 备注 |
|---|---|---|---|---|---|---|---|
表三:字段变更记录表
| 变更编号 | 字段ID | 变更类型 | 变更前 | 变更后 | 变更原因 | 影响范围 | 历史数据处理 | 申请人 | 评审人 | 生效日期 | 关联版本 |
|---|---|---|---|---|---|---|---|---|---|---|---|
复制使用时注意三点:字段ID一经分配不再复用,即使字段废弃也保留原编号;枚举附表只登记有固定取值列表的字段,自由文本字段无需填写;变更记录表从模板启用当天开始记录,首次建账可作为“初始版本”登记一条。
字段说明:每一列记录什么
模板的价值取决于每列填写口径是否统一。下表逐列说明含义与填写要求,并列出常见错误,填写时可直接对照。
| 列名 | 含义 | 填写口径 | 常见错误 |
|---|---|---|---|
| 字段ID | 字段的全局唯一标识,作为主键关联三张表 | 采用“模块缩写-序号”格式,如 REQ-001;一经分配不复用 | 用字段名称代替ID;字段废弃后把ID分配给新字段 |
| 字段名称 | 在平台界面和报表中展示的名称 | 使用业务人员能直接理解的词,同一含义只保留一个名称 | 同一字段在不同项目叫“优先级”“紧急度”“重要程度” |
| 业务含义 | 字段回答的业务问题 | 用一句话写清“记录什么、供谁使用”,如“记录需求对用户的价值等级,供排期评审使用” | 只写“优先级”三个字,无法判断判定标准 |
| 数据类型 | 字段的取值形态 | 按单行文本、多行文本、数字、日期、单选、多选、人员、关联对象等通用类型填写 | 把单选字段写成文本,导致统计时无法聚合 |
| 长度/精度 | 文本长度上限或数字小数位 | 文本写最大字符数,数字写整数位与小数位,如“10位整数、2位小数” | 留空导致平台默认值与业务预期不符 |
| 取值范围/枚举来源 | 字段允许的取值集合 | 枚举字段填写“见附表二”,并注明枚举来源是平台内置还是外部系统下发 | 在主表里直接罗列枚举值,与附表重复且容易不同步 |
| 必填规则 | 字段在什么条件下必须填写 | 填写“始终必填”“选填”或“条件必填:条件描述” | 只写“是/否”,无法表达仅缺陷类工作项必填这类规则 |
| 默认值 | 新建工作项时自动带入的值 | 填写具体值或“无默认值”;默认值必须属于取值范围 | 默认值不在枚举列表内,造成脏数据 |
| 校验规则 | 提交时执行的格式或逻辑校验 | 写清规则表达式或文字描述,如“日期不得晚于计划完成日期” | 写了校验意图但没有可执行口径,配置时无法落地 |
| 适用项目/工作项类型 | 字段在哪些项目和工作项上出现 | 按项目类型(如产品研发、定制交付)和工作项类型(需求、任务、缺陷)分别列出 | 写“全部”,实际只在部分项目启用,台账与配置脱节 |
| 适用阶段 | 字段在生命周期哪些阶段可见或可编辑 | 填写阶段名称,如“评审后可见”“开发阶段必填” | 把阶段规则写进必填列,两列口径混淆 |
| 来源系统 | 字段数据的产生系统 | 填写平台内建或外部系统名称,外部系统注明接口 | 多个系统写入同一字段但未标注主数据源 |
| 目标字段映射 | 与外部系统字段的对应关系 | 写“外部系统.对象.字段名”,一对一时直接填,一对多时拆行说明 | 只写系统名,同步时无法定位具体字段 |
| 同步方向 | 数据流动方向 | 填写“单向流入”“单向流出”“双向同步” | 双向同步未约定冲突处理方,导致互相覆盖 |
| 负责人 | 对该字段定义负责的角色 | 填写岗位或人员,优先写岗位,如“需求管理负责人” | 写多个平级负责人,变更时无人拍板 |
| 状态 | 字段当前生命周期状态 | 按“草稿、评审中、已生效、已废弃”填写 | 字段已停用但状态仍为已生效 |
| 生效版本 | 字段规则开始执行的版本 | 填写版本号或生效日期,与变更记录表关联 | 改了规则不更新版本,历史报表无法解释 |
必填与选填怎么划分
模板列多,全部填满不现实,全部留空又失去台账意义。划分原则是:决定字段能否跨项目对齐的列必须填,只服务于个别项目或个别阶段的列可以选填。
必填列判定标准
满足以下任一条件的列,在字段登记时就必须填写:
- 跨项目共用:字段会在两个及以上项目或工作项类型中出现,字段ID、字段名称、业务含义、数据类型必须填写,否则无法比对。
- 参与统计或流转:字段进入报表、看板、自动化规则或审批流,取值范围/枚举来源、必填规则、适用项目/工作项类型必须填写。
- 对接外部系统:字段与外部系统存在映射,来源系统、目标字段映射、同步方向必须填写,并明确主数据源。
- 涉及责任归属:负责人、状态、生效版本三列始终必填,保证任何字段都能找到维护人和当前有效口径。
选填列的适用情形
长度/精度、默认值、校验规则、适用阶段、变更原因等列,在字段为自由文本、无默认值、无额外校验、全阶段可见时可以留空或写“无”。选填不等于可以不写,而是在字段确实不涉及该维度时省略,评审时由评审人确认省略合理。
条件必填的处理方式
“仅缺陷类工作项必填”“仅对外交付项目必填”这类规则,统一写在必填规则列,格式为“条件必填:条件描述”,并在适用项目/工作项类型列同步写明范围。条件本身要可判断,例如“工作项类型=缺陷时必填”,避免写成“重要项目必填”这类无法执行的口径。
留空与填“无”的区别
留空表示该项尚未确认,属于待办事项,评审时会被退回补充;填“无”表示已确认该字段不涉及此维度,是有效结论。两者在台账中的含义不同,维护时不要用留空代替“无”,否则无法区分遗漏和确认。
填写示例:一条完整字段记录
以下示例演示“需求优先级”字段从主表登记到枚举定义、再到一次变更的完整记录,三张表通过字段ID REQ-001 关联。示例中的项目名称与人员为演示情景。
主表记录
| 列名 | 填写内容 |
|---|---|
| 字段ID | REQ-001 |
| 字段名称 | 需求优先级 |
| 业务含义 | 记录需求对用户与业务的价值等级,供需求评审和排期使用 |
| 数据类型 | 单选 |
| 长度/精度 | 无 |
| 取值范围/枚举来源 | 见附表二,平台内置枚举 |
| 必填规则 | 条件必填:工作项类型=需求且进入评审时必填 |
| 默认值 | P2 |
| 校验规则 | 取值必须属于枚举列表,评审通过后不可直接修改,需走变更 |
| 适用项目/工作项类型 | 产品研发类项目;工作项类型=需求 |
| 适用阶段 | 评审后可见,开发阶段只读 |
| 来源系统 | 平台内建 |
| 目标字段映射 | 无 |
| 同步方向 | 无 |
| 负责人 | 需求管理负责人 |
| 状态 | 已生效 |
| 生效版本 | V1.2 |
枚举附表记录
| 字段ID | 枚举编码 | 枚举显示名 | 业务定义 | 排序 | 是否启用 | 生效版本 | 备注 |
|---|---|---|---|---|---|---|---|
| REQ-001 | P0 | 最高 | 阻断核心流程或影响线上可用性,需立即处理 | 1 | 是 | V1.0 | |
| REQ-001 | P1 | 高 | 影响主要用户路径,当前迭代内安排 | 2 | 是 | V1.0 | |
| REQ-001 | P2 | 中 | 有明确价值但可排入后续迭代 | 3 | 是 | V1.0 | 默认值 |
| REQ-001 | P3 | 低 | 体验优化类,资源允许时处理 | 4 | 是 | V1.0 | |
| REQ-001 | P4 | 待定 | 价值尚未评估,暂不排期 | 5 | 否 | V1.1 | V1.2起停用,历史数据保留 |
变更记录表记录
| 变更编号 | 字段ID | 变更类型 | 变更前 | 变更后 | 变更原因 | 影响范围 | 历史数据处理 | 申请人 | 评审人 | 生效日期 | 关联版本 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| CHG-007 | REQ-001 | 枚举停用 | P4“待定”启用 | P4“待定”停用 | 待定值被滥用,评审时无法形成结论 | 产品研发类项目全部需求 | 历史数据保留P4,新建时不可选 | 需求管理负责人 | 研发效能负责人 | 2025-03-01 | V1.2 |
这条示例与第二节的列说明逐项对应:主表覆盖全部必填列,选填列按实际填“无”;枚举附表只登记有固定取值的字段;变更记录表记录了枚举停用这一动作,并在历史数据处理列说明旧值保留方式,避免报表口径断裂。
模板在平台中的调整与维护方法
模板是台账,平台是执行环境,两者需要保持一一对应。落地后的调整围绕“裁剪、新增、变更、核对”四类动作展开,每个动作都应有明确的责任人和记录。
按项目类型或工作项类型裁剪列
不必要求所有项目使用同一张全量主表。可以按项目类型建立视图:产品研发类项目保留需求、缺陷相关字段,定制交付类项目增加合同编号、交付批次等字段。裁剪只影响视图展示,字段ID和核心列口径保持全局一致,避免同一字段在不同视图中定义不同。
新增字段的评审与登记流程
- 申请人提交字段登记,填写主表全部必填列,状态置为“草稿”。
- 字段负责人审核业务含义与取值范围,确认与已有字段不重复、不冲突。
- 涉及统计或外部对接的字段,由数据或集成负责人确认映射与同步方向。
- 评审通过后状态改为“已生效”,分配生效版本,并在变更记录表登记首次生效记录。
- 在平台完成字段配置后,回填配置位置,保证台账可追溯到具体配置项。
字段废弃、改名、改类型的处理
改名只更新字段名称列,字段ID不变,历史数据自动沿用新名称展示;改类型和废弃属于高风险变更,必须先评估历史数据。改类型时在变更记录表写明旧值如何转换、无法转换的数据如何处理;废弃时状态改为“已废弃”,枚举值停用但保留,平台侧隐藏字段而非删除,确保历史报表仍可解析。任何变更都先登记、后配置,避免平台已改而台账未更新。
版本管理与定期核对节奏
建议按季度做一次台账与平台配置的核对:抽取各项目实际使用的字段,与主表比对名称、类型、必填规则是否一致,差异记入变更记录表并限期修正。版本号按“主版本.次版本”管理,新增字段或枚举升次版本,废弃字段或改类型升主版本,报表和接口文档引用版本号,便于解释历史数据口径。
平台承载方式:台账与配置的对应关系
台账负责定义和留痕,平台负责执行和校验。落地时可以把字段字典作为项目文档维护,借助 ONES Wiki 的页面模板库建立制式化台账页面,并利用页面版本记录实现随时查看与回滚;字段在平台中的实际配置则在项目配置中完成,配置变更后回到台账登记。ONES Project 的自动化规则提供统一管理平台和运行日志,当字段参与流转规则时,可以通过规则运行记录排查字段取值引发的流程问题。字段配置的具体类型、校验与枚举能力,以平台实际配置界面为准,台账中的数据类型与校验规则列按平台可配置的口径填写。
维护机制能否持续,取决于两点:每个字段都有明确负责人,每次变更都先登记后配置。做到这两点,字段字典就能从一张静态表格变成跨项目字段标准的可执行依据。
常见问题
字段字典模板一定要三张表都用吗?只维护主表行不行?
主表是必需的,枚举附表和变更记录表按实际情况启用。字段全部是自由文本、没有固定取值列表时,枚举附表可以暂不使用;但只要字段会改名、改类型或停用枚举值,变更记录表就应启用,否则历史报表口径无法解释。实践中的折中做法是:主表始终维护,枚举附表在出现第一个单选或多选字段时建立,变更记录表在建账当天登记一条“初始版本”记录后持续使用。
模板里的字段ID应该由谁分配,规则需要多严格?
字段ID建议由字段字典的统一维护方分配,避免各项目自行编号造成重复。格式上采用“模块缩写-序号”即可,如 REQ-001,关键是两条纪律:一经分配不复用,字段废弃后原编号保留;新增字段先查重再分配,确认与已有字段不重复、不冲突。如果团队规模较小,也可以由需求管理或研发效能负责人兼任分配职责,不必单独设岗。
字段改类型时,历史数据怎么处理才不影响已有报表?
改类型属于高风险变更,处理顺序是先评估、再登记、后配置。评估阶段确认旧值能否完整转换到新类型,例如文本转单选时,不在枚举列表内的历史值需要先归类或保留为“其他”;登记阶段在变更记录表写明转换规则和无法转换数据的处理方式;配置阶段在平台完成调整后回填台账。对于无法转换的历史数据,通常保留原值并在报表中单独说明,避免直接覆盖导致口径断裂。
多个项目已经各自用了不同的字段名称,模板能直接套用吗?
可以先用模板做一次存量盘点,再逐步收敛。做法是把各项目现有字段逐条登记到主表,业务含义相同的合并为一条记录、保留一个标准名称,其余名称作为别名备注;业务含义确实不同的保留为独立字段。收敛过程按项目类型分批推进,先统一参与统计和流转的字段,再处理仅展示类字段。平台侧的字段配置调整与台账登记同步进行,避免台账已合并而平台仍是旧名称。
字段字典放在文档里维护,和直接在平台配置字段,两者如何避免脱节?
关键是明确分工:台账负责定义和留痕,平台负责执行和校验,任何变更都先登记后配置。落地时可以把字段字典作为项目文档维护,借助 ONES Wiki 的页面模板库建立制式化台账页面,并利用页面版本记录查看与回滚;字段在平台中的实际配置则在项目配置中完成,配置完成后回填台账中的配置位置。再配合季度核对,抽取各项目实际使用的字段与主表比对名称、类型和必填规则,差异记入变更记录表并限期修正。
字段参与自动化流转后,取值问题怎么排查?
字段取值引发的流程问题,通常表现为规则未触发或触发结果不符合预期。排查时先确认字段当前取值是否落在规则设定的条件范围内,再查看规则的运行记录。ONES Project 的自动化规则提供统一管理平台和详细运行日志,可以据此定位规则运行状态与具体环节;规则本身也可以在配置中心的自动化规则页面统一管理。台账中记录字段的校验规则与适用范围,有助于快速判断是字段口径问题还是规则配置问题。
