Best Practices

Thankfully, most of the default settings in screensteps are what we do for the articles. Don't change things like colors, sizes (i.e. thickness, etc) for things like boxes or arrows and you should be ready to go!

General Organization

In almost every case, every action should be divided into a step. A step has three parts;

1. A Heading

2. A picture, such as a screenshot. (optional, but necessary in most cases)

3. Text explaining the step.  

Most content is added by clicking this "plus" icon, which we will call the Add button.

Headings

Headings should be 1-5 words in most cases, and should give the reader a basic idea of what the step entails. Every word should be capitalized.

Pictures

To add a screenshot, go up into the top left and click the screenshot button.

If you click on the arrow beside the screenshot button, you can change the amount of time that you will have in the countdown before the screenshot is taken.

You can add pictures that are not screenshots by:

1. Clicking the add button (the plus mark in the top left)

2. Selecting Image File.

Text

Text should be bolded if it is an action (such as a click) or an item (such as a button).

If it has multiple steps, they should be numbered, and include Sequence Annotations (see the next section).

Picture Options

If you click on a picture, you will have annotation options in the top bar.

1. Line Annotation

Use this tool to add arrows into a picture.

2. Rectangle Annotation

Use this tool to add rectangles into a picture.

3. Oval Annotation

Use this tool to add ovals into a picture

4. Highlight Annotation

Use this tool to highlight certain items in a picture. This should always be text only. Buttons, etc, should be marked with the Rectangle/Oval tools.

5. Sequence Annotation

Use these for a numbered list. Always have corresponding steps in the text field.

6. Text Annotation

This is rarely used, but can be used if deemed necessary. Most times, text will just appear in the step text below the picture.

7. Blur Annotation

This should always be used if there is sensitive information in a screenshot or image, such as a name, grade, login information, etc. You may adjust the level of blur, as appropriate.

Screenshots

You should do your best to make a screenshot the size of a 3x5 inch notecard. Sometimes this cannot be achieved: try to avoid overly large or small screenshots.

By clicking and dragging on the adjustment lines in the bottom right of a picture, you can adjust the size after importing it into the article.

Submitting an Article

There are two ways to submit an article.

1. Save as Draft

Use this feature if you are submitting an unfinished article.

2. Save & Publish

Use this feature if you are finished and the article is ready to be submitted for review.

1. Article owner

Always put your name or account here. Do not put the name of someone else, such as Brother Wilcock.

2. Article status

If the article needs content: Needs Content

If the article needs an update to its current content: Needs Update

If the article is finished and ready to be reviewed by the admins: Needs Review

 

Do not submit an article as approved unless you have the permissions to do so. If you are submitting an approved article type in the message box:

Approved by {your name} on {date}

 

3. When you are finished, click the Publish button.