Write Words
Write Words
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. Here are some writing guidelines to help you stop baffling your Reader.
SAME CONCEPT: SAME WORDS
User Documents are not meant to be entertaining. Do not try to be creative, especially by using synonyms for specific concepts in your product. When you talk about a topic use the exact same wording to describe (or name) the topic everywhere in your User Document.
For example, the "Same Concept: Same Words" guideline, says that if there is a control on your product called the "Activation Button," then everywhere you talk about that button use the term "Activation Button."
Don't be "creative" and use words like "Activation Control" or "Start Control" to refer to the "Activation Button." Using the different wordings forces your Reader to have to stop and think "Is this the same thing as 'Activation Button'?"
DIFFERENT CONCEPTS: DIFFERENT WORDS
I bought something on the Internet that had a rebate available for it. When I ordered the product, I was given a "Tracking Number" to monitor the progress of my order. This is common for orders from large companies.
When I applied for the rebate, the rebate company used the same word, "Tracking Number," but this time it meant "their rebate tracking number." When their website asked for "tracking number" I entered the only one that I knew, the product ordering tracking number. I was wrong; the rebate number was a totally different thing.
The Rebate number is different from the order tracking number and should have a very different name from the order tracking number.
One might argue that "the rebate company is a separate company, and must handle rebates for all sorts of sellers." Sure, but they can use a very specific name for their rebate tracking number. They can call it the "Rebate Identification Number." That name would not be used by any selling company to track an order. The problem is solved. No User would confuse "Tracking Number" with "Rebate Identification Number."
QUIZ
Given the information in the previous two sections of this Article, wouldn't it be really silly if the rebate company originally called it the "Rebate Identification Number" and then unannounced switched to calling it the "Rebate ID"? Answer: Yes, it would be very silly. The change forces the Reader to have to ask, "Is this the same thing as the 'Rebate Identification Number'?"
It's not that your Reader is too stupid or lazy to figure out what you mean. It's that your Reader has better things to do than to decipher your writing.
WORDS YOUR READER DOESN'T KNOW
Jargon is the shortcut language of any industry. Make sure that if you use jargon in your User Document, you explain what it means. If the writing project can afford the bit of time, I recommend that you include a glossary in your User Document. Define all the jargon, acronyms, and words that you might use in ways your Reader might not expect. A great example of the latter are "debit" and "credit." The common understanding of these words is exactly opposite to those in the accounting (banking) profession.
TIP: Be suspicious of any words your spelling checker identifies. Ask yourself two questions when your spelling checker identifies a misspelled word:
* Did I really spell that word incorrectly?
* If it's spelled correctly, am I certain that my Reader knows what the word (or acronym) means? If it's not in the spelling checker's dictionary it might not be in your Reader's vocabulary.
DON'T BE AMBIGUOUS
I have a notebook computer running MS Windows XP. If I am using the Media Player and I press the keys to hibernate the computer (put it into an energy-saving sleep state), something warns me that hibernating will lose my place in the video. It then asks: "Do you want to continue? Yes/No." Continue what?: Continue hibernating, or Continue watching the video? It would only take one or two more words to remove the ambiguity.
THE BOTTOM LINE
When you revise your writing, make sure that your Reader does not have to guess what a word might mean. If you mean the same thing as another concept, use the exact same name. If you mean something different, then use as different (unique) a name as you can. Define jargon, acronyms, and any unusually used words. Eliminate ambiguity.
Your reader is uncomfortable enough having to read your User Document, instead of using your product. Don't make things worse by using wording that makes your Reader have to work out its meaning.
About the Author:
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 Source: ArticlesBase.com - New Technical Writer: Don't Confuse your Reader With your Words
Food Words Part 6 of 6- Write the Word.
Compare............................................................................................
|
|
My Book of Writing Words $7.87 Builds on early reading skills to help children master the reading and writing of phrases that combine similar-sounding consonant and vowel combinations in a volume that offers tracing and pronunciation games involving such example phrases as "grab the... |
.........................................................................................................
 |
Words to Write By: Putting Your Thoughts on Paper List Price: $2.99  |
|
Writing is a learned skill, not something that you either can or cannot do. The distinction between people who seem to write easily and those who do not is more a matter of comfort, exposure, and just plain doing it... |
 |
100 Write-and-Learn Sight Word Practice Pages: Engaging Reproducible Activity Pages That Help Kids Recognize, Write, and Really LEARN the Top 100 High-Frequency Words That are Key to Reading Success List Price: $15.99 Sale Price: $9.26 |
|
Watch confidence soar as children master 100 sight words—the words most commonly encountered in any text. Children read more fluently, write with greater ease, and spell more accurately when they know these high-frequency words! These fun, ready-to-go practice pages let kids trace, copy, manipulate, cut and paste, and write each sight word on their own... |
 |
WORDS OF LOVE - How to Write a Romance Novel List Price: $4.99 |
|
WORDS OF LOVE…The damsel is rescued by our hero, they rush into each other’s arms, passion rules and love conquers all in Words of Love. Those three words can tie Romance Fiction up in a neat tidy bow... |
 |
Bernie Taupin: The One Who Writes the Words for Elton John: Complete Lyrics from 1968 to Goodbye, Yellow Brick Road Sale Price: $135.36 |
 |
Words You Should Know In High School: 1000 Essential Words To Build Vocabulary, Improve Standardized Test Scores, And Write Successful Papers List Price: $8.95 Sale Price: $5.00 |
|
Do you want to ace your SATs, write literate papers, and find the perfect language to impress would-be bosses at job interviews? Words You Should Know in High School will help you achieve the success you're looking for-one word at a time... |
 |
Have The Last Word - Write Your Own Obituary (And Learn to Live) List Price: $12.95 Sale Price: $8.21 |
|
Do you always want the last word? Write your own obituary and you can achieve that goal. While you're at it, why not write your own funeral? Want to be buried in a biodegradable clamshell? Turned into a blue diamond? Mr... |
 |
25 Read & Write Mini-Books That Teach Word Families List Price: $11.99 Sale Price: $6.69 |
|
Help children build essential reading skills with this collection of adorable mini-storybooks that give them practice reading and writing words from 25 different word families. Each book uses a few simple rhyming words to tell a lively and funny story... |
 |
How To Write Magical Words: A Writer's Companion List Price: $17.95 Sale Price: $11.83 |
|
"This is the best idea for a writing book that I've ever seen. It's like sitting in a room full of professional writers, and after each one delivers a riff on one aspect of writing, the others weigh in to buttress, amplify, refine, or add to what was said... |
 |
Words' Worth: Write Well and Prosper List Price: $14.95 Sale Price: $7.54 |
|
What makes an effective quote? How can I infuse my writing with style and voice? How can a sharp lead kick-start my story? What are the tricks to writing for the Web? What can I do to get an editor to listen to my idea? These topics and more are handled smartly, succinctly, and simply in the latest edition of Words' Worth, an invaluable toolkit for writers aspiring to perfect the craft of nonfiction writing... |
Compare............................................................................................
|
|
Microsoft Word 2.0 for Windows/Intro [VHS] $39.99 ... |
|
|
Microsoft Word 2.0 for Windows/Interm [VHS] $39.99 ... |
.........................................................................................................
Compare............................................................................................
|
|
Write Start: Words to Write $37.02 No Synopsis Available |
.........................................................................................................