Versions Compared

Key

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

This article explains the policies for creating and editing self help documents. Use the “Self-Help Article Template” or “Brightspace Self Help Template” for all new documents.

...

1. New Page

  • New Page

    Click on the image-20240508-142234.pngImage Modified button on the top menu

    • Select Page from the drop-down

    • create page.png

2. Restricting Access while creating a new page

  • Click on the lock restrickt.pngImage Modifiedicon under the search bar to open the Restriction Manage Access window

    • Click on the drop down arrow and choose “Only specific people can view or edit “

      • only specific.pngImage Removedonly specific.pngImage Added
    • In the “Enter a person or group” field and type Wiki-CITEditors

    • Select image-20240509-174727.png and click image-20240509-174951.png

    • addwiki.pngImage Removedaddwiki.pngImage Added
      • This will add that group with edit access

    • Click image-20240509-180155.png to save and close the Manage access window

3. Apply the Self Help Article Template

  • From your new page, scroll to the bottom and click on the Self Help Article Template

  • page.pngImage Removed
  • Enter information, including hidden page propertiesto place it on your page.

    • page.pngImage Added
      • Please do not alter the names of provided section headers nor change the template's default font family or sizes.

      • Delete optional ones that are not used.

      • Create additional headings with Heading 1 format.  

  • Give this page a title: Enter the page title in the

  • Excerpt: Write a friendly overview of what the article is about in this section

  • Before You Start: Optional section using a bulleted list. Please follow the guidelines at CIT Self Help Guidelines

  • Steps: Break down your steps in a logical manner.

    • Use a numbered list for ease of reference.

    • Insert your steps.

    • You can also copy and paste or drag-and-drop images into your instructions.

    • For more than 10 steps, consider breaking into different sections.

  • Info Panels: Use to highlight information in a colored panel

    • Two info panels are included in the Self-Help Template

      • Info Panel

      • Caution Panel

    • All About Info Panels

      • To add more info panels, Click the + sign on the top navigation menu and select Info Panel

      • infopanel.pngImage Added

  • Seek review and input from colleagues and your manager 

  • When approved, remove viewing restrictions

...

Note

Is it time to review a Self Help document you are responsible for? /wiki/spaces/HELP/pages/77922493

...

Best Practices

Adhere to all typeface and image best practices:

...