Include at least two (2) set of these peer-review (or document testing) sheets with your instructions.

 

Writer of Instructions:__________________                                Reviewer:____________________

 

 

Is the detail appropriate for the Audience (use a "you-attitude," consider chunking, labeling, and parallel structure to make the document reader-friendly).

 

 

 

 

 

 

Suggesstions about Organization.

 

 

 

 

 

 

 

Suggestions about Content.

 

 

 

 

 

 

 

 

Suggestions about Style.

 

 

 

 

 

 

 

Suggestions about Visual and Design elements.  

 

 

 

 

 

 

 

 

Other suggestions to make the document easier to use.

 

 


 

 

Audience

Have you told your readers the things they want to know or would find useful to know about the following topics?

q      Aim, purpose, or desired outcome of the procedure

q      Intended readers for the instructions (their knowledge level, job descriptions, etc.)

q      Scope of the instructions

q      Ways to use the instructions effectively

q      Reasons for following the instructions (rather than using some other procedures)

Also:

q      Have you told your readers about any materials and equipment they should gather before starting the procedure?

q      Have you provided all warnings needed to protect the readers from harm?

q      Have you provided all warnings needed to prevent the readers from encountering problems or missteps?

 

Organization

q      Have you grouped the steps into the major parts of the procedure?

q      Have you enumerated them?

q      Have you provided headings or other visual guidance that enables your readers to see what the major parts of the procedure are?

q      Have you included an introduction, which includes any background information the readers might find helpful?

q      Have you included a conclusion, where you summarize the major steps or offer follow-up or troubleshooting advice?

 

Content

q      Have you presented all the required steps?

q      Have you presented one action per step?

q      If you are going to provide an explanation of a step, have you described the action before giving the explanation?

q      If you are going to tell the readers what will happen as a result of some action, have you presented the result after the action?

 

Style

q      Have you used direct address, imperative voice, and the imperative mood?

q      Have you written in parallel structure?

q      Have you defined all necessary terms?

q      Is anything wordy or not specific?

q      Is all spelling, punctuation and grammar correct?

 

Visual Aids

q      Have you included all the visual aids your readers might find helpful or persuasive?

q      Are your visual aids located where they will be easy for your readers to find?

q      Are the visual and the step close together? 

q      Are they labeled and referenced?

q      Do your pages looks neat and attractive?

q      Do you use at least one level of heading?

q      Should any items be in a list form?

q      Have you included a header or footer on the second and subsequent pages?