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

Subject: RE: Documentation Correctness was Re: How many levels of indents andheads are reasonable?
From: Richard Lewis <tech44writer -at- yahoo -dot- com>
To: Dan Goldstein <DGoldstein -at- riverainmedical -dot- com>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 16 Oct 2007 15:13:00 -0700 (PDT)

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

Dan Goldstein <DGoldstein -at- riverainmedical -dot- com> wrote:
> -----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?



---------------------------------
Yahoo! oneSearch: Finally, mobile search that gives answers, not web links.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.


Follow-Ups:

References:
RE: Documentation Correctness was Re: How many levels of indents andheads are reasonable?: From: Dan Goldstein

Previous by Author: Documentation Correctness was Re: How many levels of indents and heads are reasonable?
Next by Author: Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable?
Previous by Thread: RE: Documentation Correctness was Re: How many levels of indentsandheads are reasonable?
Next by Thread: RE: Documentation Correctness was Re: How many levels of indents andheads are reasonable?


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


Sponsored Ads