Great Technical Writing: Don't Let Your Product's Features Become Expensive Flaws
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: "I'll call technical support." "I'll return this defective product."
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. How many technical support calls have been made because of a hold switch? How much stress was created by these "defective" products (even if the User did eventually figure out about the hold switch).
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: Recommend your product to others Cost your organization less (reduced product returns and fewer technical support calls) Will buy your products in the future
Source: Free Articles from ArticlesFactory.com
Related Tags: writing, let, features, your, products, great, flaws, technical, dont, become, expensive
Barry Millman, Ph.D., has a Bachelor of Science in Electrical Engineering (1966, Carnegie Institute of Technology) and a M.Sc. and Ph.D. in Psychology (Human Information Processing, University of Calgary). He has been a consultant for over 25 years, an instructor, course developer, and award-winning speaker. For the past seven years he has been researching and creating resources to help organizations create great User Documents. Visit: http://www.greatuserdocs.com/ for resources to help you create the content and access that your Users want and need.Visit http://www.greatuserdocs.com/ReadingRoom.htm for more articles like this one.
Your Article Search Directory : Find in ArticlesRecent articles in this category:
- 10 Mistakes to Avoid When Writing an Article
Here are 10 mistakes that writers tend to make when writing articles for newsletters or magazines. K - Invigorate Your Healthcare Writing With Words That Are Short, Sweet, And Full of Energy
There are certain kinds of phrasing and word choice, especially in official statements, that can soa - The Case For Customizing Content
You have to consider every angle when you are writing. There are lots of rules to follow and tips to - Writing Strategies For Creating Viral Content
For anybody involved in content marketing the need to develop writing strategies that will produce t - Three Key Ways a Writing Coach Can Improve Your College Admission Essay
In an article entitled "Writing The Essay: Sound Advice from an Expert", Parke Muth, Senior Assistan - Acquiring A Fantastic Proxy - Proxy List
A proxy or proxy server is applied for both effortless obtain to your certain useful resource like a - Turnkey Sites & Website Templates - A Comparison
I'm constantly finding emails soon after a person buys a offer of Site Desing templates. Some men an - Standard Manual For Laptop Or Computer Elements & Software
For many people today, computer system sections plus the innards of the computer system are anything - Different Kinds Of Cameras Can Be Used For Webcams
There are many physical components that make the technology of the PC camera webcam work. The import - What Can Pc Camera Webcam Bring To Us And How It Works?
The PC camera webcam can be used in a wide range of aspects. Such as personal "Big Brother" style di
Most viewed articles in this category:
- Don't Put Off Writing that Book!
If writing that book you've always had in mind tops your list of resolutions or regrets, hiring a wr - How To Write A Better Press Release
A press release is the most effective way to generate free publicity for your business or organizati - Writing on the Hoof
Finding inspiration when you are writing is often a haphazard affair. When you are physically ready - Focus On Nigeria
Focus on Nigeria Nigеria is a natural gas and oil rich country that is bordеrеd b - How to Write Great Dialogue in Your Book
Dialogue isn't so much read as it is heard by the reader. The eyes see the words on the page, the b - Women SUV Driver from www.thefrap.com
Why do so many women drive around in the oversized SUV's, the Tahoe, Excursion, Escalade - How To Write Good Articles
As a writer you may be ready to cash in on the need for web content. There is a lot of money that c - NEWS FLASH: Technical Communicator Saves World
I had a boss several years ago who was amused by my earnest and relentless preaching about the impor - Writers Resources
Writers use certain inherent talents to come up with their pieces of writing. However, they do need - Popular Articles
Articles are those that are available in plenty these days in the internet. The articles are written