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.
Whats in a Name? Giving Birth to your Characters
So you've got your plot outlined, a title lined up and the research is done. You're ready to start writing your novel. But wait. Now comes the fun part: creating names for your characters. One of the best things about being a writer-besides the innate ability to create imaginary worlds-is giving birth to a character and then bestowing a name upon him or her. True, you didn't carry the character in your womb for nine months (especially if you're male). But he or she could've been in your head for nine months?or nine years. So choosing a name for your characters seems almost as important as the one you would give your own child.
Hunting for Markets Over the Holidays
Chances are, you'll be busy over the next several weeks. Between preparing for, celebrating, and unwinding from the holidays it may be difficult to maintain your regular writing routine. And if researching potential homes for your work is part of that routine-as it is for many of us who regularly submit stories, essays, poems, articles, and reviews for publication-you may be worried about falling behind.
Nobody Likes A Rambler
We all know people who ramble. They include every boring and insignificant detail, speak in five-minute-long sentences and take forever to get to the point. When they finally reach the end of their story, most people have either walked away or lost interest.
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.S. in Education, not journalism.
Italics Part 1 - Do You Need to Use Italics?
Next time you're tempted to use italics for emphasis... STOP!
Permission NOT To Write
Quite a few years ago, I enrolled in a Degree in Criminal Justice. My main reason for doing so was my interest in reading and writing crime and mystery fiction. I thought by doing this course, I would gain a good grounding in police procedure. I was particularly interested in forensic science and profiling.
Writing and Self-examination
Good writing requires self-examination. Why is one writing? What part of the writer will be shared with readers? Will it be only information or will it include the essence of the writer? This, then determines what will be written: poetry, essays, articles, short stories, novels, or any other genre of writing.
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.
Writing Is Not Life-threatening
Some writers complain that writing is arduous work requiring long hours and little pay, which is often true especially for freelance fiction writers. Today, everyone wants to be a writer and with word processors and computers it is easy to put thoughts down, but it is not always effortless to be published unless one self-publishes or uses a vanity press.
Hero?s Journey ? The Herald
Beyond three and four act story structure, lies the Hero's Journey.
Freelancing Doesnt Mean Writing For Free. Does it?
Writer's forums are bustling with debate over whether or not a writer should send something out for free. Some people feel that writing for free weakens the market for other writers, while some people feel that writing is an art that should be shared freely.
How to Write Funny -- Its All About Timing
My Dad has this old joke that goes, "What's the most important thing about humor?" After a short pause, he interjects, "TIMING!"
Have You Settled On First Choice When Choosing A Title?
Short Story Writing Tips -
Scenes and Structure
Beginning writers often tend to think of a book as a series of chapters. It's actually more useful to regard it as a series of linked scenes. Why? Because it makes it a lot easier to control the pace of your story.
Imagine The Imagination
Imagine a three hundred page book was in the author's mind before it was poured out onto the pages of the book.
Applying KISS Principle in Writing
I have added a new word to my vocabulary. Logorrhea. We've all been touched by it. What is it? The Word Spy defines it, "excessive verbosity and long-windedness. Also know as verbal diarrhea."
Why I Write
I started writing as a way of keeping safe memories of a particularly adventurous 3 years of my life when I became totally addicted to the world of online chat rooms and met a number of 'gentlemen' for real that I met in fantasyland online.
Top 10 Common English Goofs by Web Authors
In reviewing and browsing web sites over the years, I have compiled a list of the most common misuses of English by web authors. Here they are in Letterman (reverse) order.
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?"
Why Manners Maketh the Freelance Writer
Lately I've been noticing an odd trend amongst the freelance writers who contact us every week: rudeness.
|© Athifea Distribution LLC - 2013|