Back to English 432/532

Revision Checklist for Instructions and Manuals[1]

Few, if any of you, will be creating pure sets of instructions, as in “How to Assemble a Bicycle,” for example.  However, most manuals or handbooks will include short lists of instructions for accomplishing specific tasks.  Therefore, some of the checklist items in Part I below may be helpful.  Part II lists revision items for manuals and handbooks.

Part I

Instructions

Does the introduction

_____  provide the purpose of the task (e.g., “to close out your money drawer” or “to make     reservations”)?

_____  describe safety measures or other important concerns?

_____  list necessary tools and materials for completion of a task or procedures?

Are the instruction steps

­­­­­­_____  numbered?

_____  expressed in the more direct and concise imperative mood?

·        Imperative:  Immediately contact your supervisor. (direct and clear)

·        Indicative:  You will immediately contact your supervisor. (a little wordy and indirect)

·        Passive:  The supervisor will be immediately contacted.  (wordy and also ambiguous—who should contact the supervisor?)

_____  simple and direct?

_____  supported by appropriate graphics or illustrations?

Does the conclusion

_____  include any additional important advice

_____  include, if appropriate, a troubleshooter’s guide to potential problems?

Part II

Manuals (or handbooks)

_____  Does the manual include a cover?

_____  Does the title page provide information necessary to help readers determine whether they are reading the appropriate document?

_____  Is the table of contents clear, explicit, and complete?  Does the phrasing help the audience navigate your document for the purpose of locating specific information?

Does the front matter clearly and concisely indicate

_____  the product, procedure, or system the manual describes?

_____  the purpose of the manual?

_____  the major components of the manual?

_____  the best way to use the manual (if necessary)?

_____  Is the body of the manual clearly and intuitively organized?

_____  Are appropriate graphics included?

_____  Is a glossary included, if appropriate?

_____  Is an index included, if appropriate?

_____  Is the writing style clear and simple throughout?

_____  Are appendix items included, if appropriate (e.g., forms, diagrams, maps)?