backyard room additions easy house additions home addition with basement third lake home addition construction buffalo grove md kitchen and bath buffalo grove .. Chicago Drug testing

The Value of Adding Images to Technical Documentation

It's clich?, but true-a picture does paint a thousand words. This is an important message to remember when writing any sort of user documentation, such as an installation guide or an instruction manual. A document that makes judicious use of images and diagrams will be much easier to understand than one that is composed entirely of text descriptions.

I observed this first-hand years ago, when a junior programmer at one company was asked to update the software installation manual for their machine controllers. One of the first things he did was to strip away all the screen capture images, reducing the entire document to plain text. "These images are just silly!" he said. "They take up space, and they're just not necessary. I trust that anyone who reads this document will be smart enough to figure it out."

This turned out to be a huge mistake. The technicians who had to use the manual had a difficult time making sense of its instructions. They had to repeatedly ask for clarification, and one of them told me that the pure text descriptions were just too cumbersome to follow. They were fearful of using these instructions at all, knowing that a single misstep could lock the controllers into an irrecoverable state. It was a ugly situation all around.

The problem was that this programmer didn't try to make things easy for the users. For one thing, he failed to consider that some technicians were not native English speakers, and that they might struggle with the wording. More importantly though, this programmer expected too much from his audience. He wanted to reduce these instructions to their bare essentials, thinking that would be adequate. He failed to consider that even an intelligent, otherwise careful reader might be tempted to jump over instructions, or would gloss over some critical detail. This is a common pitfall when time is short, and when the users are confronted with pages and pages of bland text.

A few carefully chosen images, with suitable captions, can go a long way toward preventing that. When I saw that the junior programmer was stripping away all the screen capture images, I cautioned him against that. "These images may not be strictly necessary," I said, "but they help clarify a lot of details. For one thing, they show the user exactly which button to push, or which window to select. This makes the instructions much easier to understand, and reduces the likelihood of a human error." To this day, I wish that he had heeded my warning.

Were the users intelligent enough to understand the manual, as he claimed? Certainly-but intelligence is no guarantee against human error. Could the images have been construed as talking down to the user? Perhaps-but in my experience, sophisticated users seldom respond that way. Rather, most of them seem to understand the value that these images bring to the table. Perhaps it's because most of them know what it's like to be frazzled and pressed for time, and how easily important details can be lost in the text.

So remember-a picture paints a thousand words, and a single screen capture can be worth more than a dozen pages of text. It's a lesson that's worth learning.

V. Berba Velasco has a doctorate in Electrical Engineering and has been practicing his trade for nearly a decade. During that time, he has repeatedly found that good technical writing skills are almost as critical as good engineering skills. Dr. Velasco currently works as a senior electrical and software engineer for Cellular Technology Limited (http://www.immunospot.com), a biotech company in Cleveland, Ohio.

In The News:

Revising Your Manuscript: Fourteen Questions to Ask Yourself

1) Can you summarize the story in about a sentence... Read More

Creative Writing Tips - Does The Name You Chose Suit Your Character?

How do you choose a name? Do you put down... Read More

How to Write Headlines for How-to Articles

Want to write a how-to article but can't come up... Read More

Do You Know What A Plot Is?

Creative Writing Tips ?What a plot is and what a... Read More

Writing For Free: When & When Not to Do It!

Right off the bat, I want to say that there... Read More

Why Book Writers Need A Running Mate

By far, I have found that the lack of discipline... Read More

What Is The Single Worst Writing Mistake?

The following answer sounds simplistic?but think about it. The single... Read More

Leveraging Your Writing

A frequent conversation I have with my writing clients is... Read More

A Plan

All writers should use a plan whether written or reflected.... Read More

Balance Your Life

Balance your life ... Read More

Pairs/Groups Of Words Often Confused - Part 4 of 6

LATER, LATTERLater means afterwards; latter is the second of two... Read More

First Priority

No matter what you are writing, the first priority is... Read More

Autobiography: Installment No.3

ESSAY 3Writing an autobiography involves a matching up of a... Read More

Top 5 Rules of English Grammar

Communication is effective when we follow certain rules. These rules... Read More

How To Filter Description Through Your Characters

How do you describe a scene without slowing down the... Read More

How To Write for the Web

The Scanning ReaderWriting for the Web is different than writing... Read More

Ten Quick Tips for Inexperienced Writers

One of the biggest problems that inexperienced writers have is... Read More

Should You Write a Book?

One morning, you open your inbox and find several e-mails... Read More

Beginners Blues: How to Collect Samples, Testimonials, and References as a Freelancer

Beginner's Blues: How to Collect Samples, Testimonials, and References as... Read More

Benjamin Franklin: His Ageless Writing Tips

If Ben Franklin were alive today, he would be...uh, very... Read More

Gaining Writing Experience

GAINING WRITING EXPERIENCE Some Catch-22, huh? In... Read More

Write SMART: How to Create Terrific Writing Goals - And Achieve Them!

Open up your favorite calendar and circle today's date.Why? Because... Read More

Bird by Bird

It's easy to feel overwhelmed by marketing. First, there's so... Read More

Learn to Talk on Paper: The Art of Effective Business Writing

Rudolf Flesch, a specialist in writing skills, ran classes... Read More

Writing Made Them Rich #5: Peter Mayle

Peter Mayle was born in England in 1939.His fascination with... Read More

induction street high bay led lighting fixtures Pete's produce ..
induction street high bay led lighting fixtures Pete's produce ..