Versions Compared

Version Old Version 11 New Version 12
Changes made by

Susan Palmer

Susan Palmer

Saved on

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.

Creating a New Self-Help Page

Warning

Restrict page during creation, editing, and review to the wiki group Wiki-CITEditors

  1. Click on the image-20240508-142234.png button on the top menu

  2. Select Page from the drop-down

    1. create page.png

  3. Click on the lock restrickt.pngicon under the search bar to open the Restriction Manage Access window

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

      1. only specific.pngImage Removed

        only specific.pngImage Added

  4. Apply the Self Help Article Template or the Brightspace Self Help Template

  5. Remove all extraneous optional sections

  6. Enter information, including hidden page properties

  7. Seek review and input from colleagues and your manager 

  8. When approved, remove viewing restrictions

...

Note

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

Before You Start

Adhere to all typeface and image best practices:

...

from https://sketchplanations.com/redundant-words

Related Articles

Related articles appear here based on the labels you select. You must click to edit the macro and add or change labels.

  • The related articles section should use the Content by Label macro.

  • Where possible, the macro should be configured to show the most related articles. 

  • The following image shows an example of this macro that was configured to show only self-help documents related to backups

More Help

  • the More Help section should use the Include Page macro to include the More Help or More Brightspace Help page

  • Because the header for this section exists within the More Help pages, it's unnecessary to create the header for this section.

Deprecating Self-Help Documents

How to mark self-help documents as deprecated so they are retained but understood to no longer be current guidance. Deprecated articles should be reviewed annually to determine whether or not they still need to be maintained.

  1. Modify Existing Labels

    1. remove the self-help label

    2. add the self-help-deprecated label

  2. Append "(deprecated)" to the article's title

  3. Include a warning block at the top of the article to indicate it is obsolete/unneeded content

  4. Update the hidden Page Properties panel with your name and the date

  5. Preview the document to make certain it is correct.

  6. Save the changes.

Page Properties

On each page, there are important properties.

...