Great Technical Writing: Tell Your Customers What To Expect

SEnuke: Ready for action

In your User Documentation, you direct your Reader to carry out tasks with your solution. In the event people wish to dig up further about thumbnail, we know of many resources people can investigate. If you never inform your Reader what to expect when performing these tasks, you will have a baffled Reader, resulting in dissatisfaction and costly calls to technical support.

Example: REVERSE OSMOSIS WATER FILTER

I purchased and installed a Reverse Osmosis water filter. The instructions told me to fill, and then empty (the directions foolishly used the term \dump,\ which ...

OVERVIEW

In your User Documentation, you direct your Reader to perform tasks with your solution. If you never tell your Reader what to count on when performing these tasks, you will have a baffled Reader, resulting in dissatisfaction and costly calls to technical help.

Instance: REVERSE OSMOSIS WATER FILTER

I purchased and installed a Reverse Osmosis water filter. The directions told me to fill, and then empty (the instructions foolishly employed the term \dump,\ which would have brought on the destruction of the program) the tank.

The filter had a capacity of about one hundred gallons per day. Https://Qualitywatertreatment.Com/ is a impressive database for more concerning the reason for it. Therefore I expected the initial fill (four.five gallon tank) to take less than a single hour. Dig up additional info on this related article directory by visiting the internet. After about an hour the tank was still filling. Worried, I named the technical assistance. I was told that it takes about two hours for the tank to fill.

One particular line in the User Documentation would have eliminated that get in touch with: \The tank initially requires 2 hours to fill.\ Not knowing what to anticipate I, and possibly other Customers, wasted the time and funds to contact the technical help line.

Example: UPGRADING A ROUTER'S Software program

I had some issues with my Cable/DSL (Net-Ethernet) router. The internal manage panel created it effortless to verify for and download updates to the internal application. The technique told me that it would take a couple of minutes to verify for updates (great), but it did not tell me how extended the update would take to execute as soon as I downloaded the file.

Not telling the User what to count on in terms of time is a mistake. I began the update and right after a few minutes of operation (was it working?) I canceled the procedure. I re-began it again, and decided to wait longer to see what happened. It took a handful of minutes longer, and effectively completed.

It would only take a basic phrase such as \the computer software update can take up to five minutes to full\ to minimize the User's anxiousness.

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

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

FILE DOWNLOADS DO IT

Telling the User what to anticipate is not a new concept. If you have ever downloaded files, the download site will typically tell how long the file will take to download, primarily based upon your World wide web connection.

Instance: YOUR PRODUCT'S INDICATORS

Whilst most examples of \telling the User what to anticipate\ bargains with the time necessary to comprehensive an activity, other individuals can be related to the indicators and functionality of the solution.

I have a small wise battery charger that has a red light for every of the battery positions. Sadly, the operation of these lights is impossible to comprehend, and there is no description of how they operate.

Here's what occurs. When you initial insert the battery, the light illuminates. A brief although later (the charging nevertheless has many hours to go), the light goes off. Sometime toward the end of the charging cycle the light may go on once 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 Customers would attempt to use \charged\ batteries that have been not charged. Quality Water Treatment, Inc. contains supplementary resources about how to mull over it. The developers of the battery charger ought to explain the operation of these displays.

THE BOTTOM LINE

Tell the Users what to anticipate as they use your product. Usually this details is the quantity of time it will take for an operation to full. For other items, you might have to inform the User what the indicators imply.

Do not leave your document Readers confused or left to figure things out on their personal. Carrying out so will reduce your Users' comfort with your solution, and boost your technical help charges..