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.
move in cleaning service Morton Grove ...Questions and answers on writing life experiences for ourselves and... Read More
Around eighty percent of nonfiction books today are written by... Read More
Whether you are writing a magazine article, composing a press... Read More
Ever wondered how the most successful children's book writers get... Read More
Is there a book inside of you? Yes? Then why... Read More
A UK based freelance proofreader should be able to provide... Read More
You can create a great headline, a dynamic first sentence,... Read More
Sit back, and imagine what it feels like to be... Read More
Sailors had it for years. Great explorers had it as... Read More
Clustering, also called Mind Mapping, is a great way to... Read More
In his book, "Achieving Financial Independence as a Freelance Writer,"... Read More
Great business writers combine narrative skills with sound judgment to... Read More
The decision to publish a book is very exciting! It... Read More
Yes, you know your subject. You also need to think... Read More
Did you know that your back cover information is, after... Read More
A well-punctuated approach letter may make the difference between acceptance... Read More
If you are reading this article then you probably have... Read More
Our Image-Driven SocietyWe live in a new image-driven society. It... Read More
Our Freelance Writing Needs DefinedWe must make freelance niche types... Read More
Everyone has a unique story to tell. From explaining business... Read More
Many of us have always wanted to write. We have... Read More
If you want to be a writer, then you must... Read More
It's the funniest thing. When someone asks me what I... Read More
'Talent is cheaper than table salt. What separates the talented... Read More
Every hero has a seminal insight - the apotheosis. Once... Read More
maid service near Buffalo Grove ...It never ceases to amaze me when a prospective writer... Read More
If you're getting rejections from your submissions, please don't quit... Read More
Paulo Coelho was born on August 24th 1947 in Rio... Read More
Did you know that your back cover information is, after... Read More
FERRETING OUT WORK You keep hearing that there's work out... Read More
Recently I was watching the Oprah show and it was... Read More
There is an image most people carry of the artist... Read More
To write books for readers at an elementary reading level... Read More
During my 25-year career in a variety of professional positions... Read More
This article contains a short guide on how to edit... Read More
Creative Writing Tips ?You are plotting the story. You write... Read More
Not long ago, I went to an Internet Marketing Seminar.... Read More
First drafts are for getting down the ideas. Anna Jacobs... Read More
One obvious question that can get overlooked in the process... Read More
While novels do not usually attempt to convey concepts about... Read More
Writing is a muscle that needs exercise to stay in... Read More
What do people expect when they join a writing group?The... Read More
How do you choose a name? Do you put down... Read More
If you're a writer, you're in business. It doesn't matter... Read More
A good white paper is a paper that makes you... Read More
Sailors had it for years. Great explorers had it as... Read More
If you have been online for any length of time... Read More
Do you suffer from writer's block? Is there a pending... Read More
Every writer knows that the urge to write is not... Read More
One of the biggest problems that inexperienced writers have is... Read More
Writing |