GA/Tutorials

TUTORIAL ON WRITING TUTORIALS

Introduction
A tutorial is a series of steps that describes how to do something. It should be arranged in a logical way, taking the reader from the start of a procedure to the end. Each step should be written simply and clearly. What follows are suggestions on how to plan and write a tutorial.

The Plan
Before your actually write a tutorial you need a plan. A plan lists the order of steps you are going to present.

List the steps, from beginning to end, where each step leads to the next. This list forms the structure for the paragraphs or points your are going to write about.

Your steps should work like a cookbook. Here is an example for boiling water:

1) Fill a pot with water

2) Turn the stove to HIGH

3) Put the pot on the stove

4) The water is boiling when it begins to bubble and give off steam.

http://www.iamtonyang.com/0411/boiling_water.jpg

Make sure you give all the information the reader needs to boil the water. Where does the water come from? The pot? If these things are not obvious they will have to be explained. If you need to use a word that your reader may not understand, explain it. Include all of these things in your list.

Now your list is complete you can start to write!

Writing
Use short, simple sentences. Include only what the average reader needs. Readers can get bored or confused by excess words.

Write short, concise paragraphs. Big paragraphs can make a reader feel the subject is too hard to understand.

Use lots of white space. Little paragraphs and spaces make information easier to absorbs. It's easier on the eyes too.

Follow your list of steps. Include the information the reader needs to go from one step to the next.

Include examples and figures or graphics where possible. Examples can clarify steps that might otherwise need a lot of words and paragraphs to explain. Graphics will save on a lot words.

When you have finished your tutorial, take a break from it. Then later review your work. A fresh look will often reveal errors. Check also to see if there are simpler ways to say what you mean.

Have other people look at your work. The may see things you have missed or suggest ways of improving your tutorial. Finally, get someone to try out your tutorial to see if it works.

Good luck!

Conclusion
Plan well and write simply. Include all the information your reader needs. Your reader does not know the steps the way you do. So, be friendly and help them understand your tutorial the best you can!