Re: Documentation Sanity Check

Subject: Re: Documentation Sanity Check
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 9 Apr 2003 11:14:59 -0500

Recently I've been rewriting software requirements that haven't been updated since 1998 or so. In addition to testing as I go to make sure the apps work the way I think they do, I'm bouncing the requirements against the info in my help files as I go. About a day into this work, I started a file of the help topics I need to correct when I'm done with my current task. Initially, I was appalled at the volume of errors I was finding in the help; I'm now focused on finding a patsy to take the blame for mistakes that are indisputably my own doing. HA. Just kidding.

Although I haven't manipulated my help content in a different application, I have been seeing the help in a new context and it's been an eye-opening experience. Not only have I identified some long-standing errors, but I also see some things I can do differently to make the help even better than it already is.


John Posada wrote:
<snippage> question. How many of you take the data from your documentation,
massage it in a different application than what it was authored in, and if
you do, what have you found?

Do you periodically check existing content when not initiated by a change in
the subject being written about?

Purchase RoboHelp X3 in April and receive a $100 mail-in
rebate, plus FREE RoboScreenCapture and WebHelp Merge Module.
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.

Previous by Author: Re: 10 things all tech writers should do
Next by Author: TW jobs in greater NY and metropolitan NJ
Previous by Thread: RE: Documentation Sanity Check
Next by Thread: RE: Documentation Sanity Check

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

Sponsored Ads

Sponsored Ads