RSS 
Email 
Twitter
iTunes
(Users Read Help Manuals Like an Encyclopedia, Not a Novel
September 19th, 2008 | Posted in Technical Writing |
On Linkedin, I’ve been reading an excellent thread of answers to the question, “Do you read user manuals?” Of the 50 people who answered, the resounding response is No, I don’t read the manual. I try to figure out the application on my own. I only turn to the manual when I get stuck and can’t figure out a feature. Or I turn to the manual when I want to learn more advanced functions.
One of the responders, Robert Poulk, put it best when he compared manuals to encyclopedias:
You’re asking a variant of the question “Do you read the Encyclopedia?” The answer is, of course, yes, but only the parts that matter.
I think if you go over the other answers you’ll see that’s really what everyone is saying — “Yes, but only the parts that apply to whatever I don’t understand at the moment.”
A good user’s manual useful it not only contains good information about everything a user may come across as the product is used but also, and more important, a means to locate the information easily, meaning randomly.
IMHO people need to stop being embarassed about not reading the whole thing. Nobody does, and nobody should.There’s no need to read the whole encyclopedia in order to learn where the Ganges River is.
In other words, users turn to the help to look for a specific question, just as someone consults an encyclopedia for a specific question. No one reads the entire encyclopedia/manual, nor is anyone expected to. Well-written encyclopedias allow users to find information through indexes, tables of contents, alphabetical organization, and search fields.
Reading these responses, it made me wonder I should adjust the approach to my help’s home page. Usually, my help’s home page provides an introductory overview of the application. Most of the time, users are already familiar with the application, so this introduction is really just filler material.
What should really be on the help’s home page? The top ten most common questions users have about the application. The first page users see should try to anticipate answers to the obstacles they encounter. A search box should also be readily visible.
In a previous post (“How Much Should You Document?”), I explored the question of whether we document too much, whether the resounding thud of a thick manual is a turnoff to readers. Reading this LinkedIn thread reinforces the idea that users need all the advanced nitty gritty detail that help provides. In simplifying the help, we may leave out the answer to the complicated question the user is trying to answer. A comprehensive online help file, or a three-inch thick manual, is all right if the user can navigate it via indexes, tables of contents, keyword searches, or other means to quickly find the answer he or she is looking for.
Related Posts
- User Paradox with Not Reading User Manuals
- Changing the Rules of the Game for the Benefit of the User
- Creating Passionate Users Explains How to Make the Best User Manual Ever
- FLOSSmanuals.net: A New Wiki Help Authoring/Publishing Tool Hybrid
- IT Author Podcast — Two Podcasts on Flare, One on the Making of a Technical Writer, and a Dogcast on User Psychology
Tags: encyclopedias, manuals, reading habits, user behavior
September 26th, 2008 at 12:00 pm
This is a great discussion and a constant source of tension between myself and my clients. Thanks for the insight!
September 27th, 2008 at 1:13 am
[...] “Users turn to the help to look for a specific question, just as someone consults an encyclopedia for a specific question.” (From Tom Johnson, in his post Users Read Help Manuals Like an Encyclopedia, Not a Novel.) [...]
September 30th, 2008 at 3:41 pm
My original post on LinkedIn:
“I always look at the product manual to see how well it was written and how it was designed. When making a major purchase, I usually go to the company’s web site to see if the manual is available as a download before I make the purchase. My opinion is that a well-written manual equates to a well built and supported product. I save manuals in a file for future use for what to do and what not to do when writing a user manual. Learn from the good and avoid what does not work.”
But then I got to thinking about how product design plays an important role in the need, or lack of need, for documentation. A poorly designed product with difficult to understand functionality would require more detailed documentation before the user is competent with the product, while a well designed product would allow for the user to learn by using (or, at least we should be able to assume).
So, my answer would have to be based on the extent to which the product was designed with the user in mind.
Ron
http://www.YourWritingDept.com
September 30th, 2008 at 11:16 pm
[...] More on this at the I’d Rather Be Writing Technical Communication Blog [...]