Using Inspections to Improve the Quality of Product Documentation and Code
Abstract:Improving the quality of technical documentation is not solely the responsibility of the individual writer. Through a form of peer review, known as inspections, technical writers, editors, development personnel, and customers can work as a collaborative team to create defect-free information: online help, training, and paper documentation. Inspections, begun in the 1970s to detect defects in software, can be used by writers to improve the quality of their documentation and to bring an engineering rigor and process to the job of reviewing technical product information.
Document Type: Journal Article
Publication date: August 1, 1995
More about this publication?
- Technical Communication, the Society's journal, publishes articles about the practical application of technical communication theory and serves as a common arena for discussion by practitioners. Technical Communication includes both quantitative and qualitative research while showcasing the work of some of the field's most noteworthy writers. Among its most popular features are the helpful book reviews. Technical Communication is published quarterly and is free with membership.
- Information for Authors
- Subscribe to this Title
- Membership Information
- ingentaconnect is not responsible for the content or availability of external websites