Category: Style Guide

Images

Please refer to the following for guidance on adding images/screenshots: Capture screenshots for documentation Add images and captions in WordPress

Read More »

Formatting

Bold formatting When referring to any UI element by name, put its name in boldface. This includes names for buttons, menus, dialogs, windows, list items,

Read More »

Tables

Tables make complex information easier to understand by presenting it in a clear structure. In a table, data is arranged into two or more rows

Read More »

Headings

Write all documentation headings in sentence case and, in most cases, use an imperative verb, as the majority of our documentation instructs readers to do

Read More »

Organization

Content can overwhelm readers if it’s not organized—especially when they’re trying to follow step-by-step instructions. Organizing content properly makes it easier for readers to access

Read More »

Slashes

When using slashes in phrases, file paths, and URLs: Don’t place spaces around a slash. Example: Incorrect: Policies / Claims Correct: Policies/Claims Capitalize the word

Read More »

Periods

Don’t use end punctuation in headlines, headings, subheadings, UI titles, UI text, or simple lists (three or fewer words per item). End all sentences with

Read More »

Parenthetical elements

If the parenthetical element is part of and ending a sentence, place closing punctuation outside the closing parenthesis. Example: Access the Emails dashboard to view

Read More »