Previous Page TOC Index Next Page See Page

Appendix B – Checklist of Manual Development Process



_

Activity

Planning


determine type of manual needed


define objectives


identify and profile audience


determine contents and organization


prepare outline


design page layout


establish writing style guidelines


prepare sample section


define project tasks


estimate time required to complete manual


prepare schedule


prepare document plan and circulate for review


get approval to proceed

Writing


gather information


decide on methods of presentation


write and format module-by-module


circulate modules for review by subject experts and revise


identify illustrations required


create or obtain illustrations and integrate


test parts of manual which can be tested


prepare introduction, table of contents and glossary


have manual edited


circulate manual for general review and revise


prepare index


have manual approved for printing

Production


determine method of printing


prepare camera-ready copy of manual, or prepare diskette


prepare printing specifications and obtain printing quotes


have manuals printed


design covers and have artwork prepared


determine tabs required


prepare binding specifications and obtain printing quotes


have binders and tabs printed, and manual collated

Distribution and Maintenance


prepare distribution list


hold orientation sessions to introduce and distribute manuals


determine responsibility for initiating revisions


provide administrative resources to maintain manual


prepare online version of manual

Previous Page Page Top TOC Index Next Page See Page