Chapter 19: “Writing Instructions and Manuals” Matthew Frase
Understanding the process of writing instructions and manuals Involves all the normal processes of writing a technical document
Designing a set of instructions Designing the document Readers expectations Designing the pages Excite the reader
Planning for safety Writing effective safety information Designing effective safety information Placing safety information in the appropriate location
Drafting effective instructions Drafting the title Drafting the general introduction Drafting step-by-step instructions Drafting the conclusion
Revising, editing, and proofreading instructions Should be done to all documents To ensure the readers safety and satisfaction
Drafting effective manuals Drafting the front matter Drafting the body Drafting the back matter Drafting revisions of manuals
Usability testing The goals of usability testing The basic concepts of usability testing Preparing for a usability test Conducting a usability test Interpreting and reporting the data from a usability test