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.
Have you ever heard of a contract (for the purchase of software)
that contains a clause similar to the following:
"..the supporting User Guide must be at a "certain level" otherwise
the product will not be accepted."
What is a "certain level"? Well, the User Guide (and its index) must
be complete, easy to read, and technically correct, etc.
This becomes the old problem of measuring the quality of a document.
I think the best way is to conduct a usability test. But that's the
point of my question.
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?"
