diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-10-13 15:12:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-10-13 15:12:01 +0300 |
commit | 447ad69728c0cb35db1190694f29806cf7c59a88 (patch) | |
tree | 43bbb4de84f19663cc3a19c32e8585310f42672a /doc/development/documentation/styleguide | |
parent | ce79b3dd66d0e9616d547f90a93cce0b709407a3 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r-- | doc/development/documentation/styleguide/word_list.md | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index 509cabbe631..7dc633a3092 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -208,6 +208,14 @@ Instead, use **assign**. For example: Use **authenticated user** instead of other variations, like **signed in user** or **logged in user**. +## before you begin + +Use **before you begin** when documenting the tasks that must be completed or the conditions that must be met before a user can complete a tutorial. Do not use **requirements** or **prerequisites**. + +For more information, see [the tutorial page type](../topic_types/tutorial.md). + +For task topic types, use [**prerequisites**](#prerequisites) instead. + ## below Try to avoid **below** when referring to an example or table in a documentation page. If required, use **following** instead. For example: @@ -1253,10 +1261,12 @@ in the context of other subscription tiers, follow [the subscription tier](#subs ## prerequisites -Use **prerequisites** when documenting the steps before a task. Do not use **requirements**. +Use **prerequisites** when documenting the tasks that must be completed or the conditions that must be met before a user can complete a task. Do not use **requirements**. For more information, see [the task topic type](../topic_types/task.md). +For tutorial page types, use [**before you begin**](#before-you-begin) instead. + ## press Use **press** when talking about keyboard keys. For example: @@ -1321,9 +1331,12 @@ Use title case for **Repository Mirroring**. ## requirements -Use **prerequisites** when documenting the steps before a task. Do not use **requirements**. +When documenting the tasks that must be completed or the conditions that must be met before a user can complete the steps: -For more information, see [the task topic type](../topic_types/task.md). +- Use **prerequisites** for tasks. For more information, see [the task topic type](../topic_types/task.md). +- Use **before you begin** for tutorials. For more information, see [the tutorial page type](../topic_types/tutorial.md). + +Do not use **requirements**. ## respectively |