Glossary

The corresponding phrase is "wildcard" or "asterisk."

The corresponding phrase is "plus sign." It can be used in the UI to represent the "expand" command for a list or collapsible element.

The corresponding phrase is "minus sign." It can be used in the UI to represent the "collapse" command for a list or collapsible element.

Use the article "a" before words that begin with consonants.

Do not add "-able" as a suffix when the result is not a real word. Consult a dictionary to see if the final construction is a valid use of the suffix.

Avoid. Use "end" for operations, "exit" for programs, "stop" for hardware operations, and "cancel" for requests or processes.

Avoid when referring to information in text. Instead, use "preceding" and "following" (or "previous" and "next") if you cannot make specific cross-references.

Ensure that acronyms reflect industry standards. Do not create your own acronyms—​they may overlap with existing terms and cause confusion.

Do not use to describe options, functions, or items that users can select. Use "available" and "unavailable" instead.

Unless referring to a permissions role (for example, "the Admin role"), do not use initial capitalization.

Use "affect" (verb) to mean "influence." Use "effect" (noun) to mean "result."

Do not use. Avoid all-encompassing terms unless they are accurate descriptions.

Avoid using this construction. Choose either "and" or "or," or rewrite the sentence.

Use to describe options or functions that users can select and deselect. Do not use "active," "inactive," "enabled," or "disabled."

Verb; two words.

Noun and adjective.

When referencing the UI, use "box" instead of "field" to refer to any box except a check box, a list, or a menu box.

Do not use the words "the" and "button" when referring to named buttons. If you refer to an unnamed button or an icon in the interface, use the tooltip name along with "the" and "button."

Use "can" instead of "may." "Can" implies ability, while "may" implies permission.

Use "case sensitive" and "not case sensitive." Use a hyphen when writing "case-sensitive" as an adjective (for example, "your case-sensitive password").

Use when the reader must make a decision, as opposed to selecting (not picking) an item from a list to carry out a decision already made.

Use for check boxes instead of "deselect," "turn off," "unmark," "uncheck," or "unselect."

Use to refer to choosing a command, option, or button using the mouse.

All lowercase.

Verb used to describe ending a session.

A text box with a list box attached. The list is always visible. Because users can either type or select their choice, you can use "enter" to describe the action.

The menu that appears when you right-click something. Do not use "right-click menu."

Do not use to describe a program failing. Instead, use "exit," "quit," or "stopped responding."

Do not use. Use "active window" or "open window" instead.

The cursor is the pointer that appears on the screen and moves according to the movements of the mouse. A cursor takes on different shapes (different arrows, a hand with a pointing finger, and so on) according to its context. The mouse is the device that the user moves on the desk to control the cursor.

A person who purchases or uses our software. Do not use "client" as a synonym for "customer."

Use as a noun or adjective only.

The background display on a monitor. Do not use "host," "workstation," "box," "node," or "machine."

Use instead of "grayed" if you must describe the appearance of an unavailable command or item. Use along with "appears," as in "the unavailable item appears dimmed."

Use as a transitive verb or noun referring generically to the visual output device and its technology (for example, "a flat-panel display").

Adjective. Use only if necessary to describe how an item such as a menu works or what it looks like. Its use is acceptable if necessary to describe the type of item, as in "a drop-down arrow" or "drop-down menu."

When referring to an arrow that becomes a drop-down list, indicate which list the user can view by clicking the arrow (for example, "Click the Size arrow for more options").

Use an en dash to indicate an inclusive range.

Use an em dash to set apart a phrase, similar to the use of parentheses. Do not put a space between the em dash and adjacent words.

Use "email" (lowercase e, not hyphenated). Capitalize only if used at the beginning of a sentence, included in a title, or as a label on a window or screen. Avoid using as a verb.

Use to describe a database field, rather than "blank." Do not use to describe a field that is actually null.

Do not use to describe items that users can or cannot select. Use "available" and "unavailable" instead.

For nouns, use "end user" (two words). For adjectives, use "end-user" (hyphenated).

Generally, use "ensure" rather than "assure," "insure," or "make sure."

Do not use as a synonym for "type," except to indicate that a user can interact with the UI through multiple methods, such as typing text or clicking a selection from a list.

Use "fewer" when you can count a set of items. Use "less" when you cannot.

Do not use; instead, use "box" or an appropriate descriptor for the UI element.

Always use exact wording to refer to a field on a screen. Do not truncate, abbreviate, or take shortcuts.

For nouns, use "free text" (for example, "enter free text"). For adjectives, use "freetext" (for example, "a freetext entry").

