Word choice
Find the right term to use in your UI copy.
Use these preferred words and terms
Use these words and terms in the scenarios described in the following table:
Word | Usage notes |
---|---|
add | Use for establishing a new relationship. Often used in create-then-add scenarios. Create a dashboard, then add a visualization. In button labels, always follow add by an object. Remove is the correct opposite. |
cancel | Use to stop an action without saving pending changes. |
can't | Use to indicate you don't have the ability to do something. Often confused with unable. |
create | Use for creating an object from scratch. In button labels, always followed by an object. Do not use create new. Delete is the correct opposite. |
delete | Use when deleting data that users can no longer retrieve. Create is the correct opposite. |
edit | Don't use change or modify. Edit is the better choice for localization. |
enter | Use when the user enters text. Don't use type. |
later | Use when referring to versions of the product. For example, Elastic Stack 8.13 and later. |
open | Use when opening an application or program. Don't use launch. |
press | Use press for keyboard keys. Don't use hit. |
remove | Use when removing a relationship, but not permanently deleting the data. For example, you remove a visualization from a dashboard. Add is the correct opposite. |
select | Select is preferred over choose. |
use | Use instead of utilize and make use of. |
view | Use instead of see because view is more inclusive. |
Avoid these words and terms
This section includes terms that you should avoid in most instances. These terms might be offensive, non-inclusive, unclear, or unnecessary. Use the alternate suggestions in the following tables or a more specific term.
Latin abbreviations
Latin abbreviations can be unclear. Use the following suggestions instead:
Word | Usage notes |
---|---|
e.g. | Use for example or such as instead. |
i.e. | Use that is instead. |
via | Use with, by using, or through instead. |
Directional language
Directional language does not meet accessibility requirements and you should avoid it, especially as the only way to find an element in the UI. Use the following suggestions instead:
Word | Usage notes |
---|---|
above | Use a link, previous, or preceding instead. |
below | Use a link or following instead |
Nouns created from verbs
Avoid using nouns created from adjectives or verbs. These words often make text unnecessarily complex. For example:
- Use choose instead of make a choice.
- Use register instead of complete your registration.
- Use investigate instead of conduct an investigation.
General words and terms to avoid
Avoid the following words and terms, and use the suggestions instead:
Word | Usage notes |
---|---|
abort | Use shut down, cancel, or stop instead. |
as well as | Use and instead. |
blacklist | Use blocked list instead. |
boot | Use start or run instead. |
bottom left, bottom right | Use lower left or lower right instead. Hyphenate when using as an adjective. For example, lower-left corner. |
choose | Use select instead. See Words for interacting with UI |
disable | Use turn off, block, or hide. |
enable | Use turn on or allow. |
easy, easily | It can be frustrating for users to think that something is easy, but then struggle to do the task. Typically the same meaning can be conveyed without this word. |
execute | Use run or start instead. |
hack | For a noun, use tip or work-around instead. For a verb, use configure or modify. |
hit | For a noun, use visits (as in web visits). For a verb, use select or press. |
hear, hear about | Use learn instead. |
impact | Don't use impact as a verb. Use affect instead. |
in order to | Use simple verbs like to instead. |
invalid | Use not valid or incorrect instead. |
just | Don't use before a command, like "just click here." |
launch | Use open instead. |
ok | Don't use when labeling buttons. Use words that explain the action instead, for example, Delete rule. |
normal, normally | Use usual or typical instead. For normally, use usually, typically, or generally instead. |
please | In most cases, please is unnecessary. Only use when the user must wait or do something inconvenient. |
simple, simply | Unnecessary because it doesn't add any information or value. |
sorry | Only use sorry in error messages that cause serious problems for the user. |
success | Unnecessary because success is generally implied. |
terminate | Use stop or exit instead. |
type | Use enter because there is typically more than one way to enter text. |
top left, top right | Use upper left or upper right instead. Hyphenate when using as an adjective. For example, upper-left corner. |
utilize | Don't use utilize when you mean use. |
whitelist | Use allow list instead. |
Use caution with these words and terms
These words and terms might be appropriate in some situations and inappropriate in others. Only use them when appropriate.
Word | Usage notes |
---|---|
app, application | Use only when needed for clarity. Otherwise, a Kibana application name can stand alone. App is a well-known abbreviation for application and is preferred. |
begin | Use context to decide between begin and start. For example, begin a procedure, begin an analysis, or begin an installation are common phrases. Similarly, start a program, start an engine, or start a timer are frequently used. Start is considered less formal than begin. End is the correct opposite of begin. |
can | Use for capability. Rewrite as an action if possible. For example, instead of you can add... use add.... |
click | Acceptable to use when describing mouse actions. Otherwise, use verbs that work with multiple devices, such as select. |
clone | Use when creating a copy that is linked to the original. Often confused with copy and duplicate. |
copy | Use when the file is added to a clipboard and can be pasted in a new location. Often confused with clone and duplicate. |
disable | Don't use to describe something that is broken. Use inactive, unavailable, deactivate, turn off, or deselect, depending on the context. |
duplicate | Use when immediately creating a copy of an object in the same location as the original. Often confused with copy and clone. |
kill | Use cancel or stop unless the actual command is kill . |
may | Use may for permissibility. Use can for capability. Use might for possibility. |
start | Use context to decide between start and begin. For example, start a program, start an engine, or start a timer are common phrases. Similarly, begin a procedure, begin an analysis, or begin an installation are frequently used. Start is considered less formal than begin. |
unable | Unable means not being able to perform an action. Often confused with cannot. |