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.
weekly home cleaning Highland Park ..The Blogfest 2005 Writing Contest has only been running for... Read More
It is satisfying to be a part of such a... Read More
Writing technical articles is a challenge. There you sit, surrounded... Read More
The first step in the writing process is to put... Read More
An island in the Mediterranean. A beach in Africa. The... Read More
The Benefits of Co-Publishing There are a number of publishers,... Read More
Proofreading worksheets are a great tool to help individuals open... Read More
We all need a cheer squad.We all need people to... Read More
Creative Writing Tips ?How we usually begin the preparation stage... Read More
Not long ago, I went to an Internet Marketing Seminar.... Read More
When you write for international audiences, mainly directly in English,... Read More
For those looking at the jobs listings for writers, they... Read More
Quite a few years ago, I enrolled in a Degree... Read More
Clustering, also called Mind Mapping, is a great way to... Read More
Recently I was watching the Oprah show and it was... Read More
The greatest gift you have to give to yourself and... Read More
Listen, consider this scenario.You have a deadline to honour. Time... Read More
A book coaching client recently emailed me that she was... Read More
A QUERY LETTER is written to an editor or agent... Read More
Bookcoaching clients come to me at different stages of writing... Read More
When you sit down to write a steamy romance, a... Read More
If you are a serious writer who wants to publish... Read More
More Tips For New Writers (Part I)Explain in your own... Read More
"The Magic of Layout..."???Okay... "magic" might seem a bit over... Read More
People can't believe I did it, but I did. I... Read More
whole house cleaning Park Ridge ..Writers often get stuck because they make assumptions about writing,... Read More
When the writing bug hits you, get out your pencil,... Read More
Have you ever had a student write to tell you... Read More
The Big IdeaOkay. So youve figured out that you would... Read More
Whether you're interviewing for a new job, trying to woo... Read More
We've all been told that we need to use all... Read More
And a dreadful thing from the cliff did spring, and... Read More
The Benefits of Co-Publishing There are a number of publishers,... Read More
The following answer sounds simplistic?but think about it. The single... Read More
Style manuals are all well and good, and in fact,... Read More
Real Estate has "Location, location, location," and writing has "Clips,... Read More
Dream that your book can be a number one best... Read More
Have you been guilty of procrastinating on your book project,... Read More
Based on the feedback that I have been getting from... Read More
The Hottest Word on the WebDid you know marketing people... Read More
It occurred to me one day that I needed something... Read More
Creative Writing Tips ?We all tackle plotting differently. How you... Read More
Concision. (Sounds like I made up another word.) It's the... Read More
Welcome to the zany ideas of a productive writer. My... Read More
Tips for your writing journeySo, you'd like to be a... Read More
Ever wonder why we refer to convincing an editor a... Read More
It's easy to feel overwhelmed by marketing. First, there's so... Read More
Here's something from my mailbag. "Dear Michael, do you need... Read More
Do you have a problem creating a focus in your... Read More
Maybe you should write a book! This is not as... Read More
Writing |