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.

---

Screenwriting ? The Lone Wolf Story Structure Template

Story Structure Templates are the fastest way to write screenplays.... Read More

The Three Cs of Writing an Excellent all Purpose Headline

Since the headline is the first contact your readers have... Read More

Recommendation Letters Demystified

There is a lot of confusion about recommendation letters.Recommendation letters... Read More

Check Your English Grammar With This Easy Technique

As an International language, English has been used widely in... Read More

COULD YOU (not) REPEAT THAT PLEASE?

I recently read a book where everything was akimbo. Arms... Read More

Rules for Getting the Story Down

1. Write it fast, fix it later.2. Commit to writing... Read More

How to Write Articles, Reports, and Books Quickly

Do you have trouble getting your thoughts and ideas down... Read More

Home Business Writing Made Simple

Have you ever written a letter to a friend? Ever... Read More

Could Your Book Idea Be the Next Best Seller?

Everyone has a unique story to tell. From explaining business... Read More

Finish Your Book Already!

I owe the completion and success of my book to... Read More

Writers Helping Writers - A Noble Legacy

It is satisfying to be a part of such a... Read More

Writing Made Them Rich #4: Paulo Coelho

Paulo Coelho was born on August 24th 1947 in Rio... Read More

What Does It Take To Make Your Memories Into Publishable Memoirs?

Why should you consider creating a memoir of your personal... Read More

Taming The Book Proposal

Taming the Book Proposal: The BasicsOh, that most maddening of... Read More

Discover the Writer Hiding Inside You

Has the thought run across you mind that you might... Read More

Masquerading As Novel ~ Can Author?s Work Convey Important Perceptions?

While novels do not usually attempt to convey concepts about... Read More

How To Co-Publish For Profits!

The Benefits of Co-Publishing There are a number of publishers,... Read More

Creative Writing Tips - Have You Established Your Main Character At The Start?

In the beginning of your story you have to grab... Read More

The Spectre Hound

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

How to Build Your Site with Other Peoples Content -- Part 1

Building a new website can be extremely exciting. Seeing your... Read More

The Myths Of Writing: Have You Bought Into These?

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

Write For Yourself First

It would be very selfless or noble of me to... Read More

Balance Your Life

Balance your life ... Read More

Linguaphone Language Learning Solutions

Language Training - A key to Global CommunicationLanguage Training is... Read More

Writing the 8 WebCopy Headline Categories

My article this issue is an excerpt from a book... Read More

Open a Vein

If you want to be a writer, you must write... Read More

Childrens Stories - The Essentials

There is no specific formula for children's fiction. There are,... Read More

Publisher Ethics For Reprint-able Articles

Let's Discuss Publisher Ethics:If you are an ezine publisher or... Read More

Dont Rely on Your Spellchecker - or - The Importance of Good Proof Reading

Weather posting a page to your Website, writing a letter... Read More

When I Run Out of Ideas

I do on occasion run out of ideas for my... Read More

Be Your Own Literary Agent and Get Published

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

How to Write Bad Poetry

So you've decided to crown yourself with a title that... Read More

3 Quick and Easy Ways to Generate Story Ideas

There are many ways you can generate ideas you can... Read More