WRITER’S CHECKLIST

Parenthetical, Sentence, and Extended Definitions

  • Are all necessary terms defined?

Are the parenthetical definitions

  • appropriate for the audience?

  • clear?

  • smoothly integrated into the sentences?

Does each sentence definition

  • contain a sufficiently specific category and distinguishing characteristics?

  • avoid describing one particular item when a general class of items is intended?

  • avoid circular definition?

  • identify a category with a noun or a noun phrase?

  • Are the extended definitions developed logically and clearly?

Descriptions of Objects and Mechanisms

  • Are the nature and scope of the description clearly indicated?

In introducing the description, did you answer, if appropriate, the following questions:

  • What is the item?

  • What is its function?

  • What does it look like?

  • How does it work?

  • What are its principal parts?

  • Is there a graphic identifying all the principal parts?

In providing detailed information, did you

  • answer, for each of the major components, the questions listed above in the section on introducing the description?

  • choose an appropriate organizational principle?

  • include graphics for each of the components?

In concluding the description, did you

  • summarize the major points in the part-by-part description?

  • include (where appropriate) a description of the item performing its function?

421

Process Descriptions

  • Are the nature and scope of the description clearly indicated?

In introducing the description, did you answer, if appropriate, the following questions:

  • What is the process?

  • What is its function?

  • Where and when does it take place?

  • Who or what performs it?

  • How does it work?

  • What are its principal steps?

  • Is there a graphic identifying all the principal steps?

In providing detailed information, did you

  • answer, for each of the major steps, the questions listed above in the section on introducing the description?

  • discuss the steps in chronological order or some other logical sequence?

  • make clear the causal relationships among the steps?

  • include graphics for each of the principal steps?

  • In concluding the description, did you summarize the major points in the step-by-step description?

Instructions

  • In planning the instructions, did you consider other media, such as wikis, discussion boards, and videos?

  • Are the instructions designed effectively, with adequate white space and a clear relationship between the graphics and the accompanying text?

  • Do the instructions have a clear title?

Does the introduction to the set of instructions

  • state the purpose of the task?

  • describe safety measures or other concerns that readers should understand?

  • list necessary tools and materials?

Are the step-by-step instructions

  • numbered?

  • expressed in the imperative mood?

  • simple and direct?

  • accompanied by appropriate graphics?

Does the conclusion

  • include any necessary follow-up advice?

  • include, if appropriate, a troubleshooting guide?