User Manuals, everyone hates them but sadly some of us need them. Here are 7 useful tips for writing a user manual.
1) Anyone might be reading your user manual. Keep it simple enough for any average joe to follow.
2) Proper organization. For some user manuals step by step organization is best and for others an index and small chapters is best. You decide what is best for your manual.
3) Use footnotes to explain any vocabulary that might not be common knowledge.
4) Use pictures and or diagrams when needed, keep the images simple, easy to follow and easy to read to prevent confusion.
5) Use easy to read fonts and colors.
6) Make sure not to leave out any information such as codes, keys, and warning.
7) Have others read the user manual and give constructive criticism.
These simple tips will help you write a better user manual for anyone to use.
Subscribe to:
Post Comments (Atom)
I enjoyed reading this blog. It was quick and simple but straight to the point. It introduced what was going to be the subject and then listed the easy steps/tips in order to create a great user manual. I enjoyed reading it so much because I felt as if Robert was speaking to us directly and not just listing the steps. There wasn't any bland summaries within this blog.
ReplyDeleteNice tips and simply outlined. You need to cite your source and think about a graphic to get the reader's attention on this dry subject of manual writing...ha
ReplyDelete