ensuring the quality of documentation

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.
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-


Previous by Author: Re: Do X-rays Damage Disks?
Next by Author: Kernighan and Ritchie notation contentions
Previous by Thread: portfolios--survey report
Next by Thread: short survey on software use


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


Sponsored Ads