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.

---

Writing Short Info Reports

People want information, they want it quick, frequently in short... Read More

Write Your Way To A Better Brain

Boost Brain Power Through WritingHave you ever noticed what happens... Read More

Discover the Writer Hiding Inside You

Has the thought run across you mind that you might... Read More

To Transcribe or Not To Transcribe Interviews?

11 Secrets from an Experienced InterviewerOne of the unwritten rules... Read More

8 Tell-Tale Signs That Forecast Writing Success!

'Talent is cheaper than table salt. What separates the talented... Read More

Should You Hire a Ghostwriter?

Have you heard the term 'ghostwriter' and wondered what they... Read More

5 Ways to Break the Story Spell

You sink back into your favourite chair with a new... Read More

Frequently Asked Questions from Writers

1. What Is A Premise?A premise is the point you... Read More

3 Quick and Easy Ways to Generate Story Ideas

There are many ways you can generate ideas you can... Read More

New Year Resolutions for Writers - The Best Kind to Make and How to Keep Them

On the first day of a bright and shiny new... Read More

Who Said That? Making Dialogue Crystal Clear

Recently, I was hunting for a book that would simply... Read More

Finish Your Book Already!

I owe the completion and success of my book to... Read More

Dont Make This Huge Writing Mistake!

You can create a great headline, a dynamic first sentence,... Read More

Top Ten Tips (Part 1)

The following rules are essential if you want people to... Read More

How to Write Articles, Reports, and Books Quickly

Do you have trouble getting your thoughts and ideas down... Read More

Pairs/Groups Of Words Often Confused - Part 4 of 6

LATER, LATTERLater means afterwards; latter is the second of two... Read More

Effective Collaboration - Working With Your Ghostwriter

Using a ghostwriter to craft your free reprint articles and... Read More

Writing Without Style

Style manuals are all well and good, and in fact,... Read More

Starting a Freelance Writing Career (or How I Sifted Through the Muck and Found My Way)

So, the decision is final. I am a writer.Actually, I... Read More

Five Tips to Find More Time for Your Writing Life

When I asked new ezine subscribers, "What is your Number... Read More

How To Cut the Clutter and Win Readers

Most of us hate housework.Nevertheless, even the most hopeless slobs... Read More

Freelance Writing: A Career From Anywhere

An island in the Mediterranean. A beach in Africa. The... Read More

Learning to Question Your Elephant Child: Who, What, Where, When and Why

Having problems writing? I don't know why. San Francisco Chronicle... Read More

Check Your English Grammar With This Easy Technique

As an International language, English has been used widely in... Read More

Have You Plotted Your Story Before Writing It?

Creative Writing Tips ?The writer, who doesn't have the time... Read More

5 Effective Web Writing Tips

Writing for the web is very different from writing for... Read More

Overcome Writers Block with Snake Dancing

Writer's block! Even columnist Dave Berry has it. He admits... Read More

Six Tips for Submitting Fiction - if you want it to get published

You can learn a lot about what it takes to... Read More

How To Identify Your Own Style Of Writing

This article is to help identify which style, technique or... Read More

Top 10 Tips to Complete a Creative Writing Project Without Losing Your Creativity

Have you ever started a creative writing project with great... Read More

Common Writing Mistakes - Are These Holding You Back From Writing Success?

During the years that I've been teaching writing and participating... Read More

Basic Writing Tips ? Some Controversial, All Correct

As a previous article ("Making Better Word Choices ? 4... Read More

Seven Important Lessons for Experts Who Want to Get Published

At first, I noticed that I could have written many... Read More