Print This Article Post Comment Add To Favorites Email to Friends Ezine Ready

Great Technical Writing: Tell Your Users What To Expect

By: Home | Writing-and-Speaking


OVERVIEW

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.

EXAMPLE: REVERSE OSMOSIS WATER FILTER

I bought and installed a Reverse Osmosis water filter. The instructions told me to fill, and then empty (the instructions foolishly used the term "dump," which would have caused the destruction of the system) the tank.

The filter had a capacity of about 100 gallons per day. Thus I expected the initial fill (4.5 gallon tank) to take less than one hour. After about an hour the tank was still filling. Worried, I called the technical support. I was told that it takes about two hours for the tank to fill.

One line in the User Documentation would have eliminated that call: "The tank initially takes 2 hours to fill." Not knowing what to expect I, and perhaps other Users, wasted the time and money to call the technical support line.

EXAMPLE: UPGRADING A ROUTER'S SOFTWARE

I had some problems with my Cable/DSL (Internet-Ethernet) router. The internal control panel made it easy to check for and download updates to the internal software. The system told me that it would take a few minutes to check for updates (good), but it did not tell me how long the update would take to perform once I downloaded the file.

Not telling the User what to expect in terms of time is a mistake. I started the update and after a few minutes of operation (was it working?) I canceled the process. I re-started it again, and decided to wait longer to see what happened. It took a few minutes longer, and successfully completed.

It would only take a simple phrase such as "the software update can take up to five minutes to complete" to reduce the User's anxiety.

PROGRESS INDICATORS (as displayed in a windowing environment) are often useless. Some go beyond 100%, others are logarithmic: they move quickly in the early processing and wait, seemingly at the end, for a long time while processing is completing. Consider making progress indicators relate to the time of operation, not number of files.

Some progress/activity indicators have nothing to do with the program they are associated with. I have used virus checkers that have abnormally terminated, yet the activity indicator kept on moving. Make sure that progress/activity indicators do reflect activity of the associated program.

FILE DOWNLOADS DO IT

Telling the User what to expect is not a new concept. If you have ever downloaded files, the download site will often tell how long the file will take to download, based upon your Internet connection.

EXAMPLE: YOUR PRODUCT'S INDICATORS

While most examples of "telling the User what to expect" deals with the time needed to complete an activity, others can be related to the indicators and performance of the product.

I have a small smart battery charger that has a red light for each of the battery positions. Unfortunately, the operation of these lights is impossible to understand, and there is no description of how they work.

Here's what happens. When you first insert the battery, the light illuminates. A short while later (the charging still has many hours to go), the light goes off. Sometime toward the end of the charging cycle the light may go on again.

This is clearly confusing to the User. The User's expectation is that when the light goes out, the charging is completed. This would result in a lot of User frustration, as Users would try to use "charged" batteries that were not charged. The developers of the battery charger should explain the operation of these displays.

THE BOTTOM LINE

Tell the Users what to expect as they use your product. Often this information is the amount of time it will take for an operation to complete. For other products, you may have to tell the User what the indicators mean.

Don't leave your document Readers confused or left to figure things out on their own. Doing so will reduce your Users' comfort with your product, and increase your technical support costs.



Article Source: http://www.eArticlesOnline.com

About the Author:
Barry Millman, Ph.D., has a Bachelor of Science in Electrical Engineering and an M.Sc. and Ph.D. in Psychology. Visit: http://www.greatuserdocs.com/ for resources to help you create the User Documents that your Product needs and your Users deserve. Visit http://www.greatuserdocs.com/ReadingRoom.htm for more articles like this one.

Tags: , , , ,

Please Rate this Article

 

Not yet Rated

Click the XML Icon Above to Receive Writing-and-Speaking Articles Via RSS!

Recent Related Articles From Writing-and-Speaking

  • Reverse Osmosis Water Filters Considered The Best In Water Purification
    By: MIKE SELVON | Oct 31st 2007
    It is also helpful to have some additional information about what makes a reverse osmosis water filter unique. Read

  • Iyogi- Online Technical Support Services
    By: Addie Swadie | Jun 18th 2008
    Get help fast and maintain your privacy. Once you know how fast, easy and cheap it is to use remote technical support for live online help, you will never ever like to run after the traditional methods for getting your PC repaired. Read

  • Information On Technical Support
    By: Tarun Jaswani | Oct 28th 2008
    Technical support is often subdivided into tiers, or levels, in order to better serve a business or customer base. The number of levels a business uses to organize their technical support group is dependent on a business need, want, or desire as it revolves around their ability to sufficiently serve their customers or users ... Read

  • What You Need To Know About A Osmosis Water Filter?
    By: Rudy Silva | Aug 15th 2010
    Use a carbon water filter to get safe drinking water. Check this article to learn how to purify water using carbon. As population grows, water sources also become contaminated. The lowering supply of the earth’s potable water is an issue. The invention of osmosis water filter is a great help. Osmosis water filter is very ... Read

  • Why You Should Outsource Technical Support Services
    By: Viswanath V | Jun 16th 2008
    Enterprise technical support offers assistance for small to large businesses who are customers of enterprises. At CSS, we blend highly qualified professionals and top-of-the-line technology to deliver world-class knowledge-centric support experience to clients. Read

  • Technical Support Services
    By: Gandharva | Jun 27th 2008
    Whether it’s about troubleshooting PC errors or internet optimization or computer optimization or any other, the tech support is just a call away nowadays. The simplicity of these services has helped the technical support company to grow rapidly. Read

  • The Truth About Reverse Osmosis Water Purification Units
    By: John Sern | Dec 6th 2008
    Do you own or are thinking about buying a reverse osmosis water purification unit? If so there are some important things you need to know first. Read

  • 5 Ugly Lies About Reverse Osmosis Water Treatment Systems, Uncovered
    By: John Sern | Dec 6th 2008
    Are you excited about the idea of owning a reverse osmosis water treatment system? If so there are some important things you might want to know before taking out the wallet. Read

  • Reverse Osmosis Water Filters
    By: wsiarticles | Oct 1st 2009
    Reverse osmosis water filters are popular for home uses and desalination. But you should learn as much as you can to make sure reverse osmosis is the best choice for your needs. Read

  • Reverse Osmosis Water Purifier - A Health Way To Live With Ro Water Purifier
    By: michellalston | Jul 6th 2010
    I wanted to take a moment to write and let you know just how pleased and happy I am with the work of this Reverser Osmosis water treatment. According to one survey report, most of the countries are suffering with unhealthy ground water. Read


Copyright © 2005-2011 eArticlesOnline, LLC - All Rights Reserved
Terms of Service | Privacy Policy