Guide
Definition
As in a guidebook; something that offers basic information or instruction
wordnet.princeton.edu/perl/webwn
Purpose
- to instruct
- to provide simple information
- if it provides detailed information, the guide is known as a Reference Guide
http://ezinearticles.com/?Writing-A-User-Guide&id=908524
Intended audience
- depends on what the guide is about, e.g. A guide on energy and cost savings targets at compressed air users, compressed air systems operating and maintenance personnel etc.
Features
- icons might be included in margins to help audience identify relevant sections, e.g. “hints”, “key tasks”, “challenges”
- usually in bullet points
- language is simple and organized
- flow charts/simple illustrations might be included to assist understanding
Creating a good guide
In order to write a good guide, you should take note of the following:
- avoid jargon/advanced English words
- keep the whole thing simple yet professional
- include hands-on experience if applicable; include any models where necessary
- name the chapters of the guide
- include a contents page
- include any resources/further reading material
http://www.uscharterschools.org/governance/intro.doc
Example
Modern Guide to Fingerings for the Flute by James Pellerite
Link:http://www.amazon.com/Modern-Guide-Fingerings-Flute-Pellerite/dp/0882844490/ref=sr_1_23?ie=UTF8&s=musical-instruments&qid=1237900172&sr=8-23#
(you’ll have to click on the image of the book to look inside the book)
Why it is a good one:
- contents page includes names of chapters which makes it easy for users to flip to relevant pages, e.g. Basic Fingerings, Tremolos
- a key is explained after the introduction to make sure users will not be confused when they use the guide
- illustrations included for easy understanding
- language used is simple, easy to understand
- instructions are listed out in point form so that key points stand out, e.g. “1. The key fingerings…is invaluable” (p.7)
Comments (0)
You don't have permission to comment on this page.