iSnare.com - Free Content Articles Directory
Authors Contents [Advanced Search][Add OpenSearch][Job Search]
Distribute your articles to thousands of article sites for only $2 and below! Read more...

Index  Writing
 

Great Technical Writing: Make Your Product Fit

 
[ Contact the Author] [ Send to a Friend] [ Article Publisher] [Make PDF] [ Print] [ Bookmark & Share]
 
Read our Terms of Service before reprinting this article. The submitter specified above has claimed the rights to this article.
Barry Millman

OVERVIEW

Most product documentation sounds like their product is the only thing in the User's life. Such thinking results in User confusion and dissatisfaction. This article presents three real-life examples of this attitude, and what should be done to remedy these unfortunate situations. The article concludes with some techniques for the writer.

BACKGROUND

There are two important facts that User Documentation ignores:

1. Your product is a only minor item in your User's life

2. Your User Documentation must help fit your product into the User's life

User Documentation that is written with awareness of these facts results in a better user experience. Here are three examples of where the writers (always incorrectly) thought that their product was the only thing in the User's life.

EXAMPLE 1: Shoe Cleaner/Protector

Most people know about polishing and perhaps cleaning their leather shoes. This cleaner/protector product is meant to clean, protect and shine shoes. The instructions simply tell the User how to apply the product.

What the User is Used to: I polish my shoes with regular wax (or liquid) shoe polish.

The Problem: If a User wants to polish his/her shoes as well as use your cleaner/protector, then what order should the polish and the cleaner/protector be used? The instructions merely tell the User how to apply the cleaner/protector. It's like the cleaner/protector is the only shoe product in existence.

Possible Solutions: The the cleaner/protector instructions could say (as appropriate):

* Use the cleaner/protector instead of your normal shoe polish.

* Use the cleaner/protector after you polish the shoes with your regular shoe polish.

* For a deluxe shoe treatment, use the cleaner/protector first on the shoes. Wait a few minutes, then wipe off any excess with a clean cloth. Then polish the shoes using your regular shoe polish, in the usual way. Finally, use the cleaner/protector again, but do not wipe it off.

These would make for much more effective instructions, and they could easily fit on the package.

EXAMPLE 2: DVD Player didn't realize that I had a VCR

People buying a DVD player a few years ago were in the following situation. They had a VCR connected to the single video input of their TV. DVD players' instructions described how to connect the player to a TV using a video input. The instructions ignored the situation of how to connect the player if there already was a VCR connected to the TV 's only video input.

What the User is Used to: The VCR is connected to the only video input of my old television.

The Problem: My new DVD player needs to be connected to the TV's only video input. Do I have to buy a switch or manually switch the DVD player and VCR?

Solution: The writer should provide some tips or instructions how to set up the DVD player in the customer's real-life situation. These instructions may include how to connect the DVD video through the VCR. Or connecting the DVD to the TV's video input, and connecting the antenna of the VCR to the antenna input of the TV. Both devices can be connected with no need to buy additional parts. The instructions should mention how. It would improve the User's experience in setting up the new device. (The instructions should also mention that these methods of connecting the devices would yield a less than optimal picture.)

EXAMPLE 3: A 2 in 1 Shampoo and Conditioner Product

A User normally shampoos his/her hair and then may use a separate conditioner product. He/she just purchased your product, a 2 in 1 shampoo and conditioner. It has no instructions.

What the User is Used to: A shampoo is used on the hair and immediately rinsed. A conditioner gets left in the hair for a few minutes, then rinsed.

The Problem: Does this 2 in 1 product get left in the hair, or does it get rinsed out immediately?

The Solution: Provide correct instructions on the package. Or, if it does not matter how long the 2 in 1 product gets left in the hair, then say so. Don't leave the User guessing. If the User wanted to guess about something, then they would be reading a novel, not your User Documentation.

BOTTOM LINE: What to Do for Your Documentation

Examine your product in the light of how it will change the way that the User currently does things. How will it fit into the User's life? How does the product fit with other products your User employs?

Make sure that your User Documentation helps the User to effectively fit the product into his/her life. By ignoring the reality of your User's situation, you are forcing him/her to solve problems that you could easily solve. If you provide the solutions, then you will create a better product experience for your User.

Fitting the product into the User's life presents the writer with a duty and an opportunity:

* The duty to ease the User from what he/she previously did to the new product's situation

* The opportunity to explain your product by using the User's experience as a background.

Important NoticeDISCLAIMER: All information, content, and data in this article are sole opinions and/or findings of the individual user or organization that registered and submitted this article at Isnare.com without any fee. The article is strictly for educational or entertainment purposes only and should not be used in any way, implemented or applied without consultation from a professional. We at Isnare.com do not, in anyway, contribute or include our own findings, facts and opinions in any articles presented in this site. Publishing this article does not constitute Isnare.com's support or sponsorship for this article. Isnare.com is an article publishing service. Please read our Terms of Service for more information.

Barry Millman, Ph.D., has a Bachelor of Science in Electrical Engineering (1966, Carnegie Institute of Technology) and an 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 User Documents that your Product needs and your Users deserve. Visit http://www.greatuserdocs.com/ReadingRoom.htm for more articles like this one.
Article Tags: user [See Dictionary], product [See Dictionary], instructions [See Dictionary]
Got a question about this article? Ask the community!
Article published on February 22, 2007 at Isnare.com
 
Rate this article:

Great Technical Writing: The User-Product Life Cycle - A Documentation Tool
Submitted by: Barry Millman

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
Submitted by: Barry Millman

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...

New Technical Writer: Have No Fear Of Writing
Submitted by: Barry Millman

OVERVIEW You're a non-writer who has just been assigned to write the User Documentation for your company's new product...

