Re: documentation checklist or style guide

Subject: Re: documentation checklist or style guide
From: "Prabhat N R" <prabhatr -at- aztec -dot- soft -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 18 Mar 2003 21:44:20 -0700


Hi Mark,

The choice between a checklist and a style guide depends on the nature and
the criticality of errors in the docs.

I suggest you identify the areas that are contributing to the "declining
quality levels". If they are less in number and can be fixed by just
providing a checklist, you can go ahead and create one.

On the other hand, if you need to explicitly address each of the areas in
a detailed manner, a style guide is anytime better.

HTH,

Prabhat

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here: http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
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
http://www.raycomm.com/techwhirl/ for more resources and info.



Previous by Author: Re: Fw: Problems in converting Word document to PDF
Next by Author: RE: organizing content based on logical flow of tasks
Previous by Thread: Re: documentation checklist or style guide
Next by Thread: Converting SGML to HTML


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


Sponsored Ads