An objective is what you want your guide to achieve.
Your guide’s objective should be simple and specific.
- Good: “How to create a facebook post”
- Poor: “Facebook posts”
Does the guide already exist? This will save you time:
- Search our website
- Search international XR websites (i.e. https://rebellion.earth/ )
- Check the App’s website (if you are providing a guide for an app)
If the how-to doesn’t exist, go to step 3.
If a how-to does exist, consider:
- Creating a how-to that just has a link to the existing resource, or
- Writing a new resource, go to Step 3.
Here are two ways you can work out the steps to acheive your objective:
- In a computer document
- With post-it notes
1. In a computer document
Tip: Avoid writing a number for each step that you might have to change. Either use a spreadsheet or use numbering in a document.
- Brainstorms steps
- Write each step on a seperate line
- Re-order as necessary
2. With post-it notes
Tip: Don’t write step numbers on post-it notes.
- Brainstorm steps
- Write each step on a seperate post-it note
- Re-order as necessary
If you want your post-it notes to have numbers:
- Count the number of steps above
- Write each number on a new post-it note
- Align the numbers above your steps
We want to reach those who want lots of information and those who only want to be reminded of key steps. We acheive this by grouping steps into “parent steps” and “child steps” or “sub-steps”.
a. Group the steps
Identify the main “parent” step.
For example:
1. Drive to the supermarket
2. Buy ingredients
3. Buy tea
4. Buy sugar or honey (optional)
5. …
The two “parent” steps are:
1. Drive to the supermarket
2. Buy ingredients
b. Create sub-steps
Move the “child” steps under the parent steps.
In a document, click tab on each line to create a sub-numbering item
With post-it notes, move the post-it notes below the main post-it note
For example:
1. Drive to the supermarket
2. Buy ingredients
a. Buy tea
b. Buy sugar or honey (optional)
3. …
c. Simplify wording
Parent steps should have as few words as possible. Hemmingway App may help.
The best how-to guides have a visual guide to help understand the written step.
i. Take a screen shot of the step
In Windows, press “PrtScn”
ii. Paste the image into an image editor
I.e. Windows: Paint, or Photoshop etc
iii. Highlight the button or area identified in the step with a red square
Use a 1px box with a red border and transparent fill.
iv. Save each step with a logical name
We recommend:
Resource-[Topic]-[How-to summary]-#.jpg
I.e. Resource-Facebook-How_to_post-1.jpg, Resource-Facebook-How_to_post-2a.jpg, Resource-Facebook-How_to_post-2b.jpg, Resource-Facebook-How_to_post-3.jpg
Pro-tip: If you are using Photoshop, save the .psd file so the file could be edited later if need be.
Before we publish your steps, we would like to review your guide in a google document.
1. Log in to Google or create a new account
2. Create a google document
3. Open your document
4. Give your document a title
5. Paste or write up your steps
6. Upload your photos
7. Spell-check your document
8. Create a share link
9. Copy your share link