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.

---

How to Relax Your Writing

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

Do The Unfamiliar To Keep Your Writing Going

One of the best ways to blow someone's winning streak... Read More

Go With The Flow: Write With Transition Words and Phrases

One of the most common weaknesses I see in day-to-day... Read More

Writing IS a Business

Why is it that so many people don't take writing-as-a-job... Read More

Writing HI-LO Material (High Interest, Low Ability) for Slow Readers

To write books for readers at an elementary reading level... Read More

Story Building with Imagination

In the words of Aristotle, "happiness is self contentedness helping... Read More

Tips for First Time Authors : 2 Easy Steps to Make Your First Book a Success

Congratulations on writing your first book. That is quite an... Read More

Writing Made Them Rich #5: Peter Mayle

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

Tips For Better Writing

It is certainly true that we don't get a second... Read More

Who Else Wants To Make $3546 By Simply Pressing a Button!

If you have been online for any length of time... Read More

Writing and Self-examination

Good writing requires self-examination. Why is one writing? What part... Read More

Plotting Problems - Episodic Writing

The rejection letter says: "Your story, on the surface, appears... Read More

Self-examination vs Self-indulgence

Self-examination is brutally honest. Self-indulgence is brutally maudlin.Writing requires the... Read More

The Many Paths to Plotting

For several years before I left teaching to write full... Read More

Resignation Letters: Dont Let Yours Backfire On You...

It turns out that "tips and templates on how to... Read More

The Writer and the Web

If your dream is to get published, the chance is... Read More

Another Way to Show Your Expertise: Write a Book!

Maybe you should write a book! This is not as... Read More

A Writers Inner Battle

There is a psychological nuisance so powerful that can deflate... Read More

Creative Problem-Solving: Following Your Stream of Consciousness

Having trouble finding a solution to a nagging problem? Try... Read More

Business Writing Tip: Question & Answer Format

Traditionally, business writing uses the "one thing after another" format,... Read More

10 Ways to Shatter Writers Block

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

Get Creative In The Great Outdoors

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

Writing Personal Statements - Top Tips

WRITING THE PERSONAL STATEMENT TO GET INTO UK UNIVERSITYHOW DO... Read More

Amazing Ways Writing Articles Can Improve Your Business

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

Dialogue Tags - A Study in Common Errors

Verb and SubjectIncorrect:"I bet you two had a fine time,"... Read More

Use Real-Life Templates For Writing Success

At some point along the way, most of us have... 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 Top Five Mistakes That Companies Make with Regard to Technical Documentation

I've seen it time and again. One of the most... Read More

Hunting for Markets Over the Holidays

Chances are, you'll be busy over the next several weeks.... Read More

Get Your Writing Reviewed by Major Publications for Free

All Writers need the press, especially new writers. As a... Read More

The Self-indulgent Writier

A writer can never be self indulgent whether writing fiction,... Read More

Effective Editing: It Spells the Difference!

If you think proofreading equals editing, then you're wrong! Editing... Read More

8 Great Journaling Tips

Mix a martini, don't forget the olives, or pour yourself... Read More