Download Manuals Development Guide

Manuals Development Guide
June 2001
Developing a Firm Writing Schedule ................................................................. 52
Preparing the First Draft .................................................................................... 53
Proofreading, Revising & Submitting the First Draft .......................................... 54
Getting the First Draft Reviewed........................................................................ 55
Preparing the Second Draft ............................................................................... 55
User Testing...................................................................................................... 56
A Third, Fourth, Fifth Draft?............................................................................... 57
The Final Version: Getting Approval................................................................. 57
8)
Designing the Peripherals
58
The Quick Reference Guide .............................................................................. 58
The Function Key/Special Key Template........................................................... 60
The Field Guide................................................................................................. 62
9)
Publishing Printed Manuals
64
Creating a Distribution List ................................................................................ 64
Binders, Covers and Spines .............................................................................. 65
Divider Tabs ...................................................................................................... 67
Ordering Production Materials ........................................................................... 69
Getting the Copies Printed ................................................................................ 70
Other Production Tips ....................................................................................... 71
Putting the Manual Together ............................................................................. 71
10)
Electronic Publishing
73
Publishing in multiple formats............................................................................ 73
MS Word 97 Manuals........................................................................................ 73
Adobe Acrobat Manuals .................................................................................... 74
HTML Manuals .................................................................................................. 75
11)
Implementation and Maintenance
80
Deliverables From the Author ............................................................................ 80
Implementing the User Manual.......................................................................... 80
Maintaining Master and Working Copies ........................................................... 82
When to Implement a Manual Revision ............................................................. 83
How to Implement a Manual Revision ............................................................... 83
Maintaining Printed Manual Supplies................................................................. 85
Post Implementation Review ............................................................................. 86
12)
Acknowledgments
87
13)
Appendix A - Manual Development Checklist
88
Before you start writing...................................................................................... 88
Writing a sample section ................................................................................... 88
Writing and Reviewing the manual .................................................................... 88
Proofread and revise first to final draft............................................................... 88
Publishing and/or Producing the Final Copies ................................................... 89
Implementing the Manual .................................................................................. 89
Maintaining The Manual .................................................................................... 89
Page 4