Re: documentation checklist or style guide

Subject: Re: documentation checklist or style guide
From: Birgit Grossmann <bcg -at- bg-consulting -dot- de>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 15 Mar 2003 15:05:57 +0100



Hi Mark,

> Do you think a 2 page documentation checklist would be more useful
> than a 30 page style guide? Any suggestions?

I don't see it as this-or-that problem - they should complement each
other. A style guide is IMO necessary and usually also a kind of
example/template for the documentation. Checklists, OTOH, come in
handy to allow for a quick check-up if all necessary things are
included - probably they are even more handy for you than for the
vendors.

All the best -

Birgit

--
bcg -at- bg-consulting -dot- de
www.bg-consulting.de
Technical Writing and Chemistry
Tel. +49 421 22328-41 (Fax -42)
Mobil +49 170 5859410


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Order RoboHelp Office X3 by March 14 and receive a $100 mail-in rebate,
plus FREE WebHelp Merge Module and FREE iMarkup Software, for a
total giveaway value of $439! Order today at 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.



References:
documentation checklist or style guide: From: mark Dsouza

Previous by Author: RE: Estimating a Project
Next by Author: Re: ADMIN: Today's the day!
Previous by Thread: documentation checklist or style guide
Next by Thread: Re: documentation checklist or style guide


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


Sponsored Ads