debian-mirror-gitlab/doc/user/okrs.md

stage	group	info
Plan	Product Planning	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Objectives and key results (OKR) (ULTIMATE)

Introduced in GitLab 15.6 with a flag named okrs_mvc. Disabled by default.

WARNING: OKRs are in Alpha. For the OKR feature roadmap, see epic 7864.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to enable the featured flag named okrs_mvc. The feature is not ready for production use.

Use objectives and key results to align your workforce towards common goals and track the progress. Set a big goal with an objective and use child objectives and key results to measure the big goal's completion.

The objective and the key result in GitLab share many features. In the documentation, the term OKR refers to either an objective or a key result.

OKRs are a type of work item, a step towards default issue types in GitLab. For the roadmap of migrating issues and epics to work items and adding custom work item types, see epic 6033 or the Plan direction page.

Create an objective

Prerequisites:

• You must have at least the Guest role for the project.

To create an objective:

1. On the top bar, select Main menu > Projects and find your project.
2. On the left sidebar, select Issues.
3. In the top right corner, next to New issue, select the down arrow {chevron-lg-down} and then select New objective.
4. Select New objective again.
5. Enter the objective title.
6. Select Create objective.

To create a key result, add it as a child to an existing objective.

View an objective

Prerequisites:

• You must have at least the Guest role for the project.

To view an objective:

1. On the top bar, select Main menu > Projects and find your project.
2. On the left sidebar, select Issues.
3. Filter the list of issues for Type = objective.
4. Select the title of an objective from the list.

View a key result

Prerequisites:

• You must have at least the Guest role for the project.

To view a key result:

1. On the top bar, select Main menu > Projects and find your project.
2. On the left sidebar, select Issues.
3. Filter the list of issues for Type = key_result.
4. Select the title of a key result from the list.

Alternatively, you can access a key result from the Child objectives and key results section in its parent's objective.

Edit title and description

Prerequisites:

• You must have at least the Reporter role for the project.

To edit an OKR:

1. Open the objective or key result that you want to edit.
2. Optional. To edit the title, select it, make your changes, and select any area outside the title text box.
3. Optional. To edit the description, select the edit icon ({pencil}), make your changes, and select Save.

Assign users

To show who is responsible for an OKR, you can assign users to it.

Users on GitLab Free can assign one user per OKR. Users on GitLab Premium and higher can assign multiple users to a single OKR. See also multiple assignees for issues.

Prerequisites:

• You must have at least the Reporter role for the project.

To change the assignee on an OKR:

1. Open the objective or key result that you want to edit.
2. Next to Assignees, select Add assignees.
3. From the dropdown list, select the users to add as an assignee.
4. Select any area outside the dropdown list.

Assign labels

Prerequisites:

• You must have at least the Reporter role for the project.

Use labels to organize OKRs among teams.

To add labels to an OKR:

1. Open the objective or key result that you want to edit.
2. Next to Labels, select Add labels.
3. From the dropdown list, select the labels to add.
4. Select any area outside the dropdown list.

Add an objective to a milestone

Introduced in GitLab 15.7.

You can add an objective to a milestone. You can see the milestone title when you view an objective.

Prerequisites:

• You must have at least the Reporter role for the project.

To add an objective to a milestone:

1. Open the objective that you want to edit.
2. Next to Milestone, select Add to milestone. If an objective already belongs to a milestone, the dropdown list shows the current milestone.
3. From the dropdown list, select the milestone to be associated with the objective.

Set objective progress

Show how much of the work needed to achieve an objective is finished.

You can only set progress manually on objectives, and it's not rolled up from child objectives or key results.

Prerequisites:

• You must have at least the Reporter role for the project.

To set progress of an objective:

1. Open the objective that you want to edit.
2. Next to Progress, select the text box.
3. Enter a number from 0 to 100.

Set health status

Introduced in GitLab 15.7.

To better track the risk in meeting your goals, you can assign a health status to each objective and key result. You can use health status to signal to others in your organization whether OKRs are progressing as planned or need attention to stay on schedule.

Prerequisites:

• You must have at least the Reporter role for the project.

To set health status of an OKR:

1. Open the key result that you want to edit.
2. Next to Health status, select the dropdown list and select the desired health status.

Close an OKR

When an OKR is achieved, you can close it. The OKR is marked as closed but is not deleted.

Prerequisites:

• You must have at least the Reporter role for the project.

To close an OKR:

1. Open the objective that you want to edit.
2. Next to Status, select Closed.

You can reopen a closed OKR the same way.

Child objectives and key results

In GitLab, objectives are similar to key results. In your workflow, use key results to measure the goal described in the objective.

You can add child objectives to a total of 9 levels. An objective can have up to 100 child OKRs. Key results are children of objectives and cannot have children items themselves.

Child objectives and key results are available in the Child objectives and key results section below an objective's description.

Add a child objective

Prerequisites:

• You must have at least the Guest role for the project.

To add a new objective to an objective:

1. In an objective, in the Child objectives and key results section, select Add and then select New objective.
2. Enter a title for the new objective.
3. Select Create objective.

To add an existing objective to an objective:

1. In an objective, in the Child objectives and key results section, select Add and then select Existing objective.

2. Search for the desired objective by entering part of its title, then selecting the desired match.

   To add multiple objectives, repeat this step.

3. Select Add objective.

Add a child key result

Prerequisites:

• You must have at least the Guest role for the project.

To add a new key result to an objective:

1. In an objective, in the Child objectives and key results section, select Add and then select New key result.
2. Enter a title for the new key result.
3. Select Create key result.

To add an existing key result to an objective:

1. In an objective, in the Child objectives and key results section, select Add and then select Existing key result.

2. Search for the desired OKR by entering part of its title, then selecting the desired match.

   To add multiple objectives, repeat this step.

3. Select Add key result.