Vocabulary

In technical writing, using a vocabulary allows for consistency and comprehensibility.

In This Article

Brand Names

List of Terms

checkbox

A UI element that users can select and deselect.

Acceptable Unacceptable
checkbox check box, check-box

click

Describes a mouse interaction where the user selects and clicks an item once. Only applicable to mouse interactions. For touch interfaces, use tap instead.

Use click X and not click on X.

Acceptable Unacceptable
Click the icon to launch the application. Click on the icon to launch the application.

earlier

Versions of software preceding the referenced version.

Acceptable Unacceptable
Versions 4.0 and earlier are supported. lower
or
older

for example

  • Preferred expression for introducing an example.
  • May vary depending on the position in text.
  • Alternatives:

    • "One example is"
    • "Examples include"
    • "For instance"
    • "By way of illustration"
    • "To illustrate"

hover over

Describes a mouse interaction where the user moves the mouse pointer over an item without selecting or interacting with it. Only applicable to mouse interactions.

  • Use hover over as the verb form.
  • Use hover or hovering (without over) as the noun form.
  • Use hovering (without over) as the adjective form.
Acceptable Unacceptable
Hover over these targets to see different tooltip contents generated from the same tooltip Hover the targets to see different tooltip contents generated from the same tooltip.
The hover toggles a tooltip. The hover-over toggles a tooltip.

later

Versions of software following the referenced version.

Acceptable Unacceptable
Versions 4.0 and later are supported. higher
or
newer

starting with

Use starting with to reference a version which introduces a notable change (such as a major new feature or a major feature deprecation).

Acceptable Unacceptable
Starting with Progress® KendoReact™ v8.0.0, you can now... Since Progress® KendoReact™ v8.0.0, you can now...
or
As of Progress® KendoReact™ v8.0.0, you can now...
Starting with version 3.0, you can no longer... Since version 3.0, you can no longer...
or
As of version 3.0, you can no longer...

unavailable

  • The preferred term for UI controls that users are blocked from operating because of irrelevance.
  • Note that "dimmed" is acceptable when simply describing the appearance of a control.
  • Unacceptable:

    • "disabled"
    • "grayed out"
Acceptable Unacceptable
Click the radio button. You will notice that the UI elements in the lower part of the window become unavailable. Click the radio button. You will notice that the UI elements in the lower part of the window become grayed out.
(UI elements that appear dimmed have been made unavailable because of lack of sufficient permissions.)

tap

Describes a touch interaction where the user selects and taps an item. Only applicable to touch interfaces. For mouse-based interactions, use click instead.

Use tap X and not tap on X.

Acceptable Unacceptable
Tap the map to drop a pin on the respective location. Tap on the map to drop a pin on the selected location.

toolbar

Type as one word.

In this article
Not finding the help you need?