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.
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?"
I think you might want to investigate ISO 9000, which supposedly has
regulations and procedures for ensuring quality <yeah, right>. IBM
supposedly implemented this in their documentation, but all that I ever saw
out of it as a contractor was that they had to have inspections ahd have
tech owners sign off on everything.
Or you might want to be more precise in the specifics - grammatically and
technically correct, must be reviewed and approved by technical contacts, or
some such wording.
Or you could put the ball back in the client: what specifics do they want or
expect in the doc? Do they expect documentation of a certain set of tasks?
reference materials for a specific set of APIs?
Good luck.
--
-----
Dan 'Fergus' Roberts
droberts -at- panix -dot- com
-----
