| |
| |
|
Writing Information |
|
|
|
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:
Writing - Google News |
|
|
|
RELATED ARTICLES
Turbo Charge Your Career! Write And Produce Your Own Stage Play! Have you ever wondered how you can adapt your screenplay or novel into a stage play? Do you have a story that you yearn to see on stage? Or, maybe you're an actor frustrated by the barrage of fruitless auditions and dream of performing before a live audience. If so, writing and producing your own stage play just may be the ticket to turbo charging your career. Interviewing an Author: Dont Be Left Speechless Joyce Carol Oates. Langston Hughes. Do You Know How To Write English For Global Audiences? When you write for international audiences, mainly directly in English, you will need to develop an audience profile. In particular, you will have to show consistency and clarity in style/expression and you will have to be culturally sensitive. 9 More Writing Tips for Successful Email Marketing A few months ago, I wrote a guide entitled: 101 Writing Tips for Successful Email Marketing. In fact, many COPY TIPS subscribers have a copy. How to Multiply Your Freelance Writing Work You can turn your $200 fee to write a press release into $2,000 to carry out an entire PR campaign simply by convincing clients to invest in campaigns, instead of individual assignments. Campaigns achieve better results and cost less in the long-term for clients, compared to individual assignments. Finish Your Book Already! I owe the completion and success of my book to a big cardboard box that saw me through the entire process. I found this box and filled it with any and all information I could find on my topic 'advanced presentation skills for speakers and business presenters. Resignation Letters: Dont Let Yours Backfire On You... It turns out that "tips and templates on how to write resignation letters" is the third most sought-after information at my Writing Help Central Web site.So, when I looked into the subject more closely, I was surprised to find that there is not a lot of guidance available in guide book form on how to write a proper and appropriate resignation letter. Getting To Know Your Characters Interesting characters that readers care about are the most important 'ingredients' in your novel.That might sound like a fairly sweeping statement, but think about it. Vary Your Writing Style and Win Readers First drafts are for getting down the ideas. Anna Jacobs calls the first draft the 'dirty draft'. Do You Plot With Your Character In Mind? Creative Writing Tips -You are plotting the story. You write down what will happen, what problems will arise, what obstacles you will place so the character won't reach his goals immediately, what he's going to do to overcome these problems etc?So all these things will be happening to your character since it's his story we are telling. The Myths Of Writing: Have You Bought Into These? There is an image most people carry of the artist (think Van Gough's self-portrait, the one with his ear bandaged), working in solitude in a barren garret in a dark corner of the city. Everyday is a struggle. A Few Brief Tips to Deal with Writing Rejection What to do when you get rejected.You've just finished your book, sent out query letters and was rejected. Rules for Getting the Story Down 1. Write it fast, fix it later. Screenwriting, Screenplays, Screenwriters - Incremental Productivity When attempting to understand Creativity and Innovation, it pays to import the vast range of research and knowledge that has been accumulated in these fields - most of it is to be found in the field of Business and Management.For example, Writer's Block is intimately related to Organizational Culture - the same principles that prevent people from generating ideas in the corporate workplace are also responsible for Writer's Block - evaluation apprehension in its many forms. Italics Part 2 - Using Italics to Show Thoughts Way back in your early school years, you were probably taught to use the tag "he thought" in your stories, to tip readers off that someone was thinking. If you substituted something more innovative, like "he pondered" or "Harry deliberated", you might even have scored a big red tick. Tips On Writing A Killer Sales Letter Writing a sales letter doesn't have to be that difficult all you need is the right writing style and some tips to knock out a killer sales letterBenefits The first thing you need to do is focus on the benefits the reader will find useful. Tell the reader what's in it for him. Extreme Research: 10 Snappy Rules For Success So you want to learn to research well, and not waste any time. Let's do it. Win More Clients, Projects and Freelance Jobs By Making Three Small Changes I??ve spoken to hundreds of editors, employers, and project managers about how they choose a freelancer for a job. Whether they were reviewing job applications or considering project bids, they all had one thing in common. Writing Internal Newsletters: How to Build Your Network and Your Reputation To help build your profile and reputation within a large company create or contribute to, an internal newsletter. Your company collegues are an excellent network for you - lift your internal reputation by writing an internal newsletter that people will read. 7 Reference Books for Your Desk I hate to admit this, but I rarely get an original idea. That's bad for a writer.
|
| home | site map |
| © 2006 |
