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 ..And a dreadful thing from the cliff did spring, and... Read More
How do you describe a scene without slowing down the... Read More
Characters in a good novel really carry the story along... Read More
Having trouble finding a solution to a nagging problem? Try... Read More
The urge to write fiction seems God given for some,... Read More
So you want to be a successful author? You want... Read More
Summer's here and the time is write for dancing in... Read More
To write books for readers at an elementary reading level... Read More
Last week I was having a quick browse on eBay... Read More
Every writer knows that the urge to write is not... Read More
When you read a letter from someone, we are immediately... Read More
Short Story Writing Tips ?We all have different tastes in... Read More
Everybody knows writing a story is not easy. Like the... Read More
This article contains a short guide on how to edit... Read More
Every morning I excitedly get out of bed. Just a... Read More
How do you choose a name? Do you put down... Read More
Obtaining the skills for writing good business correpondence is important;... Read More
If you find your sentences filled with commas, and they... Read More
Anyone who has read any of my articles on the... Read More
In the ten years that I've taught people how to... Read More
Writing for the web is very different from writing for... Read More
Welcome to the zany ideas of a productive writer. My... Read More
This article is to help identify which style, technique or... Read More
ACCEPT, EXCEPT Not commonly seen even from unpublished writers, who... Read More
A certified proofreader is one that has taken a few... Read More
whole house cleaning Park Ridge ..With the expansion and diversion of businesses, manufacturers, and even... Read More
ESSAY 3Writing an autobiography involves a matching up of a... Read More
Want to write your book? But, need a blueprint on... Read More
Pictures they say are worth a thousand words, but many... Read More
Making Money from Freelance WritingIt's the question that every aspiring... Read More
Do you consider yourself a storyteller? Do you consider yourself... Read More
ESSAY 2Andre Malraux once said that what interested him in... Read More
Is it possible to improve your writing instantly? The answer,... Read More
If you are a serious writer who wants to publish... Read More
During my 25-year career in a variety of professional positions... Read More
ESSAYS ON AUTOBIOGRAPHY: NUMBER 1Preamble:Nearly seven years ago I wrote... Read More
Your computer is a writing machine, a word processor, a... Read More
Recently I was watching the Oprah show and it was... Read More
Almost everyone could profit from enhancing their writing skills. From... Read More
Remember the days when we wrote with pen and paper?... Read More
Part 1 of this article discussed the experience you need... Read More
Dr. Phil's Life Strategies, #1 New York Times Bestseller catches... Read More
You've finished your story, and you're pretty happy with it.... Read More
The following answer sounds simplistic?but think about it. The single... Read More
Is there a book inside of you? Yes? Then why... Read More
Many of us have always wanted to write. We have... Read More
Most of us hate housework.Nevertheless, even the most hopeless slobs... Read More
Sometimes a freelance writing career can feel very much like... Read More
Writing papers and book reports has long been the bane... Read More
Creative Writing Tips ?Complete a character questionnaire for each of... Read More
Writing |