- 1 What is a quick reference guide called?
- 2 What are QRGS?
- 3 What makes a good quick start guide?
- 4 What is a Quick Start Guide?
- 5 How long should a Quick Start Guide be?
- 6 How do I create a quick start in Word?
- 7 What’s a reference guide?
- 8 How do you create a user guide?
- 9 How do you format a guide?
- 10 How do you create a reference list?
What is a quick reference guide called?
Quick reference guides–affectionately known as “cheat sheets” –are a tool for the person who needs to know just enough to get a job done without having to read an entire manual or textbook. Even a person trained in a subject finds quick reference guides useful in jogging the memory.
What are QRGS?
The QRG ( or Quick Reference Guide ) is a strict 2 page format that shows a single process only, in graphical steps. This 2 page format keeps it brief and allows it to be printed using one piece of paper.
What makes a good quick start guide?
We’ve included them to provide absolute clarity, a principle that you should consider following in your quick start guide writing process.
- Identify the objective(s)
- Show don’t tell.
- Define the scenarios.
- Research the user.
- Assume a low level of understanding.
- Add headings and timings.
- Keep it simple, but descriptive.
What is a Quick Start Guide?
A quick start guide or quickstart guide (QSG) is in essence a shortened version of a manual, meant to make a buyer familiar with his or her product as soon as possible.
How long should a Quick Start Guide be?
The quick start guide could be a booklet of only 4 pages, or a folded card, or a plastic-coated sheet of paper. What really matters is that a quick start guide should not contain more than 1/10th of the information of the accompanying manual. Second, a quick start guide should mainly consist of illustrations.
How do I create a quick start in Word?
Quick Start Guide Writing Guidelines
- Use a simple page layout that includes a call to action.
- Use one page per major task.
- Number the mandatory tasks that need to be done in order.
- Use bold numbers that clearly stand out.
- Use user-friendly terminology.
- Avoid using different names for the same thing.
- Provide examples.
What’s a reference guide?
Think of a reference guide as an instruction manual for life’s tasks. Whether it’s an employee handbook or training manual, it’s there to provide useful information on the spot. It should answer questions and help solve problems. And your users are going to think it’s amazing.
How do you create a user guide?
Here are some guidelines to help make instructions easy on the user.
- Provide step-by-step sequences in the correct order.
- Follow the timing and sequencing of the actual operations.
- Provide visual stepping stones (e.g. Step 1, Step 2 etc.)
- Avoid lengthy paragraphs.
- Use everyday words and terms: avoid jargon.
How do you format a guide?
Things to remember when writing your ‘How to’ Guide
- write concise phrases (‘Select the option’, not ‘You should select the option’ or ‘The student should select the option’)
- write in plain English to make your content as understandable as possible.
- structure your steps in the order the user will need to complete them.
How do you create a reference list?
What to Include on a Reference List
- Include the reference’s full contact information. List their full name, title, and company in addition to their street address, phone, and email.
- Include your contact information.
- Add a title to the page.
- Be consistent with your formatting.
- Check for accuracy.