Assignment 4: Write an Instruction Manual

 

COURSE GOALS

  1. •Demonstrate clarity, conciseness, organization, and correct grammar through technical writing.

  2. •Analyze target audiences and prepare technical writing suitable to these audiences.


OBJECTIVES

  1. •Create a manual that describes an everyday task

 

INSTRUCTION

Technical writing is any writing whose main purpose is to convey information clearly, accurately and precisely. In this on-line class, we will focus on opportunities that allow you to practice the following skills:

  1. •Select appropriate organizational formats

  2. •Improve clarity

  3. •Prepare well-organized written communication

  4. •Write authoritatively and persuasively

  5. •Design and use effective visuals

 

This week’s assignment is to write an instruction manual.  An accurate, concise, and easy to understand manual is clearly written and organized. Illustrations to accompany text are a must!

Your manual this week will be a description of how to perform an everyday task of your choosing. See examples in the classroom and check out the links for tips on writing a good manual.

Whatever the format, instruction manuals have certain standards.

  1. •Type all text.

  2. •Write clearly and concisely.

  3. •Accompany each text instruction with an illustration.

 

Remember:

Your writing reflects your organization, attention to detail, and consideration of the reader's time. In addition, your manual will leave a lasting impression with the reader (and your teacher) of your attitude towards task completion and attention to detail.

-------------------------------------------------------------------------------------------------

Activity  - Write an Instruction Manual

 

MEMO

DUE DATE: October 29, 2012
TO: Technical Writing Students
FROM: Helen Haberman, Instructor
SUBJECT: Writing an Instruction Manual

Background

Technical writing is any writing whose main purpose is to convey information clearly, accruately and precisely. In this on-line class, we will focus on opportunities that allow you to practice the following skills:

  1. •Select appropriate organizational formats

  2. •Improve clarity

  3. •Prepare well-organized written communication

  4. •Write authoritatively and persuasively

  5. •Design and use effective visuals


Assignment (40 points)

Read Technical Writing Tips for Writing Instructions

Read tips about how to write directions that are clear, concise and well-organized in How to Write Better Instruction Manuals.

Design a technical manual that describes a simple procedure you do each day (i.e. brushing teeth, turning on/off an alarm clock, operating a microwave, using a bike lock, etc.). Your “manual” must include pictures/diagrams and captions for each direction or description. Please see student examples from previous classes, available in the classroom.

Include the following information in your manual:

  1. •Introduction - Include:

    1. ◦Why should we know how to do this activity?

    2. ◦What will you tell us in the manual?

  2. •Body - Describe in step-by-step detail how to accomplish the everyday task you chose. Use clear language AND have a corresponding graphic/picture with each step's description. See examples in the classroom for help.

  3. •Format - You can get creative here. Use a brochure format or textblocks and pictures laid out on one 8.5 x 11 inch paper. Add color if possible. Do NOT submit your manual in essay format without graphics!

  4. •Conclusion - Include a conclusion that sums up your manual. This may include trouble-shooting tips, a recap of the most important information in your manual or what you hope readers learned from your words.

  5. •Examples: see Helen's examples in the classroom...there are some classics!

 

Procedure

Use the links to review examples of manuals and get tips and see examples in the classroom.

Assess these examples in terms of clarity, precision, organization and overall effectiveness.

Write your manual as per the directions above. Be sure to use a word processing program and print out the directions in your manual. Hand drawn pictures to accompany the text are O.K. All manuals MUST include illustrations.

Use an appropriate and attractive format for your manual.

Proofread your work.

Correct all grammar, punctuation and spelling errors.

Deliver a printed copy of your finished manual to your in-folder.

Evaluation

Your manual will be evaluated on the following criteria:

  1. •All required sections are included and are complete (25%)

  2. •Directions are clear, easy to understand and well-organized. They are accurate. (25%)

  3. •Graphics/ pictures are included and there is evidence of effort in these. (25%)

  4. •Absence of a, or spelling errors (15%)

  5. •Use of an appropriate and attractive format (10%)

Help

If you have questions about this assignment, send them to haberman@4j.lane.edu.