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

["Gordon McLean" <Gordon -dot- McLean -at- GrahamTechnology -dot- com>]

Richard, I presume you believe you are right? 
If so, are you willing to teach the rest of us?
And if you are willing to teach us, surely all you need do is compile your
wisdom into one of your data flow diagrams that we can all access?

If not, why on earth do you keep on telling us all we are rubbish. Help us
be better! That's what the list is all about, sharing knowledge.

Gordon
 

-----Original Message-----
From: techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+gordon -dot- mclean=grahamtechnology -dot- com -at- lists -dot- techwr-l -dot- c
om] On Behalf Of Richard Lewis
Sent: 16 October 2007 23:13
To: Dan Goldstein; techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Documentation Correctness was Re: How many levels of
indentsandheads are reasonable?

I spend alot of my time creating data flow diagrams to tie together
disjointed and incomplete requriements and tech specs.  I am by no means
perfect, however, the difference before and after is usually profound.
   
  But think about it:  I am stating that nobody in the TW acedemic or
industry communities knows about or is willing to admit to what is key to
success in creating quality docs - especially for larger scale systems.  Ya
have to admit to it, either I am right and the world is wrong, or vice
versa.  
   
  Sorry, no samples.
   
  Generic Richard


____________________________________________________________________________________________________
This email (and any attachments) is private and confidential, and is intended solely for the
addressee. If you have received this communication in error please remove it and inform us via
telephone or email. Although we take all possible steps to ensure mail and attachments
are free from malicious content, malware and viruses, we cannot accept any responsibility
whatsoever for any changes to content outwith our administrative bounds. The views represented
within this mail are solely the view of the author and do not reflect the views of the organisation
as a whole.
____________________________________________________________________________________________________
Graham Technology plc
Registered in Scotland company no. SC143434
Registered Office India of Inchinnan, Renfrewshire, Scotland PA4 9LH
                                                
http://www.grahamtechnology.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.