RE: Unique Documentation

Subject: RE: Unique Documentation
From: Richard Lewis <tech44writer -at- yahoo -dot- com>
To: Lauren <lt34 -at- csus -dot- edu>, 'wawelsmok' <wawelsmok -at- o2 -dot- pl>, techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 5 Oct 2007 10:35:39 -0700 (PDT)

Lauren <lt34 -at- csus -dot- edu> wrote:

What happened here is that "Richard" once again postulated his lame claim
that DFDs are the be-all and end-all of technical writing,

Generic Richard:

What I have stated is:

* Structured writing is the key skill set of a technical writer.

* Structured writing, minor formating issues aside, is really all about analysis. That is that it is about coming up with a properly structured understanding of the functionality of the product, and then letting that understanding guide the writing process.

* There ain't no better way of doing a structured analysis than with structured systems analysis (i.e., data flow diagrams).

Lauren Stated:

yet he never relates his claim to industry-accepted standards of documentation,

Generic Richard:

Your right . The industry-accepted standards lack the necessary rigor. In task analysis proper id of the interrelationships between essential tasks is the lithmus test of completedness. Only data flow diagrams offer this.

Lauren Stated:

nor does he support his claim with a validly supported argument

Generic Richard:

If you want me to quote the experts, from what I see, I am the only remaining person who is aware of the unique benefits of data flow diagrams. There used to be others, but, as one writer confideded to me, the "politics" got too heavy.


In my 17 years documentation career, I have never seen in person, nor used a DFD

Generic Richard:

I never said that DFD are popular. I fact, I have often stated the opposite.


and I now
run my own business that I built with my documentation career. So from
experience, DFDs are pointless.

Richard Lewis:

Make that from your experience.


Unfortunately, your valid question kinda got lost in the crossfire. I am
also interested in an answer to your question; however, your question was
really vague, so some clarity or at least specifity of what you meant by
"software documentation" may yield better results.

Generic Richard:

If someon asked me a question, I am at a loss as to what it is. If the people who swore in emailing me or who in any way implied a false acqusations about me asked me a question, they are not going to get an answer.

Be a better Heartthrob. Get better relationship answers from someone who knows.
Yahoo! Answers - Check it out.

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.

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

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

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 for more resources and info.


RE: Unique Documentation: From: Lauren

Previous by Author: RE: Unique Documentation
Next by Author: Re: Unique Documentation
Previous by Thread: RE: Unique Documentation
Next by Thread: RE: Unique Documentation

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

Sponsored Ads