TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
