Re: Thank God for good documentation

Subject: Re: Thank God for good documentation
From: Gene Kim-Eng <gene -at- genek -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 25 Apr 2003 08:18:22 -0700

Or non-existant. I have used the arguement on a number of occaisions (with
varying results) that if an effort to provide documentation is not made up-front,
users and service personnel in the field will inevitably create their own, and
that the materials created in the field will be unreviewed, inconsistantly verified
and most of all, *unknown* to those in the home office. So the Colonel was
very fortunate to have had a troubleshooting guide prepared by his squadron,
and was even *more* fortunate that the document didn't contain any previously
undiscovered errors in the part that he needed. But what happens when another
squadron leader whose people *didn't* produce a similar field doc, or who did
but didn't do as good a job of it, runs into the same problem *next* week...?

Gene Kim-Eng

At 12:35 PM 4/25/2003 +0100, Martin Page wrote:

Interesting that the trouble shooting guide was "prepared by his squadron"
and not part of the document set.
It's funny how users have a way of evolving parallel document sets when the
original documents aren't useful, e.g. because not task orientated or
lacking in good trouble-shooting sections.

Last chance to order RoboHelp X3 and receive a $100 mail-in rebate, PLUS free RoboScreenCapture and WebHelp Merge Module. Offer expires 4/30/03! Order here:

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


RE:On PDF's: From: I. Ljaljicic
RE: On PDF's: From: Fiona Hurley
Re: On PDF's: From: Peter Harkins

Previous by Author: Re: Amazing
Next by Author: Re: What Would You Do with a Writer Who Can't Write?
Previous by Thread: Re: Thank God for good documentation
Next by Thread: Re: Thank God for good documentation

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

Sponsored Ads

Sponsored Ads