How Poor In-house User Documents Cost You Twice & What To Do About It
Submitted by: Barry Millman

OVERVIEW Many organizations produce in-house tools or modify commercially-available tools for their own use...

Great Technical Writing: User Document Headings Should Be Guideposts, Not Advertisements
Submitted by: Barry Millman

OVERVIEW Most heading are designed to entice us to read further Headings in User Documents should enable your Reader to decide whether or not to continue reading that section...

Great Technical Writing: Improve Your Readers' Access With A Visual Index
Submitted by: Barry Millman

OVERVIEW People are visual creatures They look at your product, and see, for example, a button or display...

Benefits Of Creating User Documents In-House
Submitted by: Barry Millman

OVERVIEW For small companies, creating their product's User Documentation in-house, provides benefits to the company, to (idle) staff, and to the product...

New Technical Writer: Avoiding The Interview-writing Disconnect
Submitted by: Barry Millman

OVERVIEW Lost or garbled information is a terrible waste Especially if it's the information you gathered from an interview and must now write into your User Document...

New Technical Writer: Don't Confuse Your Reader With Your Words
Submitted by: Barry Millman

OVERVIEW Stop confusing your Reader with the words you use Your Reader is trying his/her best to understand how your product works without having to figure out your writing...

Great Technical Writing: Improve Document Searches
Submitted by: Barry Millman

OVERVIEW Searches in User Documents (manuals, etc) often fail because the Reader uses different words for a concept than the author uses...

New Technical Writer: Use The Persona To Create The Most Useful Section Of Your User Document
Submitted by: Barry Millman

OVERVIEW A good User Document includes sections on how to set up, use, and care for the product However, to create a great User Document , the technical writer should use the Persona, generated in the analysis of the User/Reader, to create the topics for the most useful section of the User Document...

New Technical Writer: The Four Dimensions Of Your User/reader
Submitted by: Barry Millman

OVERVIEW To create an effective User Document, the writer must know who he/she is writing for This article presents four dimensions (Skills, Attitude, Knowledge and Experience) for describing the User of your product (your Documentation Reader), and how to build a Persona that turns your generic User into an almost-real person...

New Technical Writer: First Things To Do On The Project
Submitted by: Barry Millman

OVERVIEW You, a non-writer, have just been assigned to write the documentation for a product your company produces or markets...

Great Technical Writing: Sell Your Readers On What's Important
Submitted by: Barry Millman

Overview Our humdrum, sterile headings and writing manner do little to encourage our Users to read parts of the product documentation that would be especially beneficial for them...

Great Technical Writing: The Two-edged Sword Of Reader Experience
Submitted by: Barry Millman

Overview When we write User Documents we rely on our Reader's/User's experience to simplify our work...

Qualities of a Well-Written Short Essay
Submitted by: Mary Simmers

Have you been on writing an essay Usually, an essay is based on the writer’s point of view...

Press Release Writing Tips
Submitted by: Jason Kay

Writing a press release for dissemination to various media sources can be a great way to gain exposure for your company, your website, or a new product that you are selling...

Writing an Essay For Your College Application
Submitted by: Mary Simmers

Students nowadays are not that serious in listening to their English courses Oftentimes, they feel bored about the subject...

Things to Do When You’re Revising
Submitted by: Mary Simmers

When writing, it’s always prudent to allow plenty of time for revision When you’re done writing with the piece you are aiming to have...

How to Write in an Organized Manner
Submitted by: Mary Simmers

Needless to say, sometimes a writer feels uneasy especially when he/she is sitting on the chair for almost 8 hours or more doing nothing but to write an article...

How to Edit Phrases and Sentences For Conciseness
Submitted by: Mary Simmers

For some reasons, many people like to write what their minds and feelings portray Especially those writers who are to write on their not just because they were told to write or that it is their duty or requirements to write...

How to Use Adjectives and Adverbs
Submitted by: Mary Simmers

As a writer, we must be knowledgeable enough to know and determine all the parts of speech The most common are the nouns and pronouns which we commonly use these two as our subject in a sentence...

Your Audience and the Level of Formality in Your Writing
Submitted by: Mary Simmers

If you are into writing, you should know the flow of your piece If you are writing news story, reports, thesis, reviews, presentations and speech then you should aim a formal and piece of work...

Why You Should Work Hard on Your Scientific Abstracts
Submitted by: Mary Simmers

Good science is only one half of a scientist’s work; the other half is about communicating those results to other people...

Word Interrogation: Why It’s an Inefficient Way to Edit Your Writing
Submitted by: Mary Simmers

There are a lot of important things that needs attention when someone is going to start writing a piece...

10 Tips For Copywriting Success
Submitted by: Enzo F. Cesario

While video and multimedia technologies are rapidly expanding, the Web remains a largely a text-oriented system...

Starting a Piece in the Thick of the Action
Submitted by: Mary Simmers

Some topics work best when presented in a formal manner, easing the reader into the subject by a subtle introduction and expanding as they go further...

Ebook - Writing Skill Tips
Submitted by: Roberto Sedycias

Having knowledge on many subjects and passing it on in some type of media, paper book or ebook, will certainly be beneficial to others, but this requires proper tact and skill of putting the words together...

How to Create Your Own “Dictionary “
Submitted by: Mary Simmers

I last talked in an article awhile ago about making your very own personalized “dictionary “ Now I am not talking about inventing new words, what I am talking about is having your very own word reference...

Article Spinning 101: The Basics
Submitted by: Mary Simmers

Article spinning is becoming a popular demand in the world of Internet Marketing nowadays Never heard about it...

Isnare.com Footer Divider

© 2004-2009. Isnare Free Articles - An Isnare Online Technologies Free Articles Project. All Rights Reserved.   Privacy Policy