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:
RELATED ARTICLES
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.
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.
How To Cut the Clutter and Win Readers
Most of us hate housework.Nevertheless, even the most hopeless slobs amongst us would agree that we love having a clean, organised house.
A New Way To Self Publish
More and more good authors are turning to the Internet to self publish. There are several reasons for that.
How to Catch the Writing Bug
----------------------------------------------------------Permission is granted for the below article to forward,reprint, distribute, use for ezine, newsletter, website,offer as free bonus or part of a product for sale as longas no changes are made and the byline, copyright, and theresource box below is included. ---------------------------------------------------------- How to Catch the Writing Bug By Stephen Bucaro If you earn income as a writer, or use writing as amarketing tool, you know how difficult it can be at timesto write.
Creating a Writing Space
It's important to have a space set aside in your home for writing. It can be a big cushion in a corner of your closet with a notebook and pen, if that's all you have room for, or perhaps the back seat of your car because that's the only place you can get some peace and quiet, but it should be all yours, waiting for you whenever it's time to write.
Dialogue Tags - A Study in Common Errors
Verb and SubjectIncorrect:"I bet you two had a fine time," said Ben.When using tags, it's unusual to have the verb before the subject.
How to Build A Success Freelance Career (Part 1)
In the current job market, many editorial workers have turned to freelancing as a matter of survival. I receive many queries from applicants regarding how to go about freelancing.
How to Write a Holiday Tale that Isn't a Turkey
When we write stories, with the purpose of sharing them with others, we enter into an agreement where we allow our reader to see a glimpse of our heart, our souls and our memories. If we truly want them to be immersed in the tale, we actively immerse ourselves in those memories so that a glimmer of what we saw, heard and felt comes through.
Money Trails for Writers
I'm willing to bet that quite a number of you once had to debate (or discuss) the saying: "The pen is mightier than the sword." If you were arguing 'for', you would have been able to come up with many examples of how words triumphed over muscles.
Write On! - Key Components of Successful Business Communication
Written communication is often the first impression you make on potential customers, business partners, or employers. Because of its significance to your marketing message, it is one of the most important aspects of your business.
Get Rich Writing With Your Computer Word Processor
Your computer is a writing machine, a word processor, a desktop publishing system that can make you rich and famous. The big seller on the internet is information products and you can get a flood of cash pouring into your home office from you writing.
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.
Knock-Out Writers Block: Listening To Your Inner Voice
When I was young, I used to talk to myself. Long, drawn out, one-sided conversations.
Overcome Writers Block with Snake Dancing
Writer's block! Even columnist Dave Berry has it. He admits that at least 30 times a day when writing his humor column, he gets up from his computer to sip his Pepsi to divert his attention when he can't think of what to write.
A Plan
All writers should use a plan whether written or reflected. This includes the initial idea, the content or main points, and the conclusion whether it is an article, a short story, a chapter, or a complete novel.
Writing For Free: When & When Not to Do It!
Right off the bat, I want to say that there is no right or wrong answer to this topic. A lot depends on your end goal - to get a job, garner publicity, build a portfolio, etc.
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.
Turbo-Charging Your Writing Career - 6 High-Yield Strategies
Hands up all those who'd like to have a successful writing career.(What's that you say? What do I mean by 'successful'?)All right, I know all writers are individuals.
Should You Hire a Ghostwriter?
Have you heard the term 'ghostwriter' and wondered what they do or who they work with? Although it sounds mysterious, ghostwriting is actually a very simple agreement where an individual or company hires a writer to create a work that will be owned outright by the buyer. The buyer is not required to give credit to the writer and is even allowed to claim authorship.

Home | Articles Site Map