|
Home / Writing
Great Technical Writing: Don't Let Your Product's Features Become Expensive Flaws
By:Barry Millman
Overview
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 Maker
I 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 in the User Manual, or on the box, or any package insert that described this object.
I went back to where the coffee maker was bought, 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 Backlight
My 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 Switch
Most 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 Documentation
Great 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
Digg
del.icio.us
Blink
Stumble
Spurl
Reddit
Netscape
Furl
Article keywords: writing, user, documents, manual, instruction, guide, technical
Article Source: http://www.articles2k.com
Barry Millman, Ph.D., 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: www.greatuserdocs.com for resources to help you create the content and access that your Users want and need.
|
|
| Top Writing Articles |
|
|
- 2). It’s Good To Be A New Writer: Breaking The Myth That Experience Is Everything By : Shelley Wake
There’s a rumor out there in the publishing world that an editor won’t even look at the work of a new writer. It might be true for certain types of writing, but after interviewing hundreds of editors, I’ve found that most are more open to new writers than you might think.
And there are a few major benefits to being a new writer too. So before you spend too much time trying to work out how you can appear to be a published professional writer when you’re not, consider taking advantage of your current position as a newcomer.
|
- 3). Penguin Publisher Reveals What It Really Takes To Get Published. By : Sharif Khan
Mr. David Davidar began his career in journalism and is founder of Penguin Books India. Currently, he is Publisher of Penguin Canada and also is author of the novel, The House of Blue Mangoes.
How did you first get started in the publishing business?
Twenty years ago I was working in Bombay and there was a colleague I knew who had done a publishing course at Harvard.
|
- 4). A Few Magazine Publishing Terms By : Scott Lindsay
The business of writing for magazines is often speculative in nature. It can often seem fruitless to conduct research on available paying magazines, attempt to understand their style and unique requirements, write the article, send the article, and then wait for what can seem a never ending response.
It can be even more daunting when you have invested significant time and energy and have received multiple rejection slips.
|
- 5). The Psychology Of Effortless Writing By : Saleem Rana
Through writing I can convey my entire experience so that someone else can benefit from it and learn from that experience without having had to be there. So, by writing I can give others much more than I can in person. In addition, writing bends time and I can convey my experience to someone centuries away.
|
- 6). Tricky Decisions By : Kael
Some people know exactly what to look for at the bookstore – others spend hours without finding what they have in mind…
Did you ever mistake the body lotion tube for the toothpaste a sleepy morning? No? Good, it’s not the best way to start the day.
This might be an awkward approach if you're aiming at the problem of choosing literature, but frankly, haven’t you too picked the ‘wrong’ book by a random grab at the bookshop or at the library? The book you put away with a sigh after three chapters.
|
|
|
- 8). Ebook Design (HTML) By : Shelley Lowery
When designing an HTML compiled ebook, you must create an HTML document (web page) for each page within your ebook. These pages should include
|
|
|
- 10). A Blank Paper By : William Ramos
A BLANK PAPER…is what I came up with after racking my brain to sweet talk you, sweep you off your feet; but as I crown myse
|
| New Writing Articles |
|
|
- 2). Seven Ways To Sabotage Your Self Publishing Success By : Sanyika Calloway-Boyce
Are you sabotaging your success as an author? Would you like to know how not to waste time and money? Seven Ways To Sabotage Your Self Publishing Success reveals the secrets that you need to know and avoid so you can write, publish and promote your book to self publishing success!
|
|
|
- 4). How to Proofread Like a Professional By : Jaya Schillinger
Copyright 2006 Jaya Schillinger
Even as I wrote the title for this article, I got confused. Is "proofread" one word or two? I thought it was two, and my spell checker didn't have a problem with that, but when I double-checked myself with a popular on- line dictionary, I was able to catch my mistake. Proofread is in fact one word, "proof·read v. tr.
|
- 5). Benefit We Gain from Problem Solving By : Carol Miller
The real fact on this Earth is that no human being has ever lived without problems a single day. This is impossible. People deal wit problems every day and problems do not fade away by themselves, they stay until the person resolves them. When a person gets strong enough to overcome stress and get to the core of things, then the amount of problems lessens.
|
- 6). Self Publishing, A Miracle Of The 21st Century. By : Josephine Stungger
Are you a writer with lots of talent but no one will give you the time of day let alone a contract? Would you pay a professional publisher to make your book but can't afford it? Do you need a better tool than your plain old word processor to make your work look more professional and desirable? Do you possess special knowledge that if packaged in a book.
|
- 7). Storylines Crop Up at the Oddest Moments By : chicho
There I was on a restful weekend by the sea; enjoying coffee and croissant in a quaint little café at the end of the North Shore pier.
Looking outside through a musty rain smattered window my gaze was attracted to the contours of the magnificent edifice that is Blackpool Tower; drinking in the lines of the intricate steel framework that leads to the observation deck, to the twin platforms one above the other, and all the way up to the crow’s nest.
|
- 8). Choose Great Research Topics By : Denton Krypps
Doing research and writing research papers does not actually have to be as horrible as everyone makes it out to be. I have learned to enjoy the process of research from start to finish. Call me crazy if you will, but I guarentee that the future of your educational career can be much more enjoyable if you learn now to enjoy research. For me, enjoying it started with choosing the right research topics.
|
- 9). The Perils And Pitfalls Of Publishing: Who Can An Author Trust? By : Dee Power And Brian Hill
One out of every eight people call themselves a writer, which means there are roughly 24 million people in the United States who carry that banner. Unfortunately there are charlatans and scam artists just waiting to ambush the unsuspecting author. How can a novice writer protect themselves?
Anyone can call themselves a publisher. Always remember money flows towards the author from the publisher, not the other way round.
|
- 10). Jokes and Riddles - How To Write Them By : Steve Gillman
Just listening to or reading jokes and riddles may "wake up" your brain, but it is creating them that really exercises your brainpower. The process requires you to use both logical and lateral thinking skills. How do you do it, then?
Jokes and riddle don't come to mind randomly. In fact, after watching how many comedians create their routines, I am convinced that they use what I call "humor algorithms," even if they do so unconsciously.
|
|
|
