TCOM 2010 – Technical Writing Instructions Assignment
The main purpose of this assignment is to give you practice in writing instructions, one of the most common kinds of technical communication you will do in the workplace and in your day-to-day life. Some common reasons for writing instructions include
- specifying details of technical activities,
- describing office procedures,
- preparing training manuals,
- explaining how to operate computer programs, and
- telling your children (or adults that act like children) what to do.
An important aspect of writing instructions is using graphics and design: good instructions contain graphics and are designed to be easy to read and understand. Therefore, another important purpose of this assignment is to improve your skills in the visual dimension of technical communication.
Deliverables (3)
1) Instructions
Write a set of instructions for a simple, easily-conducted-in-the-classroom process. The topic may be almost anything, as long as the instructions can be performed in the classroom. If the process requires materials other than notebook paper, pens/pencils, or PC computers with the software already available on the classroom's computers, you are responsible for bringing the materials to class for usability testing.
Avoid illegal, unethical, and potentially dangerous topics, but try to find something interesting
You may get ideas from existing instruction sets online, but you must write your own instructions.
A complete instruction set will be at least 4 (but not longer than 7) pages of instructions and include:
- a title page;
- a table of contents;
- a brief introduction;
- a technical definition and description;
- cautions and safety notices (follow the ANSI 535.4 and/or the ISO 3864 standard, as appropriate);
- step-by-step instructions of the process;
- graphics/photos;
- you must include visual elements;
- all graphic elements must have a caption (Figure 1: Widget configuration);
- a conclusion--what the end product is;
- any relevant back matter; this can include troubleshooting information if required.
I've included a link here to my annotated sample of instructions. This is a very general sample but it will give you some ideas about how to structure your submission.
Sample Subjects
Feel free to use one of these ideas, but get permission from me first. I've seen about a billion examples of "How To Tie A Windsor Knot" and don't wish to see another as long as I live.
- creating artwork / constructing a craft
- editing pictures in Adobe PhotoShop
- creating a graphic for a written assignment
- effective monthly budgeting
- using advanced features of MS Office programs
- carving a pumpkin
- folding origami (no paper airplanes)
- coloring Easter eggs
- creating PDF documents in Adobe Acrobat
- writing a simple computer program
- creating a basic web page
- making balloon animals
- straightening/curling hair
- tying special knots in a necktie
- making no-bake food items
- publishing a website
- performing first aid or CPR
2) Usability Test Notes
Submit a legible photocopy of the notes you took during the usability testing session.
3) Reflective Memo
Write a reflective memo of 300–500 words, addressed to the instructor, in which you describe:
- the rhetorical approach you used to tailor the document to your audience;
- how your instructions changed as a result of usability testing;
- ethical issues that you encountered;
- the course goals (see the course website home page) you encountered in completing this assignment.
Explain your answers.
Submission Requirements
Hard Copy
Bring hard copies of the instructions, the usability test notes you took, and the reflective memo to class. Place the memo on top, the notes in the middle, and the instructions on bottom. Staple the documents together in the upper left corner.
Suggestions
- Have you included all three deliverables?
- Does the organization/content/design of the instructions show audience awareness?
- Are the user's tasks and goal clearly stated?
- Is the instructions' purpose clearly identified?
- Are the related safety issues included?
- Does the front matter include a brief technical description?
- Does the instructions document include an introduction, step-by-step instructions, and a conclusion?
- Are appropriate graphics included?
- Is the document design neat and professional?
- Did you answer all questions on the Usability Worksheet?
- Are the notes from the user's think-aloud testing session detailed?
- Does the reflective memo include all required elements?
- Does the reflective memo follow standard memo format?
- Are the spelling, punctuation, grammar, and editing on everything clean and professional?
- Do the instructions actually work?