Should you document multiple products in the one user manual? Or does it just confuse users?
This question was prompted by a blog post I read recently (I like R-ing the F-ing Manual: http://www.merebagatelle.com/index.php/2010/04/wtfm/). The author stated that he hates manuals that try to cover all product lines in the one document — he finds them confusing and of no use when he is looking for specifics about the model he’s purchased. And he’s frustrated by the endless safety warnings and the input that lawyers have on these.
Normally, I wouldn’t have responded to his plea for a manual that just covers a single product. However, only two weeks ago I purchased a Sunbeam electric blanket for our new bed. And reading those instructions was frustrating and confusing!
Why? Because they covered general safety precautions (2 full pages + a loose leaf page), then SEVEN different types of blanket and 24 different models — all in a 20 page booklet. You can view a PDF of this manual here: http://www.sunbeam.com.au/PDFDownloadHandler.ashx?id=11047
In addition, there were sections that were general to all types and models. These were before AND after the specific model information. Some of the specific model information was common to all models, yet wasn’t in one of these general sections. For example, every model included the same subsection wording for SleepPerfect Technology and Cosy feet heating — this could have gone in with the general information about all models. Every model had a similar subsection for Detachable controls and Dual controls (there were some minor variations in wording for some of these).
Even my cursory analysis of this content highlighted several areas of repetition. A full analysis would no doubt highlight more. The information for the specific models may have been better placed in a table or matrix of features, with supporting notes — if required. That would have saved on paper and would have made reading this manual much less confusing. Instructions for fitting and using the blanket would have been clearer with numbered steps.
With today’s authoring tools that allow for all sorts of single-sourcing, the use of variables, variants and the like, there’s no reason (except printing costs) why there should haven’t been a different manual for each type of electric blanket, even if there wasn’t a separate one for each model.
Alternatively, if printing costs are so prohibitive, then spending a little more time and money on information/content analysis could pay for itself in reduced printing costs (replace nine specific model pages with a feature table/matrix on a single page), better readability, better usability and better comprehension.
BTW, many technical writers/communicators and/or content strategists can do information/content analysis of your existing documentation. You might even have one on staff…
See also:
[Links last checked April 2010]