complete remodeling services harvard tri state remodeling additions to double wide homes remodel green oaks split level home kitchen remodel .. 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:

Proof Positive: the importance of proofreading

Last week I was having a quick browse on eBay... Read More

Top Ten Tips (Part 2)

Golden Rules For New Writers - Things you need to... Read More

The Myths of Writing: Have You Bought Into These?

There is an image most people carry of the artist... Read More

Writing Made Them Rich #2: Charles Dickens

Charles Dickens was born in Portsea, England, in1812. His father... Read More

The Spectre Hound

And a dreadful thing from the cliff did spring, and... Read More

Its All About YOU!

The Hottest Word on the WebDid you know marketing people... Read More

Amazing Ways Writing Articles Can Improve Your Business

How to get a lot of traffic to your website... Read More

What Is The Single Worst Writing Mistake?

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

Be Your Own Literary Agent and Get Published

So you're one of 20 million Americans who want to... Read More

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

PASSED, PASTPassed is the past tense of pass. Past means... Read More

Friendly Critiques

When a writer is working on their next literary masterpiece... Read More

The Magic of Layout in Your Story

"The Magic of Layout..."???Okay... "magic" might seem a bit over... Read More

Idea-Mining for Writers, 102

As many authors are fond of stating, "Ideas are all... Read More

Why Book Writers Need A Running Mate

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

What Nationally Published Columnist, Cindy Laferle Has To Say About Writing & Journalism

Today Norm Goldman, Editor of sketchandtravel and bookpleasures is honored... Read More

Keep your Book Dream Alive

Is your book nearly finished, finished, published, or even in... Read More

Conflict - How To Keep Your Readers Turning Pages

Some writers are just too kind.They hate to put their... Read More

Write Your Way To A Better Brain

Boost Brain Power Through WritingHave you ever noticed what happens... Read More

How To Write Cover Letters That Work

Sometimes there is confusion about the exact meaning of the... Read More

Writing as a Gift

What am I supposed to give Anthony as a wedding... Read More

Essay Types and Modes Youll Need to Write for College

~TYPES~You Want Us to Write What? Understanding the Task AssignedWhich... Read More

How Long is a Chapter?

How long should your chapters be?I can't resist... I have... Read More

Writing Query Letters

A QUERY LETTER is written to an editor or agent... Read More

Greatness

[When I was a nineteen-year-old high school student and budding... Read More

Need a Book Coach, Ghost Writer, or Editor? Part 2

If you either want to write a book to help... Read More

retrofit led street lights led wallpacks Pete's produce ..
retrofit led street lights led wallpacks Pete's produce ..