A Program for Improving Documentation

Abstract

The Communication Design Center of Carnegie-Mellon University undertook two projects for the Systems Division of Allen-Bradley: 11) A management study of the Allen-Bradley manual-writing process, which addressed problems with the content and presentation of information in manuals, training of technical writers, enforcement of document tracking and style guidelines, and needed critical documentation. 2) A Handbook for Manual Writers. The Center helps Allen-Bradley with quality control in the manual-writing process by assigning reviewers to sample additions or revisions. Allen-Bradley manuals carry the seal of the Center to attest to the procedure established for drafting, testing, and editing those manuals (but not to the readability of any particular manual).