Versions Compared

Key

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

...

  • 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 is 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.

Owner (area) refers to the area that is the primary owner of the document

SME Is the subject matter expert - who can assist the owner with keeping it up to date?

Reviewed by use the @ to tag someone

Review Date the key stroked “//” will bring forward a date picker

Page Properties

Replace owner (area) and reviewed by with information appropriate to this article. Set the review date.

Owner (area)

CIT Managers

SME

CIT Managers

Reviewed by

Laurie Fox

Review Date

...