Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Click tools and copy this template before beginning.
  2. Rename the Document and follow the instructions for formatting the job aid.
    • Delete the instructions that are not needed.
  3. In the first paragraph, introduce the topic you will be covering, for whom this job aid is intended, and what they will get out of the job aid.

If document is incomplete-

  1.  Click Restricted at the end of the page.
  2. Type ID&T in the Enter user or group name field. 
  3. Click Restrict.
    Once job aid is complete repeat Step 1 and click Remove Restriction.

The following topics are covered:

Table of Contents
maxLevel4
minLevel2

Formatting 

In the field above remove Job Aid Template and enter the name of the job aid. When naming the job aid ensure that the name is meaningful to the topic being discussed and is not long. The Heading format is Heading 2. However, since this green is not listed in the font color choice, copy then paste this heading to get the same format and color in your section heading. Should you need a Sub-heading select Heading 4 from the font choice above. The following describes how to number and format your steps.

Numbering

  1. Click the numbering icon in the tool bar to begin numbering.
  2. To add a sub-list i.e. a, b, c...
    1. Press Enter on your keyboard.
    2. Press Tab on your keyboard
      Or
      Click the tab right icon on the tool bar.
  3. To add bullet points to a numbered list-
    1. Press Enter on your keyboard.
    2. Press Tab on your keyboard.
    3. Click the bullets icon in the toolbar.
    This shows what a bullet list should look like:
    • Name – type last name first.
    • Address – include your postal code.
    • Phone – include your area code.

Formatting

  1. Bold and capitalize the Name of buttons and other options that the user is instructed to click/select.
    If a sentence is not a step, but describes a result of an action, such as "The USF Health Learn home page will open" or "You will receive a confirmation email," do not number it. Instead, use a soft return (hold down the Shift key and press the Enter key) after the step and then type the result.

  2. Follow the steps below if you need to highlight something that is not a step.

 

Tip
titleTIP

If there is a reminder, tip or short note that you need to let users know about, follow this format.

  1. Click Insert
  2. Click Other Macros
  3. Click Formatting
  4. Select Tip, Note, Warning or any of the other macros to highlight your message.
  5. Type the name of the message (example: TIP, NOTE, or WARNING)

  6. Click Insert
  7. Type your message in the box inserted.

Back to top

Create Custom Border in Snagit

  1. Open Snagit Editor

  2. Click the Image tab

  3. Select Effects.
    The menu expands.

  4. Select Shadow from the dropdown, and a second dropdown menu opens.

  5. Select More Shadows. The Drop Shadow Edge Control Window opens.

  6. Change the Shadow Depth to 7px under Shadow.

  7. Change the Outline Width to 7px under Outline.

  8. Change the Outline Color to the custom blue used throughout our documentation. RGB code: 0, 104, 72

  9. Click the drop-down arrow on the Image Style menu.

  10. Click Add to Quick Styles.

Back to top

Add Image 

Not every step needs an image. Use images that are meaningful and relevant to the topic. Images should be placed after the step in reference and its figure number and location mentioned after the statement. Before inserting your image, edit in Snagit and keep at a high resolution. After inserting the image on your page, click the image to re-size if needed.

...

Reference Image (See figure...)

  1. Add a reference to the image after the step. Example See figure 1.
  2. Click the beginning of the image.
  3. Click Insert.
  4. Select Other Macro.
  5. Select Anchor.
    The Insert Anchor Macro page will open.
  6. Type a simple name. Example A1.
  7. Click Insert.
    An Anchor will be place before the image.
  8. Highlight the corresponding See figure reference.
  9. Click Link.
  10. Select Advanced.
  11. Type # and the name of the Anchor.

Back to top

Add Table of Contents

Once your Headings and formatting are consistent, a table of contents can be added under your 1st paragraph. The Table of Contents uses the Heading format to created links for the user to jump to that particular section. If this template page is copied the table of contents is already added to the top of the job aid. It will automatically adjust as you add Headings and Sub-headings. should you need to add a table of contents to a new document follow the instructions below. 

...

There are two ways you can find your pages:

Method 1: Type in the page you are looking for in the address bar.