| |
| |
|
Writing Information |
|
|
|
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:
Google News |
 |
|
|
RELATED ARTICLES
Why We Dont Write Our Books In the ten years that I've taught people how to get on with their books, I've noticed a phenomenon that I'll call "Author's Block." Would-be writers can, indeed, sit down and work when pressed to it. Nonfiction Idea Generators The hardest part of nonfiction writing is finding a subject to write about. Unless you're a student or a professional writer no one is going to select a topic for you. Increase Your Chances Of Winning Writing Contests Winning writing contests can provide several advantages to writers. For starters it's a great way to get your name in print and in front of potential readers. Writing Made Them Rich #1: JK Rowling Joanne Kathleen Rowling was born in Chipping Sodbury,England in 1965. She began writing at the age of 6 with astory called 'Rabbit', which she never finished. Writing from Home: It Can Be Great and Not-So-Great for Mothers I went to school to be a teacher. In fact, I have a B. The Importance of Writing Clearly for Business Creating written documents reveals so much about you and your business skills. Your writing tells the reader about your educational background, pride in your work and business expertise. Write That Down! Compulsively Collecting Content for Your Writing Have you ever read someone else's writing and thought one of the following things:Where did he get such great stories? Why can't I think of examples like that? How does she always develop amazing illustrations?The answer is: content.In writing, content is KING. An Inside Look at Proofreading This is the ideal topic for us all to think about. We do it everyday, especially those of us that use the Internet the majority of the time. Groundbreaking Work Every writer knows that the urge to write is not always present. As a result, the dedicated writer writes anyway. Ten Tips To Get Started Writing Your Book You are far more likely to successfully write and publish your book if you follow these tips before you write a single chapter.1. How To Co-Publish For Profits! The Benefits of Co-Publishing There are a number of publishers, printers, and mail order dealers who publish their own mailorder magazine. They make their profit by selling advertising space to others in addition to selling their own offers. About Writing Here's everything I know about improving your writing, publishing it electronically and in print, and promoting it after the sale.Two questions you should ask:(1) What will it cost me?(2) What does this Michael LaRocca guy know about it?Answer #1 -- It won't cost you a thing. 8 Reasons Why A Freelance Writer Should Use the Internet What a wonderful resource the Internet is!Students find information to help them with their studies; business people keep in touch with important clients and stay up to date with important business developments; stay-at-home-parents can find ideas for children's activities and feel less isolated by forging friendships with other online parents; and even small children have the opportunity to learn how to use the technology that will take them into the future.It seems everybody has a reason to use the Internet and writers are no exception. Need a Book Coach, Ghost Writer, or Editor? Part 2 If you either want to write a book to help others create a better life and boost business or you already have your book nearly finished, you may need book coaching to answer all of your questions "What step to take next?"Know Your Editing ChoicesLine editing. Use this final professional edit after you have already revised your work three times. Message to Online Writers: Dont Give Up On A Good Idea The writing community is a strong one, with many new "members" joining daily. All theser writers are finding or looking for their particular niches. How To Write A Newsletter In order to be successful with a newsletter, specialize in a subject not adequately covered in existing newsletters. A subject which you can give more, or better information on. Journaling How many of you take the time to really write down your thoughts?Do you know that journaling not only lets you "work" out problems but releases tension and gets the problem off your mind.I started journaling about 10 years ago right after I had my first son. Prolific Writers Prolific authors write; they don't just dream about it. A good example is Georges Simenon of Inspector Maigret fame. Bring Out the Natural Writer in You Think you can't write a book that will sell? You aren't a natural writer? In fact, you don't really like to write?Putting a book together can be daunting. But no, you don't need to hire a ghostwriter. Amazing Ways Writing Articles Can Improve Your Business How to get a lot of traffic to your website FREE? Writing articles. This is one of most cost effective way to promote your website - it saves you a lot of money, in the meantime, you get a lot of valuable visitors.
|
| home | site map |
| © 2008 ReV Brown and LaMesa Gifts |
