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:ensuring the quality of documentation From:scot <scot -at- HCI -dot- COM -dot- AU> Date:Wed, 2 Aug 1995 09:53:40 +1000
> :Pierre Goulet (gouletp -at- entrust -dot- com) wrote:
> :: "..the supporting User Guide must be at a "certain level" otherwise
> :: the product will not be accepted."
> :: My question is not "How do I go about measuring the quality of a
> :: document." My question is "What wording do I put in the contract
> :: to ensure the User Guide I get with the software is good?"
You might like to have a look at AS/NZS 4258 "Software user documentation
process" which is a standard that is designed to be called up in a contract.
It isn't prescriptive - it doesn't tell you what a 'quality' document looks
like, but is a "Process Standard" that broadly documents the documentation
planning process. There is an appendix "Calling the standard from a
contract". I understand this standard is going to be put up to ISO for
consideration there.
It is available from Standards Australia, 1 The Crescent, Homebush NSW 2140
Australia.
If you want more info you can email pcohen -at- hci -dot- com -dot- au, Phil was the chairman
of the standards committee that produced it.
ciao, scot.
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
HCI Consulting, GPO Box 4846 Sydney NSW 2001 Australia. http://www.hci.com.au/management/
I claim to speak only on my own behalf.
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-