Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable?

[Ned Bedinger <doc -at- edwordsmith -dot- com>]

Richard Lewis wrote:
> Raj Machhan <raj -dot- machhan -at- gmail -dot- com> wrote:
>    
>   The technical document has to be correct in all aspects. But
>  isn't it understood? Can this ever be a debatable point? Wasn't this the first
> thing that is told to each and every writer.
>    
>   Richard Lewis responds:
>    
>   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.
>    

To paraphrase the bard, "Ach!"


I don't want to get tangled up in the religious wars that attend 
discussions that begin with religious suppositions about what is or 
isn't rigorous analysis, Richard.


But that said, still and in general, you're right :-)


Ned Bedinger
doc -at- edwordsmith -dot- com

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

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.