Documentation Correctness was Re: How many levels of indents and heads are reasonable?
Ned Bedinger
doc at edwordsmith.com
Tue Oct 16 12:59:12 MDT 2007
Richard Lewis wrote:
> Raj Machhan <raj.machhan at gmail.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.com
More information about the TECHWR-L
mailing list