Help us learn about your current experience with the documentation. Take the survey.

自定义字段

  • Tier: Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed

自定义字段为工作项（如问题和史诗）添加符合您特定规划需求的专业信息。 为组配置自定义字段，以跟踪业务价值、风险评估、优先级排名或团队属性等数据点。 这些字段会出现在该组、其子组和项目中的所有工作项中。

自定义字段帮助团队在整个工作流程中标准化信息记录和报告方式。 这种标准化创造了项目间的一致性，并支持更强大的过滤和报告功能。 选择各种字段类型以满足不同的数据需求和规划场景：

  • 单选
  • 多选
  • 数字
  • 文本

为组配置自定义字段

为顶级组配置自定义字段，使其在该组、其子组和项目中的工作项可用。

创建自定义字段

创建自定义字段以捕获团队需要跟踪的特定信息。 您可以为一个或多个工作项类型配置每个字段，使工作流程适应 您组织的需求。

请注意以下限制：

  • 一个顶级组最多可以有 50 个活跃的自定义字段。
  • 一个工作项类型最多可以有 10 个分配给它的自定义字段。

先决条件：

  • 您必须至少拥有该组的 Maintainer 角色。

要创建自定义字段：

  1. 在左侧边栏，选择 Search or go to 并找到您的组。 该组必须是顶级组。
  2. 选择 Settings > Issues。
  3. 选择 Create field。
  4. 完成以下字段：

    • 在 Type 中，选择字段应为何种类型：

      • 单选
      • 多选
      • 数字
      • 文本字段

      创建字段后无法更改字段类型。

    • 在 Use on 中，选择您希望此字段可用的工作项类型。

    • 在 Options（单选和多选字段中），输入可能的选项。 单选或多选字段最多可以有 50 个选项。

      • 通过拖动每个选项左侧的抓取图标（ grip ）来重新排序选项。
      • 要一次添加多个选项，选择输入框并粘贴项目列表，每行一个。
  5. 选择 Save。

编辑自定义字段

编辑现有的自定义字段以反映组织需求的变化。 您可以修改字段名称、其适用的工作项类型和可用选项，而 不会丢失现有数据。

先决条件：

  • 您必须至少拥有该组的 Maintainer 角色。

要编辑自定义字段：

  1. 在左侧边栏，选择 Search or go to 并找到您的组。 该组必须是顶级组。
  2. 选择 Settings > Issues。
  3. 在要编辑的字段旁边，选择 Edit <field name>（ pencil ）。
  4. 对任何字段进行更改。
  5. 选择 Update。

归档自定义字段

归档不再需要的自定义字段，同时保留其历史数据。 归档会从任何使用过该字段的工作项中移除该字段。

先决条件：

  • 您必须至少拥有该组的 Maintainer 角色。

要归档自定义字段：

  1. 在左侧边栏，选择 Search or go to 并找到您的组。 该组必须是顶级组。
  2. 选择 Settings > Issues。
  3. 在要归档的字段旁边，选择 Archive <field name>（ archive ）。

取消归档自定义字段

当您需要再次使用时，恢复之前归档的自定义字段。 曾为此字段设置值的工作项会保留归档前相同的值。

先决条件：

  • 您必须至少拥有该组的 Maintainer 角色。

要取消归档自定义字段：

  1. 在左侧边栏，选择 Search or go to 并找到您的组。 该组必须是顶级组。
  2. 选择 Settings > Issues。
  3. 选择 Archived 选项卡以列出已归档的字段。
  4. 在要取消归档的字段旁边，选择 Unarchive <field name>（ redo ）。

为工作项设置自定义字段值

使用为您的组配置的自定义字段，向工作项添加相关信息。

先决条件：

  • 您必须至少拥有工作项项目或组的 Planner 角色。
  • 如果您拥有 Guest 角色，只能在创建工作项时设置自定义字段。
  1. 转到工作项。
  2. 在右侧边栏，找到要编辑的自定义字段部分，然后选择 Edit。
  3. 输入或选择所需的值。
    • 文本字段的值最多可以有 1024 个字符。
  4. 在字段外选择任何区域。

字段类型选择指南

创建自定义字段时，选择与您要跟踪的数据类型匹配的字段类型。 正确的字段类型可以提高数据质量，使报告更有效。

单选字段

在以下情况下使用单选字段：

  • 用户应该从预定义列表中选择一个选项。
  • 选项是互斥的。
  • 您希望强制执行一致性并防止自由输入。

单选字段适用于：

  • 优先级指示器（如 High、Medium、Low）
  • 类别分配
  • 团队分配
  • 审批状态
  • 优先级级别

多选字段

在以下情况下使用多选字段：

  • 可能同时应用多个值。
  • 您需要跟踪重叠的属性。
  • 项目可能属于多个类别。

多选字段适用于：

  • 标签或标签
  • 所需技能
  • 受影响的组件
  • 利益相关者群体
  • 功能特性

数字字段

在以下情况下使用数字字段：

  • 您需要收集定量数据。
  • 您想要执行计算或聚合。
  • 信息需要按数字排序。

数字字段适用于：

  • 成本估算
  • 时间估算
  • 业务价值分数
  • 排名或优先级分数
  • 完成百分比

文本字段

在以下情况下使用文本字段：

  • 您需要捕获不适合预定义类别的独特信息。
  • 数据高度可变。
  • 您需要提供上下文或详细信息。

文本字段适用于：

  • 附加上下文
  • 外部参考 ID
  • 联系信息
  • 简短笔记或评论
  • URL 或链接

自定义字段的命名约定

自定义字段一致的命名约定使它们更易于理解和使用。 良好的字段名称提高了采用率和数据质量。

一般指南

  • 保持名称简洁但描述性。
  • 使用您的组织理解的清晰、具体的语言。
  • 保持大小写一致（建议使用标题大小写）。
  • 避免使用缩写，除非它们被广泛理解。
  • 在适用时包含度量单位。

命名单选和多选字段

以类别名称开头，后跟描述符。例如：

  • Risk Level 而不是 Risk
  • Customer Segment 而不是 Segment
  • Development Phase 而不是 Phase
  • Approval Status 而不是 Status

命名数字字段

在字段名称中包含度量单位。例如：

  • Effort Points 而不是 Points
  • Budget Estimate ($) 而不是 Budget
  • Implementation Time (days) 而不是 Time
  • Business Value Score 而不是 Value

命名文本字段

清楚指示应输入什么信息。例如：

  • External Reference ID 而不是 Reference
  • Implementation Notes 而不是 Notes
  • Requirements Source 而不是 Source

团队特定前缀

如果多个团队使用同一个 GitLab 实例，考虑添加团队前缀以避免混淆：

  • DEV: Sprint Priority
  • QA: Test Environment
  • UX: Design Status
  • PM: Market Segment

这种方法帮助团队快速识别哪些字段与他们的工作相关。