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.
eco-friendly cleaning service Buffalo Grove ..Writers are often are greatly surprised or disappointed by how... Read More
~TYPES~You Want Us to Write What? Understanding the Task AssignedWhich... Read More
Before you even begin writing your novel, you need to... Read More
Not long ago, I went to an Internet Marketing Seminar.... Read More
Sometimes I can be dense when it comes to realizing... Read More
IntroductionSince our early days of elementary education we have been... Read More
Sometimes there is confusion about the exact meaning of the... Read More
One day in the mid-1970's a young man stumbled into... Read More
Interested in breaking into writing or breaking into a new... Read More
Dr. Phil's Life Strategies, #1 New York Times Bestseller catches... Read More
Want to write your book? But, need a blueprint on... Read More
Welcome to the zany ideas of a productive writer. My... Read More
The creativity of Jaisini is not designed to be preaching... Read More
Whenever you sit down to plot a story (or even... Read More
ELICIT, ILLICITElicit means to extract or draw out; illicit means... Read More
* Scanning and Skimming Practices *Whether you're writing e-mail messages... Read More
Over the past eight years or so, I have tutored... Read More
Creative Writing Tips ?By now you should have an idea... Read More
1. Set aside a time to write and keep it... Read More
To write books for readers at an elementary reading level... Read More
When you run an online agency for freelance writers, editors... Read More
It never ceases to amaze me when a prospective writer... Read More
"You should write a book." For years, I had been... Read More
(This excerpt is taken from my new writing workshop Writing... Read More
Agents and publishing houses have their best interests at heart,... Read More
express cleaning service Arlington Heights ..FIVE MINUTES ... Is All You Need ........to phone a... Read More
Calling all publishers, editors, journalists and freelance writers. It's time... Read More
Building a new website can be extremely exciting. Seeing your... Read More
Op-ed articles, also known as opinion/editorial articles, are a great... Read More
In most aspects of business, we will be expected to... Read More
A certified proofreader is one that has taken a few... Read More
Persisting With Bulldog Determination [Book excerpt from Successercising} by Rick... Read More
Started a book and then got bogged down? Like many... Read More
He ran up the steps and knocked on the door.... Read More
'Talent is cheaper than table salt. What separates the talented... Read More
Have you ever considered writing a book? If so, maybe... Read More
ISBN stands for International Standard Book Number. It is a... Read More
It turns out that "tips and templates on how to... Read More
~~~Old age, to the unlearned, is winter; to the learned,... Read More
These are some of the snapshots I carry with me:... Read More
Be careful when you write.Words you use, sentences you phrase... Read More
1. Make your goals achievable.By achievable, we mean realistic and... Read More
Dr. Phil's Life Strategies, #1 New York Times Bestseller catches... Read More
Back in my school days, if the teacher demanded a... Read More
Simply put, it is the art of writing scripts for... Read More
"If you want to change your life," Harry Beckwith wrote... Read More
In a crowded market, clients will be seeking personality as... Read More
Having trouble finding a solution to a nagging problem? Try... Read More
Mindmapping is better than linear outlining because authors can use... Read More
Want to write an article or book, but are stuck... Read More
Writing |