Commit f4a54c6a authored by Suzanne Selhorn's avatar Suzanne Selhorn

Moved verbs about navigating to word list

Related to: https://gitlab.com/gitlab-org/technical-writing/-/issues/454
parent 86022ed9
......@@ -1456,27 +1456,9 @@ Follow these styles when you're describing user interface elements in an
application:
- For elements with a visible label, use that label in bold with matching case.
For example, `the **Cancel** button`.
For example, `Select **Cancel**`.
- For elements with a tooltip or hover label, use that label in bold with
matching case. For example, `the **Add status emoji** button`.
### Verbs for UI elements
Use these verbs for specific uses with user interface
elements:
| Recommended | Used for | Replaces |
|:--------------------|:--------------------------------------|:----------------------|
| select | buttons, links, menu items, dropdowns | click, press, hit |
| select or clear | checkboxes | enable, click, press |
| expand | expandable sections | open |
| turn on or turn off | toggles | flip, enable, disable |
### Other Verbs
| Recommended | Used for | Replaces |
|:------------|:--------------------------------|:----------------------|
| go to | making a browser go to location | navigate to, open |
matching case. For example, `Select **Add status emoji**`.
## GitLab versions
......
......@@ -75,10 +75,17 @@ Use lowercase for **boards**, **issue boards**, and **epic boards**.
One word, **checkbox**. Do not use **check box**.
You **select** (not **check** or **enable**) and **clear** (not **deselect** or **disable**) checkboxes.
## CI/CD
Always uppercase. No need to spell out on first use.
## click
Do not use. Instead, use **select** with buttons, links, menu items, and lists.
**Select** applies to more devices, while **click** is more specific to a mouse.
## currently
Do not use when talking about the product or its features. The documentation describes the product as it is today. ([Vale](../testing.md#vale) rule: [`CurrentStatus.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/CurrentStatus.yml))
......@@ -117,6 +124,10 @@ Do not use. If the user doesn't find the process to be easy, we lose their trust
Do not use Latin abbreviations. Use **for example**, **such as**, **for instance**, or **like** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml))
## expand
Use instead of **open** when you are talking about expanding or collapsing a section in the UI.
## email
Do not use **e-mail** with a hyphen. When plural, use **emails** or **email messages**.
......@@ -203,6 +214,13 @@ Do not use when talking about version numbers.
- Avoid: In GitLab 14.1 and higher.
- Use instead: In GitLab 14.1 and later.
## hit
Don't use to mean **press**.
- Avoid: Hit the **ENTER** button.
- Use instead: Press **ENTER**.
## I
Do not use first-person singular. Use **you**, **we**, or **us** instead. ([Vale](../testing.md#vale) rule: [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml))
......@@ -293,6 +311,13 @@ Lowercase. If you use **MR** as the acronym, spell it out on first use.
Lowercase.
## navigate
Do not use. Use **go** instead. For example:
- Go to this webpage.
- Open a terminal and go to the `runner` directory.
## need to, should
Try to avoid. If something is required, use **must**.
......@@ -334,6 +359,12 @@ Do not use roles and permissions interchangeably. Each user is assigned a role.
Do not use. For details, see the [Microsoft style guide](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/p/please).
## press
Use when talking about keyboard keys. For example:
- To stop the command, press <kbd>Control</kbd>+<kbd>C</kbd>.
## profanity
Do not use. Doing so may negatively affect other users and contributors, which is contrary to the GitLab value of [Diversity, Inclusion, and Belonging](https://about.gitlab.com/handbook/values/#diversity-inclusion).
......@@ -454,6 +485,12 @@ Use lowercase. ([Vale](../testing.md#vale) rule: [`ToDo.yml`](https://gitlab.com
Use title case. ([Vale](../testing.md#vale) rule: [`ToDo.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/ToDo.yml))
## toggle
You **turn on** or **turn off** a toggle. For example:
- Turn on the **blah** toggle.
## useful
Do not use. If the user doesn't find the process to be useful, we lose their trust.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment