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.

---

8 Tips to Get Publishers to Notice You

If your articles aren't getting published very often, or you... Read More

Writers can Grow to be Comfortable with Criticism

On my first newspaper assignment as a critic, I was... Read More

A Quick Guide to ISBNs for Self-Publishers

ISBN stands for International Standard Book Number. It is a... Read More

Building Character

Names are important. Names give clues about us, where we... Read More

Idea Mining for Writers 101

Want to write an article or book, but are stuck... 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

5 Effective Web Writing Tips

Writing for the web is very different from writing for... Read More

Keeping a Love Journal

Do you love someone very deeply? A spouse, son, daughter,... Read More

How To Avoid Viewpoint Slips

Sit back, and imagine what it feels like to be... Read More

Eight Ways To Write Your Novel Faster

I asked several writers how long it took them to... Read More

Editing Secrets

Once you've plotted out your book, developed the characters and... Read More

Three Tips to Improve Your Writing Rhythm

As a professional copywriter, not only do I do a... Read More

Writing Made Them Rich #5: Peter Mayle

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

Create A Dream Diary

How many times have you forced yourself to sit in... Read More

How Long is a Chapter?

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

Mixing and Mingling: The Door to Publication?

Mixing and mingling with industry professionals is an opportunity that... Read More

Screenwriting, Screenplays, Screenwriters ? Good Ideas for Stories

The principle for writing good screenplays begins with good idea... Read More

Does Your Plot Suit Your Characters And Vice-Versa?

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

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

ACCEPT, EXCEPT Not commonly seen even from unpublished writers, who... Read More

Apotheosis - the Seminal Insight of the Hero for Screenwriting

Every hero has a seminal insight - the apotheosis. Once... Read More

Writing For The Web: Where To Get Article Ideas

A friend and I were talking the other day about... Read More

3 Quick Tips on Plotting Your Book

Plotting a book can seem an overwhelming task when you're... Read More

Freelance Feast or Famine?

Sometimes a freelance writing career can feel very much like... Read More

How To Co-Publish For Profits!

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

Strategies For Finding Topics To Write About

What possibly could I have to write about? I never... Read More

Is Your Title Compelling?

Short Story Writing Tips:Your title is your selling tool. It's... 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

How to Write a Holiday Tale that Isn?t a Turkey

When we write stories, with the purpose of sharing them... Read More

Win More Clients, Projects and Freelance Jobs By Making Three Small Changes

Iâ??ve spoken to hundreds of editors, employers, and project managers... Read More

How to Pitch a Story

Ever wonder why we refer to convincing an editor a... Read More

Whats in a Name? Giving Birth to your Characters

So you've got your plot outlined, a title lined up... Read More

Save Time When You Write

I'm in the process of moving from one computer to... Read More

To Outline Or Not To Outline

Ah, the age-old writer's debate--to outline or not to outline?Outlines... Read More