| 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. |
Best Practices
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 )
Embed hyperlinks into descriptive text where possible.
use → not -> for a series of selections
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 hardware by the manufacturer: HP, Dell, MacOS, Windows, iOS, or Android (never MAC or PC)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).
Ensure the language used is appropriate for a campus prioritizing DEI issues. Refer to the college’s Inclusive Language Guide.
| Table of Contents | ||
|---|---|---|
|
1. New Page
Go to the space you want the new page to live in from the left content menu (don’t worry, you can easily move it later.)
Click
...
the
...
Create button
...
at the top
...
of the page, and select Page.
or Select Page from the drop-down
...
2. Restricting Access while creating a new page
Click on the lock
icon under the search bar to open the Restriction Manage Access windowClick on the drop down arrow and choose “Only specific people can view or edit “
...
In the “Enter a person or group” field and type Wiki-CITEditors
Select
and click 
...
This will add that group with edit access
Click
to save and close the Manage access window
3.
...
Insert the Self Help Article Template
From your new page, scroll to the bottom and click on the Self Help Article Template to place it on your page.
...
DO NOT alter the names of the provided section headers, nor change the template's default font family or sizes.
Delete optional
...
sections that are not used.
Create additional headings with Heading 1 format.
4. Edit the Self Help Article Template
Give this page a title
...
Enter
...
a descriptive page
...
title
The title should start with the topic name, then the action
Excerpt
Replace this text with a friendly overview of what the article is about in this section
Before You Start
...
Optional section using a bulleted list.
Remove if not needed
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
...
You can move the panels by deragging them to a new location .
To add more info panels, Click the + sign on the top navigation menu and select Info Panel:
...
Notes
...
Optional section using
...
Related Topics:
...
Seek review and input from colleagues and your manager
...
When approved, remove viewing restrictions
| Note |
|---|
Do not forget to update labels! Look at /wiki/spaces/HELP/pages/77922493 for a list of currently used labels. |
| 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:
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).
Ensure the language used is appropriate for a campus prioritizing DEI issues. Refer to the college’s Inclusive Language Guide.
| Info |
|---|
Use Info panel macro to add information |
| Note |
|---|
Add a note of caution with a warning panel macro |
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.
...
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.
...
Modify Existing Labels
remove the self-help label
add the self-help-deprecated label
...
Append "(deprecated)" to the article's title
...
Include a warning block at the top of the article to indicate it is obsolete/unneeded content
...
Update the hidden Page Properties panel with your name and the date
...
Preview the document to make certain it is correct.
...
Save the changes.
a bulleted list.
Remove if not needed
Related Articles
The related articles section uses 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
...
Click within the resource box to access the edit button
Click the x to remove the help label and enter the labels you want referenced.
5. Still Need Help
This section should not be altered.
6. Page Properties
On each page, there are important properties
...
Owned by (top of page) change to the manager of the group responsible for content
Owner (area) refers to the area that is the primary owner of the document
Reviewed by
...
using the @ to tag someone
Review Date the
...
keystroked “//” will bring forward a date picker
7. Add Labels
To open the label input field when editing a page:
Select the ... from the top right of the page, then select Add labels or Edit labels.
In the legacy editor, select the label icon from the top of the page you’re editing, to the right of the breadcrumb.
Select the labels you’d like to add from the suggestion list or create a new label using the text you entered. (self-help must be added to every page. Many of our reports depend on that label)
8. Analyze Page Accessibility with WAVE
Every page should be analyzed by WAVE to make your content more accessible.
WAVE is easy to use. It can be used at the WAVE website by entering the URL of a web page or by installing a browser plugin to Chrome or Firefox.
9. Publishing
Seek review and input from colleagues and your manager
When approved, remove viewing restrictions
When you first publish a page or blog post draft by selecting Publish…
, you’ll see several publishing options and settings in one place. 
Choose where the page or blog post will go.
Choose who can see the page or blog post after publishing.
Add version comments to describe the page you are publishing or updating. These comments can be helpful later when reviewing a page’s history.
Schedule a publication for a future date and time.
Convert a page into a blog post.
Other than location and access, all fields in the publish dialog are optional. Spending the time to adjust your settings up front can save time on future updates.
Related articles
| Filter by label (Content by label) | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Page Properties | |
|---|---|
Replace owner (area) and reviewed by with information appropriate to this article. Set the review date.
|
...
|
...
|
...
|