Title

1. Start the title with "How to"

2. Only the first letter in the title is capitalized, except for proper nouns.

3. Make the title very specific to the action and where the action is taking place.

Example: How to add new editors in ScreenSteps

Introduction

1. Writing an introduction is optional

2. use the Introduction style

Headings

Capitalization

1. First letter of a sentence

2. Proper nouns

3. Elements on a screen (buttons, tabs, etc.)

Wording and formatting

1. Start the heading with an action verb such as "Click" or "Navigate" or "Scroll."

2. Each heading is short.

3. Do not include the preposition "on" (example: Click on the button––instead, Click the button).

4. Use > when describing a series of clicks. Example: Click Home > Profile > Action.

Example of a heading: Click Account Settings

Steps

Use Steps to provide clear sequencing to step-by-step procedures.

1. Search for Account number
2. Open Account settings

Paragraph text

Capitalization

1. First letter of a sentence

2. Proper nouns

3. Elements on a screen (buttons, tabs, etc.)

Wording and formatting

1. Bold words that describe areas of screen that are clicked. Example: Click Account Settings to see a list of options.

2. Use numbered lists when describing a series of steps that must be done in order.

3. Use bulleted lists for descriptions with no particular order.

4. Match numbered list to sequencing annotations on screenshots

5. Use > when describing a series of short clicks. Example: Click Home > Profile > Action.

Tables

1. Use tables to describe what should be typed in fields fields on a form.

2. Use Header Row/Column

Example:

Hyperlinks

1. Use inline links for hyperlinks to other knowledge base articles that provide explanations which enhance the content within the article.

2. Use new tabs for hyperlinks to other knowledge base articles that direct a reader to more relevant content.

Foldable sections

Additional information that is helpful, but not pertinent, can be included as a foldable section.

Paragraph styles

Screenshots

1. Screenshots should be no wider than 800 pixels

2. Use a screenshot for each major on-screen action.

3. Use multiple screenshots in the same block to demonstrate a sequence.

   • If multiple screenshots are used, include a drop shadow for each screenshot.

Annotations

1. Use annotation presets.

2. Do not use more than 4 sequence annotations on a single screenshot.

3. Use Arrows to point out parts of the screen that need to be clicked or fields that need to be entered.