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.
cheap limo service Lombard .. Lockport Chicago limo O’HareBy far, I have found that the lack of discipline... Read More
Some writers are just too kind.They hate to put their... Read More
Creative Writing Tips ?How we usually begin the preparation stage... Read More
In the current job market, many editorial freelancers have turned... Read More
My Dad has this old joke that goes, "What's the... Read More
For any great novelist, defining your cast of intriguing characters... Read More
A friend and I were talking the other day about... Read More
Why would anyone want to write for trade journals? Aren't... Read More
You know you've got writing talent. Others enjoy your work... Read More
Agents and publishing houses have their best interests at heart,... Read More
As a child, I loved to write. I can't remember... Read More
Good writing is like sex. Two people are involved ?... Read More
What is a freelance grant writer? These individuals have a... Read More
If you want happy customers to use your service or... Read More
When a writer is working on their next literary masterpiece... Read More
Choosing the wrong words can have a poor effect on... Read More
In the beginning of your story you have to grab... Read More
No user manual? Surely you jest!It may seem comical, but... Read More
How to get a lot of traffic to your website... Read More
Charles Dickens was born in Portsea, England, in1812. His father... Read More
What am I going to write about?Which topic is the... Read More
There is a psychological nuisance so powerful that can deflate... Read More
When one population in one century survived five wars, two... Read More
1. What Is A Premise?A premise is the point you... Read More
Taming the Book Proposal: The BasicsOh, that most maddening of... Read More
limo O'Hare Glen Ellyn ..1 - Join a reading or writing group. Ask members... Read More
Okay. So I'm not David Letterman. But I doubt if... Read More
On my first newspaper assignment as a critic, I was... Read More
The freelance writing market is a growing market to be... Read More
Every writer expends a great deal of creative energy developing... Read More
1. Before you write anything down define not what you... Read More
Op-ed articles, also known as opinion/editorial articles, are a great... Read More
I've seen it time and again. One of the most... Read More
The principle for writing good screenplays begins with good idea... Read More
ELICIT, ILLICITElicit means to extract or draw out; illicit means... Read More
One of the most common weaknesses I see in day-to-day... Read More
During my 25-year career in a variety of professional positions... Read More
You have a new website, or a new business, or... Read More
Freelance editing opportunities are out there, you just need to... Read More
Congratulations on writing your first book. That is quite an... Read More
Effective screenwriting relies on the good understanding and use of... Read More
Creative Writing Tips ?It's no use coming up with a... Read More
Writing is hard work, and like all hard work, one... Read More
Everyone has a book inside them, or so the saying... Read More
Eight or nine times out of ten, picking up and... Read More
It's the funniest thing. When someone asks me what I... Read More
Using a ghostwriter to craft your free reprint articles and... Read More
I asked several writers how long it took them to... Read More
Take out a white piece of paper and place it... Read More
Each author has special editing needs. To save yourself time... Read More
Writing |