instruction

WRIT 121: Introduction to Technical Writing Unit 2: Instructions with graphics

Draft Due: Friday, Feb. ,9 for peer review/usability testing Final Paper Due: Friday, Feb. 16

Please submit your topic to me by e-mail by midnight on Friday, Feb. 2.

We will schedule Usability Testing.

Final Deliverables are due via email transmittal or Moodle by midnight Friday, Sept. 29. Final version of the instructions in Word or PDF format, named using the following convention: YourNameUnit2InstructionsWRIT121.

“One of the most common and one of the most important uses of technical writing is instructions—those step-by-step explanations of how to do things: assemble something, operate something, repair something, or do routine maintenance on something,” David McMurrey writes in his Free Online Textbook for Technical Writing (https://www.prismnet.com/~hcexres/textbook/instrux.html)

The ability to write clear, easy-to-understand instructions will help you communicate effectively in the workplace. This assignment is intended to help you develop skills to create simple, straightforward instructions.

Other requirements:

· Include an introductory section that clearly states the purpose, audience, and conditions needed to use these instructions. This section may require more than a single paragraph.

· List of materials

· Sequential steps expressed in imperative statements, with cautions and notes as needed.

· Effective, useful, original graphics, appropriately placed, labeled, and called out in the text. You are expected to create your own graphic, either (1) a drawing created using the vector based program of your choice, or (2) a digital photograph that you’ve taken and labeled using Word, or (2) a hand-drawn illustration that you’ve scanned and labeled using Word. Do not use graphics downloaded from the Internet or clip art.

· Readable, 11- or 12-point font; 1-inch margins, page numbers

· Length minimum of 2 pages, but not to exceed 4 pages

Instructions to be followed by another person are difficult to write. A reader must be clear and concise to a reader from any background. Your task is to design a set of instructions that a user can follow without asking for clarification—self-contained and self-explanatory. Assume that the instructions are to be sent out to the public in items to be purchased or mailed to the recipient. No coaching from the writers will be allowed during the peer review/testing.

You will choose your topic and write original instructions. Information contained in the instructions will be based on first-hand observation and experience. The topic can be how to do, design, make, or assemble something (eg., how to sew on a button, wire a lamp, assemble a piece of equipment, use a mechanical device). Instructions involving the following items are not permitted for this assignment: food, weapons, computer data bases/search engines, electronic devices.

Suggestion : It is difficult determine how a user will interpret, or misinterpret, what has been written. Instructions should be tested by someone not involved with preparing the instructions. Ask a friend, a family member, or a co-worker to test the instructions. Observe them while they use the instructions. Schedule at least two tests (and rewrites based on those tests) before you finalize your instructions.

Worksheet for Planning and Preparing a Set of Instructions (adapted from Technical Report Writing Today, D. Riordan

· Name the audience for these instructions

· Are they beginners or intermediates?

· What is your goal for your readers?

· Analyze the process

· Construct a flow chart that moves backwards from the end goal

· List conditions that must be true for the end goal to occur

· List unfamiliar words and terms

· List necessary materials

· Plan and construct a style sheet

· Headings

· Margins/columns

· Method of treating individual steps/substeps/cautions/notes/results, etc.

· Size and position of visuals

· Style for captions

· Convert the topic of each box in the flow chart into an imperative instruction

· Add cautions, notes, results, and substeps

· Decide on a sequence of steps or steps with substeps

· Decide where to place results of an action

· Decide where to place notes, variations, cautions, etc.

· Add appropriate visual aids

· What will you tell the readers in the Introduction?

· Purpose/goal? Yes, this is an essential content requirement.

· Definitions? Yes, a formal, extended definition is required.

· Background? Consider the reader and provide any essential info they might need to know.

· Materials? Yes, this is an essential content requirement.

· Place visuals to illustrate or show the effect of the action

Questions to consider when testing and evaluating draft instructions:

· Does the introduction explain the goal for readers?

· Does the introduction clearly provide sufficient definition/description to meet the users needs.

· Does the introduction contain all the necessary information on special conditions, materials and tools?

· Is each step a single, clear action stated in the imperative mood?

· Do all steps have all necessary information: result of the action, safety warning, notes?

· Do the steps follow in a clear sequence? Are appropriate visual aids present? (Do any steps either need or not need a visual aid?)

· Are the visual aids presented effectively (size, caption, position on page)?

· Does the page layout (white space, heads, chunks) help the reader?

Based on an assignment developed by Katherine Eccleston, MSTC, Professional and Technical Communication Department