Skip to content

Waiting List Holding Page

A short description for the feature (can be the same used in the frontmatter's description).

Overview

To write the feature overview, you should consider answering the following questions:

  • What is it?
  • Who is it for?
  • What is the context in which it is used and are there any prerequisites/requirements?
  • What can the user do with it? (Be sure to consider multiple audiences, like GitLab admin and developer-user.)
  • What are the benefits to using it over any alternatives?

Use cases

Describe one to three use cases for that feature. Give real-life examples.

Related documentation

Depending on what you are trying to do documentation for the feature is split into the following roles.

Requirements

State any requirements, if any, for using the feature and/or following along with the tutorial.

The only assumption that is redundant and doesn't need to be mentioned is having an account on GitLab.

Instructions

("Instructions" is not necessarily the name of the heading)

  • Write a step-by-step guide, with no gaps between the steps.
  • Start with an h2 (##), break complex steps into small steps using subheadings h3 > h4 > h5 > h6. Never skip the hierarchy level, such as h2 > h4, as it will break the TOC and may affect the breadcrumbs.
  • Use short and descriptive headings (up to ~50 chars). You can use one single heading ## How it works for the instructions when the feature is simple and the document is short.
  • Be clear, concise, and stick to the goal of the doc: explain how to use that feature.
  • Use inclusive language and avoid jargons, as well as uncommon and fancy words. The docs should be clear and easy to understand.
  • Write in the 3rd person (use "we", "you", "us", "one", instead of "I" or "me").
  • Always provide internal and external reference links.
  • Always link the doc from its higher-level index.