Title

1. The title includes name of a procedure, not the specific tasks.

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

3. Include the term "procedure" at the beginning of the title.

Example: Procedure––run a webinar

Policy

1. Include a policy heading.

2. Write out the policy as a numbered list.

3. Use the introduction style.

Headings

Headings are only used to distinguish different roles or timing of a procedure. Only include headings if two or more roles are being explained in a procedure, or if a procedure takes place over two or more periods.

Capitalization

1. First letter of a sentence

2. Proper nouns

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

Paragraph text outside of checklist item

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.

Paragraph text within checklist item

1. Follow the guidelines for paragraph text outside of checklist item.

2. The paragraph text within a checklist item should be specific to the checklist item task.

3. If you have a knowledge base article that explains how to perform the checklist item task (e.g. Create a webinar), then provide an inline hyperlink to the article.

Tables

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

2. Use Header Row/Column when applicable

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. Only include screenshots for tasks/actions that are unique to the checklist item––otherwise, reference an existing article.

2. Screenshots should be no wider than 800 pixels

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

4. 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.