Writing technical manuals

Here are 10 suggestions for writing technical manuals:

1. Organize logically (e.g. by user tasks rather than by machine functions)

2. Write numbered step-by-step instructions in the "active" narrative voice and use direct statements

3. Minimize cross-references

4. Repeat important and/or complex procedures

5. Show users, don't tell them. Keep descriptive text to a minimum

6. Use illustrations liberally

7. Help your readers by using serif fonts for the body text and generous white space

8. Add guideposts to aid readability table of contents, introduction, index and tabs

9. Break the tension with a little light humor

10. Seek feedback by providing rough drafts to a few typical users