Writing a User Manual
1 Differences From Labs 1 Through 3
Lab 4 is a User Manual. The pseudo-informal nature of such a document lets you:
Ignore APA!!!Relax selected APA rules (based on class discussions)
- Use first, second, and third person.
- Use hype, use cute phrases, and be entertaining!!!
- Use multiple exclamation points!!!!!!!!
Treat the prose as if you are looking directly at someone who has just purchased your product. They have just invested in you. You are grateful (and helpful) as a result. The first section should tell them that.
Thank you for buying our product!
Your problems will no longer exist!
are acceptable. However, the phrase easy to use is still not allowed. That means the phrase
We have designed this exciting new software so that it is easy to use…
2 User Manual Specific Content
User manuals are filled with:
- Illustrations & screenshots
- Every User Interface (UI) screen should be included in the user manual.
- Exceptions are possible.
- Step-by-step instructions(e.g., Step 1).
- Directions for handling errors
- Trouble shooting guidelines
- No long paragraphs!
3 The Formal Stuff
Yes… formal stuff. While you have latitude to write in a more conversational style, we can not relax all the rules. You must still include:
- A Title and introduction (as a home page)
- A Table of Contents (e.g., a navigation panel or links)
- A Glossary of Terms
3.1 Consistent Formatting & Diction
Formatting must be consistent. This includes the standard fare:
- Font (i.e., typeface)
- Font size
- Emphasis (e.g., bold vs italics)
- Color use
If you are annotating figures, you must do so consistently. Consider a case where you need to enumerate elements in a figure (usually a screenshot).
- Do you use letters? Lowercase? Uppercase?
- How about Roman Numerals? Lowercase? Uppercase?
- How about numbers?
- How about colors?
- How about fonts?
It does not matter which method you choose. Just be consistent.