Skip to end of banner
Go to start of banner

Self Help Guidelines

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

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.

Each wiki page must include an excerpt using the Excerpt macro

Is it time to review a Self Help document you are responsible for? Self Help Space Report

Before You Start

Adhere to all typeface and image best practices:

  • Bold face: Use for menu and button names

  • Italics: Use for system messages and titles

  • Respect the Oxford comma (red, white, and blue )

  • Add hyperlinks when necessary. Embed link into descriptive text where possible.

  • use → not -> for series of selections (the wiki editor should auto replace -> with →)

  • Use the code block macro for large blocks of code or text you expect people to copy paste

  • Insert emojis using the new text editor

  • Refer to the different flavors of devices as: MacOS, Windows, iOS, or Android (never MAC or PC). Refer to hardware by the manufacturer: HP, Dell, Apple

  • Images should be resized before adding to the document. No borders. Use red (Hex code #FF0000) color and 3 pixels width for callouts (arrows, rectangles or ovals).

Use Info panel macro to add information

Add a note of caution with a warning panel macro

Before You Start

Adhere to all typeface and image best practices:

  • Bold face: Use for menu and button names

  • Italics: Use for system messages and titles

  • Respect the Oxford comma (red, white, and blue)

  • Add hyperlinks when necessary. Embed link into descriptive text where possible.

  • use → not -> for series of selections (the wiki editor should auto replace -> with →)

  • Use code macro for large blocks of code or multi-line text you expect people to copy paste

  • Use Keyboard Shortcuts for Emoticons

  • Refer to the different flavors of devices as: macOS, Windows, iOS, or Android (never MAC or PC). Refer to hardware by the manufacturer: HP, Dell, Apple

  • Images should be resized to medium and linked to original for consistency. No borders. Use red (Hex code #FF0000) color and 3 pixels width for callouts (arrows, rectangles or ovals).

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

Steps

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

  1. Create a new document

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

  3. Remove all extraneous optional sections

  4. Enter information, including hidden page properties

  5. Seek review and input from colleagues and your manager 

  6. When approved, remove viewing restrictions

Do not forget to update labels! Look at Space Reports for a list of currently used labels.

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 is exists within the More Help pages, it's unnecessary to create the header for this section.

  • No labels