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 of technical documentation From:"Peter Ring, PRC" <prc -at- PRC -dot- DK> Date:Wed, 10 Mar 1999 09:17:17 +1
Poppy Quintal <poppy_q -at- HOTMAIL -dot- COM> asked some days ago:
> Can anyone answer the question below from one of my colleagues? We have
> been able to come up with information on various quality methods, metrics,
> etc, but so far nothing that "specifically" allows the measurement of
> quality as a comparison between different sets of documentation.
> Any suggestions would be appreciated.
> ------------------------------------
> We are attempting to attain an accepted and proven form of measurement, if
> not an actual formula, as it relates to the "quality" of technical
> documentation. The assumption is that this "yard stick" could be a vehicle
> that will allow us to grade the quality of our technical manuals, compared
> to those of our competition. Quality, in this context, could mean
> accuracy, readability, consistency, etc. In essence, we are trying to
> acquire concrete empirical results from something quite abstract. Is there
> such a "yard stick" out there that we can use?
To my knowledge, only one formula based system "yard stick" exists: My PQM
system. It is described in my book "The PQM system ...", and the measurements
are supported by the PQM 2.3 PC-programme. For further information, see http://www.prc.dk/english/pqm-book.htm. You are of course welcome to write me
directly, too.
Greetings from Denmark
Peter Ring
PRC (Peter Ring Consultants)
- specialists in user friendly manuals.
prc -at- prc -dot- dk
- the "User Friendly Manuals" website with links, bibliography, list
of prof. associations, and tips for technical writers: http://www.prc.dk/user-friendly-manuals/
- special software for technical writers: http://www.prc.dk/software/