David S. How to Write A Manual

What the (explicit)! These are the words that came out of my mouth (well, maybe a little more) last week when I was trying to setup my new "easy to install" printer. I'm sure these words have also come out of your mouth many times when trying to read a poorly written manual. Wouldn't it be nice if the manufacturer of your newly purchased item only cared as much about your manual as they do their profits! Well, if your profession ever ends up being the writer responsible for these beloved manuals, here are a few tips.

1. Be familiar with the process you will be describing.
If you have never done the process before, it is best to practice it before writing about it. If it is not possible to practice it, then at least take the time to read up on it. It may be best to have an expert in the field to review your writing before finalizing it.
2. Start before the first step.
If supplies are needed, list them in order of use and the quantity needed. If the supplies are included, name each piece to avoid confusion and list what steps the supplies are needed.
3. Review your steps
As the writer, you should go through each step as you write it so nothing is left out. If it isn't feasible to actually do the steps, think them through thoroughly.
4. Numbering the steps.
Number the steps, and leave space for additions between each step. Make sure that your steps are in logical order and written thoroughly.
5. Perform your written steps.
After writing your written instructions, do the things you wrote in your manual. As you come to places where your instructions are lacking, add in the necessary information. Repeat this step until you have all the steps written down correctly and can completely perform your written task without any problems.
6. Making Headers.
Once you have all the necessary steps detailed, go through your manual to find the obvious category heads. Mark these so your reader can easily find them. Title your category heads in bold type for ease of use.
7. Write a Table of Contents.
A table of contents makes it easy for your reader to quickly access a certain piece of information. The more detailed your manual is, the more categories and subcategories you will need.
8. Select a title for your manual!
At last, select a title that is best suited for your manual.
These steps that I have written are just the basics of manual writing. Writing a manual can be an intimidating task, but following the few fundamental guidelines I have given you on this page will make you one more step closer to being a better manual writer. Hopefully, by following these steps, you will make the manual easy to read so people that read your manual don’t have to swear, kick, pout, and throw a fit when trying to figure out your manual!

Sources: http://jnd.org/dn.mss/how_to_write_an_effective_manual.html