Re: Are your documents interesting?

Subject: Re: Are your documents interesting?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Nuckols, Kenneth M" <Kenneth -dot- Nuckols -at- mybrighthouse -dot- com>, "Dick Margulis" <margulisd -at- comcast -dot- net>
Date: Thu, 12 Jan 2006 11:00:41 -0800

I have written documents where I used conversational prose, humor and even comic book illustrations in appropriate situations.

My operating procedure for loading Trident missile launchers was not one of them.

Gene Kim-Eng

----- Original Message ----- From: "Nuckols, Kenneth M" <Kenneth -dot- Nuckols -at- mybrighthouse -dot- com>

Therefore I avoid (intentional) humor in my documentation. Dick does
make a good point. If you're documenting a video game or writing a
manual for _enthusiasts_ to make repairs to a car or something (the VW
Repair manual that was cited on the list in the past couple of days
comes to mind), then humor might be entirely appropriate to put the user
at ease and keep them interested.
But when someone has to use your documentation to complete a task that
has a lot of stress, IMO the best thing you can do is present the
information with clarity, precision, and only as much additional
explanation as the user needs to complete the task. Don't waste their
time or try to be funny. That's just my personal preference.


Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author content and configure Help in MS Word or any HTML editor. No proprietary editor! *August release.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.


RE: Are your documents interesting?: From: Nuckols, Kenneth M

Previous by Author: Re: Are your documents interesting?
Next by Author: Re: complete documentation
Previous by Thread: RE: Are your documents interesting?
Next by Thread: Re: Are your documents interesting?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads