Your product's unexplained features can turn into costly flaws. This article describes three real-world products with just such "features." It presents ways you can prevent these feature-to-flaw conversions by improving the User Documentation for your products.
Examples
1. A Wand that Came with a Coffee MakerI got a fancy electric coffee maker. In the box was a strange, and unexplained, object. It looked like a white plastic spoon, but where the bowl of the spoon should be was a mesh bag with something inside it. It did not seem to be made to assemble into the coffee maker.
There was nothing that described this object in the User Manual, or on the box, or any package insert .
I went back to where the coffee maker was, and asked about this object. The shopkeeper phoned the company, and later got back to me. How much would we estimate the calls cost? Why did this time and money have to be spent?(The device was a water filter. The User is to stir it in the water before making the coffee...it's supposed to remove impurities.)
Solution: Attach a tag to the wand. On the tag, explain what the wand is, its benefits, how to use it, and (in a nod to marketing) where to purchase more.
2. MP3 Player BacklightMy MP3 player has a backlight that illuminates when you press any button on the player. It has a nice, battery-saving feature, also. When the battery level drops below a preset amount, the backlight on the player will no longer come on. Excellent design idea.
A new User plays the MP3 player for a few hours, the battery runs down, and the backlight no longer works.
Unfortunately, the battery-saving feature is not documented. Even if the User searched the documentation, this feature would not be found.
The User's point of view can be summed up by one question: "How come my backlight no longer works?"Followed by an action plan:
Are these action plans not expensive to the company?Solution: Mention this backlight behavior both as a feature (perhaps in the discussion about battery life) and also in the troubleshooting portion of the User Document.
3. Hold SwitchMost portable electronic devices have a "hold switch." This is a switch (or button combination) that locks the device so its controls cannot accidentally be activated. Feature.
It is quite possible that the hold switch can get accidentally moved to the "hold" position. Now none of the controls on the device work. The User, who may have never heard of the hold switch, is now faced with a "defective" product. Expensive Flaw.
Solution: Describe the Hold Switch both as a feature (where you discuss the controls on the device) and also in the troubleshooting portion of the User Document.
Great User DocumentationGreat User Documentation provides the information that your Users need, and the means to effectively access that information, finding what they need, and skipping over what they don't.
Great User Documentation creates Users who are effective and comfortable with your products. These Users:
Great Technical Writing: The User-Product Life Cycle - A Documentation Tool
The User-Product Life Cycle (U-PLC) is a powerful tool for the User Document writer. Use the U-PLC to generate the high-level topics for your User Document.
Great Technical Writing: Tell Your Users What to Expect
In your User Documentation, you direct your Reader to perform tasks with your product. If you don't tell your Reader what to expect when performing those tasks, you will have a baffled Reader, resulting in dissatisfaction and expensive calls to technical support.
New Technical Writer: Conquering the Fear of Writing
Stepping into the role of a technical writer can be daunting, especially for those without a writing background. The task of creating User Documentation for a new product might stir up fear and anxiety, reminiscent of school days filled with writer's block and critical evaluations. However, writing for a user manual is a unique process that differs significantly from academic writing. This article aims to guide new technical writers through the process, providing strategies to overcome anxieties and produce effective documentation. With the right approach and resources, anyone can craft clear and helpful user guides.
