 | |
| |
Writing Information & News
| |
|
|
|
 Dont Forget That Manual!
No user manual? Surely you jest! It may seem comical, but it's a surprisingly common situation. I've encountered many companies that don't provide any user manuals with their products. If they do, their manuals are often horribly incoherent, or else years out of date. It shouldn't happen, but it happens all the time. Now, this problem is less common when buying off-the-shelf software or consumer electronics. That's because these products typically come from large corporations that pay attention to such details. Among smaller engineering firms though, this is a frequent occurrence. In fact, I'd estimate that about half of the small engineering companies that I've encountered are guilty of this offense. I remember how one engineer told me why his company didn't provide any user manuals with their products. In hushed tones, he said, "It's because we don't make any money by writing manuals. It's not a money-making venture, so our management doesn't want to waste time on this." An annoyed expression crept into his face, then he leaned closer and said, "We have lost so many customers because we don't have decent documentation. Talk about being penny-wise, pound-foolish!" It's not just the customers who suffer when manuals are inadequate or non-existent. What about the employees themselves? What happens when a new engineer comes on board, and has to learn quickly? Or what happens when existing engineers need to familiarize themselves more with unfamiliar aspects of their product lines? The user documentation, if properly written, can provide a gentle and efficient way of bringing the up to speed. Without it, they will be forced to rely more heavily on other engineers to educate them, thus wasting the time of everyone concerned. Weeks, if not months, of valuable manpower can be squandered in this fashion. At times, a company will pay lip service to user documentation by slapping together some hastily written document that is difficult for a new user to digest. "Who cares about wording anyway?" I've heard many engineers say. "We're not writing poetry or screenplays here. What matters is that the manual must be technically accurate." This is an appallingly short-sighted view. Technical accuracy is indeed important, but so are presentation and style. Few engineers would listen to a job applicant who shows up in a bathrobe and slippers, or a litigation attorney who speaks like a valley girl-and yet somehow, these same engineers expect their customers to slog through pages of meandering, poorly phrased text. Even matters as fundamental as spelling, grammar and proofreading are often treated as mere annoyances-piddling details that are worth nothing more than a cursory glance. (To my relief, I have not encountered any such attitudes at my place of employment. I hasten to say this, lest anyone think that I'm complaining about the people that I work with! No, I've found that we all appreciate the value of excellence, for which I am always thankful. But I digress.) Mind you, I understand that there are times when a company might not choose to invest an all-out effort in user manual development. This can happen during the early startup stages, for example, when manpower is in short supply and the products are still undergoing refinement. Unfortunately, many small companies never grow past that stage. Even after many years, they continue to thinks of user documentation as a trifling detail which deserves only a modicum of effort. By perpetuating that mindset, they ultimately shortchange both the customers and themselves. Like it or not, a company's user documentation (or lack thereof) is a reflection on the company itself. You can be sure that your customers will notice if the user manuals are poor or non-existent. In today's busy world, where people need to absorb information as efficiently as possible, the lack of quality documentation can be nothing short of disastrous. About The Author V. Berba Velasco has been plying his trade for nearly a decade. During that time, he has repeatedly discovered the importance of good technical writing, and the pitfalls that can occur from ignoring its value. Dr. Velasco currently works as a senior electrical and software engineer for Cellular Technology Ltd (http://www.immunospot.com, http://www.elispot-analyzers.de, http://www.elispot.cn). Dr. Velasco takes great pride in the company's commitment to user-friendliness and product excellence.
MORE RESOURCES:
Heartless traffic agent Daniel Chu STILL writing off drivers after scuffle ... - New York Daily News
Google News |
|
|
|
RELATED ARTICLES
10 Secrets For Writing Killer Complaint Letters Complaint letters aren't always fun, but sometimes they needto be written. In many cases, if people don't complain, the problem agency at fault (i. Turning Your Journal Into An Idea Bank A few magazines refer to their written idea sources in assigning articles to reliable, experienced writers, or even allow those writers to peruse them for topics to write about.And for awhile, I kept an idea book that was similar to a writer's journal. 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. Blank Mind, Blank Screen: Need Ideas! Q. I'm staring at a blank screen with an equally blank mind. Realize Your Book Dream In 2005! If you haven't realized the success you wanted last year, here's a way to reap the harvest with 86% improvement!Use the power of visualization.When you see, hear, and feel your book project already manifested through specific outcomes, you'll be in the 86% success group. How To Publish Your Own Newsletter With the expansion and diversion of businesses, manufacturers, and even hobbyists into more and more specialized areas of endeavor, there is an increasing need for information. And newsletters are the high profit way to cash in on the market for specialized information. When Getting Stuck Goes Amuck Many of us have always wanted to write. We have all gotten writer's block. Story Structure - Final Conflict Beyond three and four act story structure, lies the Hero's Journey.The Hero's Journey is the most usable story structure consisting of at least 106 stages and the template for successful contemporary stories, from Star Wars to Al Pacino Scarface to The Incredibles to War of the Worlds to The Dirty Dozen to Midnight Cowboy. The Dreaded Daily Word Count Open any book on 'how to write,' and somewhere you will find a discussion of how many words you should write every day. Forget the struggle to get ourselves to the paper or the computer every day, now we have to produce a certain number of words?Me? I don't write every day (Quick! Call the Writer Police!), I don't do 2000 words, and you don't have to either. Writing Made Them Rich #4: Paulo Coelho Paulo Coelho was born on August 24th 1947 in Rio de Janeiro, Brazil.At age 17 he announced his intention to be a writer. Screenwriting - The Value of Structure Structure in the form of frameworks, work processes and goals enhances creative output:a) Short term goals (incremental productivity) produce more output than a "do your best" approach. Writing four pages a day completes a words-on-paper first draft screenplay in one month. Top Seven Ways to Select a Book Topic That Sells Authors need to write their book according to their target audiences' needs and wants. You can sell many more copies when you address these seven ways to select a topic that sells. If You Want to Succeed As a Writer, Dont Just Think It, Do It It never ceases to amaze me when a prospective writer confesses that he or she has never put anything down on paper. Obviously, that's the first step. 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. Persisting With Bulldog Determination Persisting With Bulldog Determination [Book excerpt from Successercising}by Rick Gettle © 2003-2004Ninety-five percent of all new businesses go out of business within the first five years or less.Why Do They Fail?There are many starters in life - but very few finish what they start. Format Each eBook Chapter Before you Write It Do you have a problem creating a focus in your chapters? Does your writing slip around, leaving a muddy path to the gold--your unique, useful message? Format each chapter in your book. Your consistency, your organized, focused copy will compel your reader to want to read every chapter because they are easy to understand. Documenting Everything: Your Journal is Your Logbook Sailors had it for years. Great explorers had it as well. Using Technology to Improve Your Final Draft One Saturday afternoon, I sat in a packed conference room with about 150 other would be writers, listening to a conference instructor tell us the keys to self-editing our manuscripts. The number of people in the room spoke to how important it is to make sure your work is crisp, and as close to publishable as possible. Freelance Feast or Famine? Sometimes a freelance writing career can feel very much like "feast or famine".At the very beginning, it's almost all famine. Masquerading As Novel ~ Can Author's Work Convey Important Perceptions? While novels do not usually attempt to convey concepts about the need to protect ourselves, this one does. For Sale By Owners:FSBO.
|
| © Writing Information 2010 |