For clear and consistent communication, it’s important to always use correct terminology.
You can find most terms in the word list that's maintained by the Technical Writing team. If you do not see the term you need, open a merge request to add it, or contact a technical writer for assistance.
- Search the product for the term before creating a new term.
- Be extremely cautious when using jargon and colloquialisms. They can confuse new users and cause problems with internationalization.
- Consider screen readers and their ability to interpret non-standard terminology.
Use the following guidance in addition to the guidance in the word list.
Settings & Configuration
The term "Settings" should be used within the product for consistent language.
|Configure the settings.||Configure the configuration.|
|Set the ||Set the |
|The script deploys our setup configuration.||The script deploys our setup settings.|
A setting changes the default behavior of the product. A setting consists of a key/value pair, typically represented by a label with one or more options.
A configuration is a collection of settings commonly associated with setup and installation to determine the foundation of execution.
Preferences are a collection of user-specific, system-level settings like theme and layout.
Verbs & adjectives
When using verbs or adjectives:
If the context clearly refers to the object, use them alone.
If the context isn’t clear enough, use them with the object.
Last updated at: