- Task topic titles
- Task introductions
- Task prerequisites
- Related topics
A task gives instructions for how to complete a procedure.
Tasks should be in this format:
# Title (starts with an active verb, like "Create a widget" or "Delete a widget") Do this task when you want to... Prerequisites (optional): - Thing 1 - Thing 2 - Thing 3 To do this task: 1. Location then action. (Go to this menu, then select this item.) 1. Another step. 1. Another step. Task result (optional). Next steps (optional).
Here is an example.
# Create an issue Create an issue when you want to track bugs or future work. Prerequisites: - You must have at least the Developer role for the project. To create an issue: 1. On the top bar, select **Main menu > Projects** and find your project. 1. On the left sidebar, select **Issues > List**. 1. In the upper-right corner, select **New issue**. 1. Complete the fields. (If you have reference content that lists each field, link to it here.) 1. Select **Create issue**. The issue is created. You can view it by going to **Issues > List**.
For the title text, use the structure
active verb +
Create an issue.
If several tasks on a page share prerequisites, you can create a separate
topic with the title
If more than one way exists to perform a task in the UI, you should document the primary way only.
However, sometimes you must document multiple ways to perform a task. When this situation occurs:
- Introduce the task as usual. Then, for each way of performing the task, add a topic title.
- Nest the topic titles one level below the task topic title.
- List the tasks in descending order, with the most likely method first.
- Make the task titles as brief as possible. When possible,
Here is an example.
# Change the default branch name You can change the default branch name for the instance or group. If the name is set for the instance, you can override it for a group. ## For the instance Prerequisites: - You must have at least the Maintainer role for the instance. To change the default branch name for an instance: 1. Step. 1. Step. ## For the group Prerequisites: - You must have at least the Developer role for the group. To change the default branch name for a group: 1. Step. 1. Step.
Usually an API exists to perform the same task that you perform in the UI.
When this situation occurs:
- Do not use a separate heading for a one-sentence link to the API.
- Do not include API examples in the Use GitLab documentation. API examples belong in the API documentation. If you have GraphQL examples, put them on their own page, because the API documentation might move some day.
- Do not mention the API if you do not need to. Users can search for the API documentation, and extra linking adds clutter.
If someone feels strongly that you mention the API, at the end of the UI task, add this sentence:
To create an issue, you can also [use the API](link).
To start the task topic, use the structure
active verb +
provide context about the action.
Create an issue when you want to track bugs or future work.
To start the task steps, use a succinct action followed by a colon.
To create an issue:
As a best practice, if the task requires the user to have a role other than Guest, put the minimum role in the prerequisites. See the Word list for how to write the phrase for each role.