Instructional Manual Writing Assignment Wendy Lewis Only

Writing assignment #1 will be an instruction manual.

Instruction manuals explain to readers how to operate something or make something. Helpful resources on how to write an instruction manual include the following:

 “Instructions, procedures, and policies,” a chapter from Tebeaux and Dragga in eReserves

•   Jerz’s literacy page features a fine set of tips on writing instructions. Please click here to view the site.

•   David McMurrey has a very helpful website on writing instructions. Please click here to view the webpage.

•   Wikibooks has an excellent guide to writing instructions. Please click here to view the site.

  Requirements

  The instruction manual will include the following sections or features:

•   Title Page

•   Overview or Introduction with necessary background information such as time needed,

  skill ability, relevance, context, stage setting, etc.

•   Equipment and materials needed (as appropriate)

•   Definitions (as appropriate)

•   Instructions

o provide a graphic for steps of the instructions that need a graphico at least three graphics should be originalo graphics borrowed from other sources need to be cited in APA format o all graphics should be labeled

•   Warnings or statements of caution (as appropriate)

•   Page numbers for all pages of the manual

  In addition, please note that the manual should be single-spaced.

  Overall, chapter 10 from Tebeaux and Dragga should be read thoroughly as you begin this assignment. Different types of instructions call for different strategies. The chapter from Tebeaux and Dragga is an excellent resource in guiding your approach.

  Document Designexcellentgoodfairneeds improvementnot passingis single-spaced3 points2.4 points2.1 points1.8 points0 pointshas page numbers2 points1.5 points1 point0.5 points0 pointshas a sufficient amount of white space to allow for easy navigation3 points2.4 points2.1 points1.8 points0 pointsuses a font that is appropriate for the audience2 points1.5 points1 point0.5 points0 pointsTitleYesNo   has a title2 points0 pointsGrammar and punctuationexcellentgoodfairneeds improvementnot passingdemonstrates accurate word forms5 points4 points3 points2 points0 pointsdemonstrates accurate sentences5 points4 points3 points2 points0 pointsdemonstrates accurate punctuation5 points4 points3 points2 points0 pointsOverview or IntroductionExcellentGoodFairNeeds ImprovementDoes not passProvides a description of the specific task or procedure that will be explained. The strategies described in the McMurrey resource or other resources are used in writing the introduction4 points3.2 points2.8 points2.4 points0 pointsNumber of Graphicshas many graphics, and they are integrated with the list of stepshas some graphics, but more would help the reader to follow the instructionsthe reader is not able to complete the task because does not have adequate number of graphics to clearly show the reader how to follow the instruciontshas no graphics number of graphics10 points8 points5 points0 pointsNumber of original graphicshas three original graphicshas two original graphicshas one original graphichas no original graphics originality of graphics15 points10 points5 points0 pointsPurpose and clarity of graphicsExcellentGoodFairNeeds ImprovementDoes not passgraphics enhance the instructions10 points8 points6 points4 points2 pointsgraphics are clear to the reader3 points2 points1 point0.5 points0 pointsgraphics are labeled and cited (as necessary) in APA format5 points4 points3 points2 points1 pointgraphics are consistent and aligned appropriately for the document10 points8 points7 points6 points5 pointsList of Stepsexcellentgoodfairneeds improvementnot passinginstructions begin with an imperative verb8 points6.4 points5.6 points4.8 points0 pointssteps are numbered4 points3.2 points2.8 points2.4 points0 pointsthe list of steps provide clear instructions on how to complete the task10 points8 points6 points4 points0 pointsThe steps are "nested," with sub-steps listed under main steps when appropriate4 points3.2 points2.8 points2.4 points0 pointsOverall ScoreExcellent90 or moreGood80 or moreFair70 or moreNeeds Improvement60 or moreDoes not pass0 or more      

Other helpful guides on writing instructions:

 The Tech Writing Handbook by Dozuki, which is one of the resources listed in our class, has the following:

o an appendix that provides tips in writing instructions and incorporating graphics into instructions.

o chapter 6, "Photographing the process." o chapter 7, "Using Other Visuals."

 The Mayfield Handbook, which is also one of the resources listed in our class, features excellent tips on writing instructions.

o Section 2.8.3 of the handbook, Instructions and Procedures, will be particularly helpful.

 Examples of instruction manuals for you to look at:o an example of an instruction manual on setting up a VPNo a video instruction on swimming. Note how the author lists the equipment and

then proceeds to mention the steps involved. The video is over 10 minutes long. You might just take a look at the first couple of minutes to see how he lists the equipment and then proceeds to the steps.

Length:

There is no minimum or maximum number of words for this assignment. Your goal is to write coherent, well designed instructions for a user.