RE: Documentation Correctness was Re: How many levels of indents andheads are reasonable?

["Dan Goldstein" <DGoldstein -at- riverainmedical -dot- com>]

> -----Original Message-----
> From: Richard Lewis
> Sent: Tuesday, October 16, 2007 10:25 AM
> To: Raj Machhan; Ned Bedinger
> Cc: techwr-l List
> Subject: Documentation Correctness was Re: How many 
> levels of indents andheads are reasonable?
> 
> It is easy to tell a TW to be correct, but, if that 
> is as far as it goes, it is nothing. Being correct 
> means having performed a rigorous analysis. Such 
> analysis is based on identifying the essential 
> tasks to be performed and, most importantly, the 
> interrelationships between the tasks. Unfortunately,
> nobody within the TW community -- either in academia 
> or industry -- has discussed this. So incorrect 
> documentation is pretty much gauranteed.
>    

Except for your own, right? I'm assuming that *your* documentation is
correct, since you are the only TW in the world (in either academia or
industry) who performs a rigorous analysis of the essential tasks to be
performed and the interrelationships between those tasks.

Got any samples for us?
































This message contains confidential information intended only for the use of the addressee(s). If you are not the addressee, or the person responsible for delivering it to the addressee, you are hereby notified that reading, disseminating, distributing, copying, electronic storing or the taking of any action in reliance on the contents of this message is strictly prohibited.  If you have received this message by mistake, please notify us, by replying to the sender, and delete the original message immediately thereafter.  Thank you.

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

Create HTML or Microsoft Word content and convert to Help file formats or 
printed documentation. Features include support for Windows Vista & 2007 
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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

Send administrative questions to admin -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/ for more resources and info.