工作项字段字典把每个字段的名称、标识、类型、适用范围和取值规则集中登记在一张表里,让产品、研发、测试和平台管理员对同一字段有统一理解。本文提供可直接复制到文档或表格工具的空白主表与枚举值附表,逐列说明填写口径,给出必填与选填的划分规则,并用一份需求类工作项的完整示例演示填法,最后说明字段增删改时的维护方法。
要点总览(TL;DR)
- 模板由两张表组成:主表逐字段登记名称、标识、类型、适用范围、取值范围、必填、默认值、来源与维护人;附表登记单选、多选字段的全部候选值。
- 必填判定看三条:缺少该字段是否阻断流程、是否造成统计口径缺口、是否导致责任无法追溯;三条都不满足的标为选填,但仍需完整登记。
- 示例以需求类工作项演示六行主表记录和两组枚举值,字段标识统一采用“业务域_含义”的小写结构,默认值取自附表启用值。
- 维护分三步:新增、修改、停用都在字典中留痕,变更记录表登记影响范围并通知相关角色,按迭代或季度导出平台配置逐行核对。
- 字段字典定稿后可据此配置平台的工作项类型与字段,使字典中的名称、标识和取值与系统配置保持对应。
可复制的工作项字段字典空白模板
字段字典由两张表组成。主表逐字段登记基本信息,枚举值附表登记下拉类字段的候选值。两张表通过“字段标识”关联:主表中取值范围为枚举的字段,在附表中列出全部候选值。使用时把表头复制到文档或表格工具,逐行填写即可。
主表:字段登记表
| 字段名称 | 字段标识 | 字段类型 | 适用工作项类型 | 取值范围 | 是否必填 | 默认值 | 来源 | 维护人 | 备注 |
|---|---|---|---|---|---|---|---|---|---|
附表:枚举值登记表
| 字段标识 | 枚举值 | 显示顺序 | 适用工作项类型 | 状态 | 说明 |
|---|---|---|---|---|---|
主表末尾的“备注”列用于记录口径解释、历史变更原因或与其他字段的联动关系,属于辅助列,可按团队习惯保留或删除。附表的“状态”列标记枚举值处于启用还是停用,停用的值保留在表中以便追溯历史数据。
字段说明:每一列记录什么
模板的每一列对应一个填写口径。填写前先明确各列含义,可以避免同一字段在不同工作项类型下出现名称不一致、标识重复或取值口径冲突的问题。下表逐列说明。
| 列名 | 填写内容 | 填写口径 |
|---|---|---|
| 字段名称 | 面向使用者的显示名称 | 使用业务人员能理解的词,同一含义在全平台保持同一名称,例如统一叫“优先级”,不混用“紧急程度” |
| 字段标识 | 系统内唯一的技术标识 | 用英文小写字母、数字和下划线组成,按“模块_含义”命名,如 priority、req_source;创建后尽量不改动,避免影响已有数据和集成 |
| 字段类型 | 字段的数据形态 | 常见类型包括单行文本、多行文本、数字、日期、单选、多选、人员、附件、布尔值;类型决定取值范围怎么写 |
| 适用工作项类型 | 该字段出现在哪些工作项上 | 填写需求、任务、缺陷、工单等具体类型;多个类型用顿号分隔;全类型通用时写“全部” |
| 取值范围 | 字段允许的取值 | 文本类写长度或格式约束;数字类写区间和单位;日期类写格式;单选、多选写“见附表”并在附表中列全候选值 |
| 是否必填 | 创建或流转时是否必须填写 | 填“必填”或“选填”,判定规则见下一节 |
| 默认值 | 新建工作项时自动带入的值 | 填写具体值或“无”;默认值必须落在取值范围内,枚举字段的默认值须是附表中的一个启用值 |
| 来源 | 字段的业务出处 | 说明字段由哪个业务环节或制度要求产生,例如“需求评审要求”“质量门禁要求”,便于判断字段是否还有存在必要 |
| 维护人 | 负责该字段口径的人 | 填写角色或具体人员,通常为对应业务域的负责人;平台配置操作人可另记在变更记录中 |
| 备注 | 补充说明 | 记录联动规则、历史变更原因、与其他字段的依赖关系 |
字段标识的命名口径需要团队统一。建议采用“业务域_含义”的结构,全部小写,单词之间用下划线连接,避免使用拼音缩写和序号。标识一旦被报表、自动化规则或外部集成引用,修改成本较高,因此登记时就应确认语义准确。
字段类型与取值范围存在对应关系:文本类字段的取值范围写长度或格式要求;数字类写上下限和单位;日期类写日期格式;单选、多选类写“见附表”,候选值全部登记在枚举值附表中;人员类写可选范围,例如“本产品成员”。类型与取值范围不匹配时,字典本身就会出现歧义,填写时应逐行核对。
必填与选填怎么划分
字典中的“是否必填”描述的是业务填写要求,判定依据是:缺少该字段是否会导致流程无法推进、统计口径失真或责任无法追溯。三条中满足任意一条,才标为必填;仅“希望大家都填”的字段应标为选填,通过默认值或提示引导填写。
- 流程阻断类:评审、流转、关闭等环节必须依据的字段,例如需求类工作项的“优先级”,缺少它无法排期,标为必填。
- 统计口径类:报表和看板按此字段分组或过滤,缺失会造成数据缺口,例如“需求来源”,标为必填。
- 责任追溯类:需要明确到人的字段,例如“需求负责人”,标为必填。
- 描述补充类:用于补充背景、便于阅读的字段,例如“补充说明”,标为选填,但要在字典中登记,避免后续被随意新增。
选填字段同样需要完整登记名称、标识、类型和取值范围。选填不等于不管理:字段一旦进入平台,就会出现在表单和报表中,登记清楚才能控制字段总量,防止表单越配越长。
字典中还有一类列属于字典自身的管理列,不描述业务字段的填写要求,包括“来源”“维护人”“备注”,以及附表中的“显示顺序”“状态”。这些列用于字典的维护和追溯,不参与必填判定,也不应出现在工作项表单的必填校验中。区分业务字段列与管理列,可以避免把维护信息误配成业务必填项。
填写示例:一个需求类工作项的字段字典
以下示例以需求类工作项为例,演示主表与附表的填写方式。示例中的字段为演示情景,团队应按自身业务补充或删减。
主表示例
| 字段名称 | 字段标识 | 字段类型 | 适用工作项类型 | 取值范围 | 是否必填 | 默认值 | 来源 | 维护人 | 备注 |
|---|---|---|---|---|---|---|---|---|---|
| 需求标题 | req_title | 单行文本 | 需求 | 1–80 字符 | 必填 | 无 | 需求评审要求 | 产品负责人 | 标题需能独立说明需求内容 |
| 需求来源 | req_source | 单选 | 需求 | 见附表 | 必填 | 内部提出 | 需求统计口径 | 产品负责人 | 用于来源分布统计 |
| 优先级 | priority | 单选 | 需求、任务、缺陷 | 见附表 | 必填 | 中 | 排期要求 | 项目经理 | 与排期看板联动 |
| 需求负责人 | req_owner | 人员 | 需求 | 本产品成员 | 必填 | 创建人 | 责任追溯要求 | 产品负责人 | 变更时需通知原负责人 |
| 预计上线日期 | req_release_date | 日期 | 需求 | YYYY-MM-DD | 选填 | 无 | 发布计划 | 项目经理 | 进入开发后补填 |
| 补充说明 | req_note | 多行文本 | 需求 | 不超过 2000 字符 | 选填 | 无 | 描述补充 | 产品负责人 | 记录背景与约束条件 |
枚举值附表示例
| 字段标识 | 枚举值 | 显示顺序 | 适用工作项类型 | 状态 | 说明 |
|---|---|---|---|---|---|
| req_source | 内部提出 | 1 | 需求 | 启用 | 产品、研发、运营内部提出 |
| req_source | 客户反馈 | 2 | 需求 | 启用 | 来自客户或售前渠道 |
| req_source | 线上问题 | 3 | 需求 | 启用 | 由线上故障或监控转化 |
| priority | 高 | 1 | 需求、任务、缺陷 | 启用 | 当期必须完成 |
| priority | 中 | 2 | 需求、任务、缺陷 | 启用 | 默认值 |
| priority | 低 | 3 | 需求、任务、缺陷 | 启用 | 可延后处理 |
对照前文的字段说明可以逐列验证示例:字段标识采用“业务域_含义”的小写结构;单选字段的取值范围统一写“见附表”,候选值在附表中列全;默认值“中”“内部提出”均来自附表启用值;必填字段都对应流程、统计或追溯要求,选填字段也完整登记了类型和约束。附表中“显示顺序”和“状态”属于管理列,不进入业务必填判定。
调整与维护方法
字段字典的价值在于与平台配置保持一致。平台新增字段、修改取值或停用字段时,字典应在同一变更中同步更新,否则报表口径和表单校验会逐渐偏离实际配置。维护动作分为登记、记录和核对三类。
新增、修改与停用字段的登记方式
- 新增字段:先在主表追加一行,填写完整列信息;枚举类字段同时在附表登记全部候选值;确认字段标识不与已有字段重复后再配置到平台。
- 修改字段:名称、取值范围、默认值、必填属性的变化直接更新对应单元格;字段标识原则上不改,确需修改时在备注中注明原标识和影响范围。
- 停用字段:不删除行,在备注中标注“已停用”和停用日期,附表中对应枚举值状态改为停用;保留历史数据可追溯。
字段变更的记录与通知
建议单独维护一张变更记录表,与字典主表放在同一文档中。每次变更登记变更日期、字段标识、变更类型、变更内容、影响范围和操作人,并通知受影响的角色,例如必填属性变化需通知提交需求的业务人员,枚举值停用需通知使用该值做报表的团队。
| 变更日期 | 字段标识 | 变更类型 | 变更内容 | 影响范围 | 操作人 | 通知对象 |
|---|---|---|---|---|---|---|
| 新增/修改/停用 | ||||||
定期核对字典与平台配置
建议按迭代或季度节奏做一次核对:导出平台当前的工作项字段配置,与字典主表逐行比对,重点检查字段名称、必填属性、枚举值和默认值四项;发现差异时判断是字典漏登还是平台误配,修正后在变更记录中留痕。字段数量较多的团队可以按工作项类型分批核对,每次覆盖一类。
在ONES Project中,需求支持自定义状态与多种属性,项目类型和相关组件可以按业务需求灵活定义,工单场景也支持自定义处理流程与字段配置。字段字典确定后,可以据此在平台中配置对应的工作项类型与字段,使字典中的名称、标识和取值与系统配置一一对应。团队规模较大时,可结合产品、项目、任务多层级权限,把字段配置的维护职责分配给对应业务域的负责人,字典的“维护人”列与平台权限角色保持一致,变更时责任清晰。
常见问题
字段字典和平台里的工作项表单配置是什么关系?
字段字典是配置前的口径约定,平台表单是配置后的执行结果。字典先确定字段名称、标识、类型、取值范围和必填属性,再据此在平台中配置对应的工作项类型与字段。两者出现差异时,以字典记录的变更记录为线索判断是字典漏登还是平台误配,修正后同步更新。
字段标识创建后还能改吗?
原则上不改。字段标识一旦被报表、自动化规则或外部集成引用,修改会影响已有数据和集成链路。确需修改时,在字典备注中注明原标识和影响范围,并同步检查引用该标识的报表与规则,改完后在变更记录中留痕。
停用的枚举值要不要从附表里删掉?
不删。把附表中该枚举值的状态改为“停用”,保留行和说明,历史工作项中已使用的值仍可追溯。删除会导致历史数据失去口径解释,报表按该值分组时也无法还原。
团队字段很多,一次核对不完怎么办?
按工作项类型分批核对,每次覆盖一类,例如本轮核对需求类字段,下轮核对缺陷类字段。每批重点比对字段名称、必填属性、枚举值和默认值四项,发现差异当场判断并记录,避免一次全量比对流于形式。
字典里的“维护人”和平台配置操作人需要是同一个人吗?
可以不同。维护人负责字段口径的解释和变更决策,通常是业务域负责人;配置操作人负责在平台执行修改,记在变更记录表中。团队规模较大时,可结合产品、项目、任务多层级权限,把字段配置的维护职责分配给对应业务域负责人,使字典的维护人列与平台权限角色保持一致。
