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.

---

Get Creative In The Great Outdoors

Summer's here and the time is write for dancing in... Read More

Why We Dont Write Our Books

In the ten years that I've taught people how to... Read More

Starting a Freelance Writing Career (or Thoughts About Taking the Plunge)

Nike's ad has taken on new meaning for me of... Read More

The Magic of Layout in Your Story

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

Planning Time To Write

In his book, "Achieving Financial Independence as a Freelance Writer,"... Read More

Editorial Freelancing: 5 Must-Know Tips to Getting Your Foot in the Door

So, you want to freelance as an editor, writer, copy... Read More

Balance Your Life

Balance your life ... Read More

Writing Short Info Reports

People want information, they want it quick, frequently in short... Read More

Help! I Cant Write!

Writer's Block can strike like a King Cobra, paralyzing every... Read More

Writing Made Them Rich #1: JK Rowling

Joanne Kathleen Rowling was born in Chipping Sodbury,England in 1965.... Read More

The Writers Angst

What is this annoying, insidious angst that permeates my psyche?... Read More

Does Your Theme Contain Character, Conflict, Resolution?

Creative Writing Tips ?For a theme to work and the... Read More

English Grammar ? Seven Outdated Rules You Can Ignore

No matter what your fifth-grade English teacher says, some grammar... Read More

Critique Groups - The Good, The Bad and the Ugly

What do people expect when they join a writing group?The... Read More

New Authors Publishing Options

All your publishing options are as follows:--Conventional publishing--Vanity or subsidy... Read More

How to Relax Your Writing

Q. My writing sounds stiff and stilted. Help!A. Memories of... Read More

The Blank Mind

Many writers stare at the blank page or clean computer... Read More

8 Advantages to Writing a Book as an Entrepreneur

As an aspiring or an established entrepreneur, you are an... Read More

What You May Not Learn In College... (Part Two)

If you become a writer for any publication, private business,... Read More

Writing for the Internet -- How To Give the Readers What They Want

In this article you will find tips on: How to... Read More

Why Every Freelancer Should Have A Web Site

"Do I send samples, a media kit, or just the... Read More

Mexican Living: Lets Be Perfectly Clear

Readers often send me interesting and exciting e-mails about the... Read More

Overcoming Writers Block

Do you suffer from writer's block? Is there a pending... Read More

The Top Five Writing Mistakes Professionals Make

Yes, you know your subject. You also need to think... Read More

10 Tips on Writing Effective Dialogue

1. Become an EavesdropperListen carefully to the way people REALLY... 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

Reasons for Recording Your Life Story

1. No one else will do it for you.2. No... Read More

10 Ways to Shatter Writers Block

1. Use Logic: Check for External PressuresAre you under physical... Read More

Writing Query Letters that Count -- Close the Deal with Your First Letter!

Your query letter can be a deal maker or a... Read More

Italics Part 1 - Do You Need to Use Italics?

Next time you're tempted to use italics for emphasis... STOP!"Why?"... Read More

Discover the Writer Hiding Inside You

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

Generating Nonfiction Book Titles Without a Hassle

The process of developing a working title for your nonfiction... Read More

Does Your Plot Suit Your Characters And Vice-Versa?

Creative Writing Tips ?When an idea comes to us for... Read More