Re: Quality, Documentation, and Mental Blocks

Subject: Re: Quality, Documentation, and Mental Blocks
From: "Peter Ring, PRC" <prc -at- ISA -dot- DKNET -dot- DK>
Date: Wed, 3 Dec 1997 11:21:11 +1

Steven Jong wrote:

> BLOCK #3: The quality of a document is composed of an infinite number of
> elements, making it beyond measure.
>
> I actually agree with this statement, but I apply the Pareto Principle.
> There may be an infinite number of variables or measurements, but a
> relative handful of critical ones give a good approximation of the overall
> quality.

Yes, I agree that there are some basic parameters, which are crucial
for making a good technical documentation, especially user manuals.

I have worked some years now of identifying these parameters, and I
have found a number of them. Some of them are general, some of
them depends of the readers, and some of them on the complexity of
the product. I have described them in my book, and used them in my
PQM system for measuring quality on manuals. For more information,
see my website on http://isa.dknet.dk/~prc/

Greetings from Denmark

Peter Ring
PRC (Peter Ring Consultants)
- specialists in user friendly manuals and audits on manuals.
prc -at- isa -dot- dknet -dot- dk
http://isa.dknet.dk/~prc/
- the "User Friendly Manuals" website with links, bibliography, list
of prof. associations, and tips for technical writers.

http://www.documentation.com/, or http://www.dejanews.com/



Previous by Author: Re: Embedded graphics
Next by Author: Tip of the month December '97 uploaded
Previous by Thread: Re: Quality, Documentation, and Mental Blocks
Next by Thread: Re: Quality, Documentation, and Mental Blocks


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

Sponsored Ads


Sponsored Ads