 |
The Value of Adding Images to Technical Documentation
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.
MORE RESOURCES:
|
Writing's on the wall for McNabbESPNBy Ashley Fox | ESPN.com There is one franchise that would seem to be a perfect fit for Donovan McNabb, a place where he knows the system, the personnel, the expectations and the playbook, and he wouldn't have to mentor anybody.and more » |
|
Lisa Rinna on writing a book about sexCNN"The Big Fun Sexy Sex Book" is a fun and innovative guide to rejuvenating your sex life and libido, co-written with renowned sex therapist Ian Kerner (who writes about sex on CNN's medical news blog, The Chart). The vivacious 48-year-old actress is ...and more » |
ABC News (blog) |
Mexican Writer Carlos Fuentes Dies at 83Wall Street Journal (blog)By Jose de Cordoba MEXICO CITY – Carlos Fuentes, Mexico's most famous writer, and a world-known public intellectual, died Tuesday, depriving the nation of its most internationally recognized voice. Mr. Fuentes, a novelist, poet, diplomat, critic, ...In Writing, Fuentes Shed Light On Poverty, InequalityNPRCarlos Fuentes, Mexican Novelist Who Inspired Latin American Writing, DiesABC News (blog)Mexican author Carlos Fuentes diesABC OnlineLos Angeles Times -Reuters -San Francisco Chronicleall 941 news articles » |
|
Short story writer takes home Sophie Kerr AwardThe Star DemocratManion, an English major from Clarksville, took the prize with her submission of four short stories she considers to be works in progress, and excerpts of her thesis on the role of letter writing in literature a study that drew from the novels of Jane ...and more » |
|
Content Writing King Writer Announces New SEO Blog PostPR Web (press release)The Article Marketing Writer For Content Writing King Has Released A New Blog Post. This New Blog Post Educates On White Hat And Black Hat SEO Today, Content Writing King has announced that their article marketing writer has published a brand new blog ...and more » |
Google News
|
|
|
|
RELATED ARTICLES
6 Ways to Jump-Start Your Writing Day
1. PLAY A GAME LIKE SOLITAIRE.
To Write Successful Business & Academic Communications, Learn the Architecture of a Story
Human beings seem to be born with a gene for telling stories. Stories from our families, our communities, and the media form our worldview and shape our lives.
Suspense Novels Made Easy
Suspense novels are probably the easiest novels to write. Suspense novels require a simple formula, which will make your work truly suspenseful.
Power Writing 101: Tips and Tricks to Get You Taken Seriously!
In my ten years as an advertiser, I've encountered plenty of folks with a flair for writing. They were born having some idea of where to put the words within the sentence, and the sentences within the paragraph.
5 Easy Steps To Writing Your Appealing Letter
You must write a hypnotic persuasion letter to help you achieve all your goals! Get the boss to give your a raise, induce that beautiful blue-eyed girl to be your lover and persuade your mother to buy a BMW Z3 for you this summer.Give me twenty minutes and I'll teach you step-by-step my secret writing your own success system.
For Beginners: Ten Ways To Prepare To Get Published
(Skip directly to ten for the fastest shortcut!)Like any field, excellent writing requires study, practice and mentorship. Very few successful authors ever published their first draft of their first work.
Get Published: The Nuts and Bolts of Good English, and How to Impress a Publisher (1)
Not all writers write good grammar. That's a fact.
How Three Publishing Myths Kill the Author
Agents and publishing houses have their best interests at heart, not the author's. Save yourself from headaches, disappointments, and money down the drain.
Ferreting Out Work
FERRETING OUT WORK
You keep hearing that there's work out there, but so far you haven't found any. Well, where is it? That depends on what you're looking for.
How You Can Find Freelance Editing Jobs
Freelance editing opportunities are out there, you just need to know where and how to look for them. As a matter of fact, there are hundreds of companies that are waiting for you, right now, to fill their job vacancies.
Are You a Freelance Writer? - Then You Need a Website
As a freelance writer, it is important to present yourself to your clients in a highly effective way. One of the most effective methods that freelancers use is a website.
Creative Writing Tips - Have You Established Your Main Character At The Start?
In the beginning of your story you have to grab your readers' interest and sustain it till the end. Our hook is our character.
Where to Look for Your Next Project when You're Writing for Profit
When my first book "Starting Your Own Business" was published way back in 1995, I thought that was it. I reckoned I'd never write another one.
Whose Story Is It?
Whenever you sit down to plot a story (or even to think about a story) one of the first things you have to ask yourself is this: "Whose story IS it?"It seems like a simple question - but your story can succeed or fail depending on how you handle this. Told from the wrong point of view, a story can founder before the first chapter has come to an end.
Why Researching Is Good, And A Failure To Do So Is Not
What a lack of research could do to you.When creating an ebook how well do you research the topic before hand?It's absolutely crucial that you research what problems your target market is having andwhat they're spending money on.
What you Dont Know About Book Publishing Can Cost You
Dream that your book can be a number one best seller? Read books or visit Web sites that say they have your answers? -- All you need to do is get their program, follow their advice, and the world is yours. Or, you think I'll write it, but someone else can market and promote it.
Ten Quick Tips for Inexperienced Writers
One of the biggest problems that inexperienced writers have is simply knowing how to get started. If you've unsure of your writing skills, then here are some quick tips to help you get started.
10 Ways to Shatter Writers Block
1. Use Logic: Check for External PressuresAre you under physical or emotional stress? Is your diet lacking? Do you need more sleep, or more restful sleep? Would a visit to the doctor be in order before you start beating yourself up about your inability to concentrate?2.
A Writers Tools
William Faulkner, the great Mississippi writer, said, "The tools I need for work are paper, tobacco, food, and a little whisky."Every writer needs certain tools to accomplish the task of being a writer.
Is The Theme Reinforced In The Ending?
Creative Writing Tips -By now you should have an idea that your theme has to reach its conclusion just as your story does. But our theme has to do more than reach its conclusion - it has to be reinforced in the end and by doing this, it will strengthen all that we have said in our story.
|
