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.

---

Memories Dont Fade Like Hair Does: Memoir Writing Help for You, Our Elders, to Tell Your Story

~~~Old age, to the unlearned, is winter; to the learned,... Read More

Writers can Grow to be Comfortable with Criticism

On my first newspaper assignment as a critic, I was... Read More

A Checklist For Drafting Business Letters And Emails

Write Right - You have an all important business letter... Read More

Have You Settled On First Choice When Choosing A Title?

Short Story Writing Tips -We've established what a title should... Read More

Writing Helpful Help ? A Minimalism Checklist

User documentation is all too often written by programmers for... Read More

The Demon Fear

You have a great idea for a poem, a story,... Read More

Use These 3 Editing Tips to Ensure Your Writing Hits the Bull?s-Eye

The first step in the writing process is to put... Read More

Writing Made Them Rich #5: Peter Mayle

Peter Mayle was born in England in 1939.His fascination with... Read More

Writing Dialogue That Make Your Characters Come Alive

Characters in a good novel really carry the story along... Read More

Writers Turn to the Internet for Support, Friendship and Advice

Riding on the fumes of potential, you take pen to... Read More

Write For Yourself First

It would be very selfless or noble of me to... Read More

Why I Write Horror

These are some of the snapshots I carry with me:... Read More

The Myths of Writing: Have You Bought Into These?

There is an image most people carry of the artist... Read More

Screenwriting ? The Value of Structure

Structure in the form of frameworks, work processes and goals... Read More

Unusual Points of View

Most writers are familiar with first and third points of... Read More

Does Each Element of Your Story Further The Theme?

Creative Writing Tips ?Whichever theme you choose, all the elements,... Read More

Writing from Home: It Can Be Great and Not-So-Great for Mothers

I went to school to be a teacher. In fact,... Read More

Top 7 Writers Sites for 2005

If you dream of turning your book into a best... Read More

The Blank Mind

Many writers stare at the blank page or clean computer... Read More

Open a Vein

If you want to be a writer, you must write... Read More

Writing With Power: 5 Snappy Rules For Success

Almost everyone could profit from enhancing their writing skills. From... Read More

Go With The Flow: Write With Transition Words and Phrases

One of the most common weaknesses I see in day-to-day... Read More

8 Reasons Why A Freelance Writer Should Use the Internet

What a wonderful resource the Internet is!Students find information to... Read More

How You Can Take Advantage of the Increasing Demand for Freelance Online Writers

The freelance writing market is a growing market to be... Read More

Mixing and Mingling: The Door to Publication?

Mixing and mingling with industry professionals is an opportunity that... Read More

How to Relax Your Writing

Q. My writing sounds stiff and stilted. Help!A. Memories of... Read More

Boost Your Income With Trade Journals

Why would anyone want to write for trade journals? Aren't... Read More

Vital Verbs

Remember back in the dark days of your school years... Read More

In Your Own Words

More Tips For New Writers (Part I)Explain in your own... Read More

Grow Your Ideas Without Letting Words Grow Like Weeds

Q: How do I expand on an idea without getting... Read More

That Cute Lil Ol Apostrophe

Have you ever had a student write to tell you... Read More

Publish It Now! No Matter What It Is

Do you want to publish something? An article, a non-fiction... Read More

8 Tell-Tale Signs That Forecast Writing Success!

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