Avoid; use "stopped responding" instead.

The actual physical location of a monitored node, represented by its latitude and longitude.

One gigabyte is equal to 1,073,741,824 bytes, or 1,024 megabytes. Use the standards outlined below:

Use "Git" (capitalized) to refer to the version control software.

Avoid; use "exit," "quit," or "stopped responding" instead.

Two words, lowercase. Use to refer to the opening page of a website.

Also "desktop" or "workstation." Do not use "box," "node," or "machine."

Avoid using to refer to the action of using the cursor to activate something on the screen. Instead, assume that the user knows how to activate the screen element in question. Use "point to" if the user is unlikely to know.

Use only to describe a graphical representation of an object that the user can select and open, such as a drive, disk, folder, document, or program. When referring to an icon, bold its name.

All caps, unless referring to a field name that is formatted differently on the UI.

"On" is preferred to "in" when referring to UI components, disks, hardware platforms, the screen itself, a network, and the web. Do not use "on" when referring to user actions, such as "click."

One kilobyte is equal to 1,024 bytes. Use the standards outlined below:

When referring to an area of a screen, use "left" and "right," not "left-hand side" or "right-hand side."

Do not use to refer to a menu. Do not use "pull-down list."

Also refers to monitoring location. Do not use to refer to geolocation.

For nouns and adjectives, use "lookup" (one word). For verbs, use "look up" (two words).

Use instead of "master" to refer to the base branch of a Git repository, unless the branch is named "master."

One megabyte is equal to 1,048,576 bytes, or 1,024 kilobytes. Use the standards outlined below:

A list of items (not options) on the menu bar. Do not use "pull-down menu."

Also referred to as "Minion location" or "location."

The device that the user moves on their desk to control the cursor.

Use instead of "must have" or "necessary." Use "if needed" or "as needed" rather than "if you need to."

Avoid unless it is an accurate description.

Use to describe a database field that is null. If the database field is empty, use "empty" instead, not "blank."

Hyphenate "on-site" when using the phrase as a compound adjective. With verbs, use "on site" (two words).

"Only" is a modifier, and should be used as such.

Use instead of "radio button," unless describing the element type in developer content. Use "select" and "clear" to describe interacting with an option.

A generic term for the back-end hardware, software, and services that support the operation of a portal.

A prefix meaning "before." This prefix is usually affixed to words without using a hyphen (for example, "prefix," "predate"). Use a hyphen in the following cases:

Initial, default settings configured in a freshly installed program.

Verb to use when referring to a keyboard key. Use instead of "depress," "strike," or "hit."

The official terms for our software. Do not use "application," "component," or "program."

Do not include the punctuation from a prompt or field label on the UI, or from the default entry associated with the prompt or field label. An exception to this rule is when the prompt or field label ends in a question mark.

Use only to describe the element itself in developer content when referring to the type of buttons available. Otherwise, use "option."

Refers to the iteration of software. Capitalize when referring to a specific release (for example, "Release 30.1").

Verb used to describe the mouse action that displays the context menu. Hyphenated.

Refers to the process of installing or upgrading end-user offices.

Use to tell readers what to do with programs, macros, and so on.

Use to refer to the graphic portion of a visual output device. Avoid using to refer to UI elements.

As a general rule, use to direct the reader to a cross-reference.

Verb. Use to describe interactions with check boxes and choices on a menu or list. Use "clear" instead of "unselect."

Use only in relation to time. Do not use as a synonym for "because."

Capitalize references to the Start menu and the Start button on the Windows taskbar. Do not refer to the Start button as "the Windows Start button."

Use to introduce an essential clause. When referring to people, use "who" instead (for example, "users who," not "users that").

"There" can be used as an adverb that indicates a place or a point, a pronoun that introduces a sentence in which the verb precedes the subject, or a noun that indicates the place.

Use instead of "type in" or "enter" when referring to information that a user must type, such as a password.

Not "Unix."

Use when referring to a vertical position on a screen. Always include a hyphen when using "upper-left" or "upper-right."

When referring to a user’s name, use "user name."

Avoid if possible. Use instead of "wish" or "desire."

Use "web" (lowercase) when referring to the World Wide Web. Do not use "Web" (uppercase).

Capitalize and use a hyphen. Do not use "WiFi" or "wifi."

Do not use unless "screen" does not apply.

Use the exact name of the window if there is one displayed on the screen. Use initial capitalization for the title, but lowercase for the word "window" (for example, "the Ref/Auth Inquiry window").