An important task for technical writers is producing instruction materials that assist expert and novice users with technology. However, clear, concise, helpful instructions are extremely hard to produce. Many technology users have given up on reading instructions altogether and instead try to operate technology without explicit instructions, with varying rates of success.

Project Prompt and Summary

This assignment asks students to choose a specific technical object or process they know well and write instructions for its use. The instructions can be over one complex process or the general use of the item. Writing software instructions is recommended for this project because screen captures make serviceable, easy-to-produce graphics. Choosing easy to access (or, better yet, free) software will also make the peer review more productive because students will perform usability tests on one another's instructions. However, students may choose computer hardware, mobile phone technology, etc. Students will produce two sets of instructions: one for experienced users and one for novice users. Both sets will be clear, concise, helpful, user-centered instructions that use words and graphics to assist the appropriate audience. Both sets of instructions will carefully and respectfully consider audience experience, expectations, knowledge, competency, and vocabulary. Documents are expected to be in a size other than 8.5 by 11 unless there is a necessary reason for them to be so.

Steps

Step One: Project Proposal

Write a blog post that describes in detail what object or process you have selected for this project. Include exactly what the object or process is and what your instructions will cover. Also explain why your instructions are legitimate and necessary, and why you are qualified and credible to write about this topic. Then identify your two separate audiences and how they differ. What are the needs, expectations, values, and concerns of each? Lastly, include ideas for possible graphics that can be used and layouts you will employ for your instructions. Post (attached to a blog) by Friday of Week Seven.

Step Two: Sample Graphics and Thumbnails

Sample Graphics
Using the principles from Chapters 24 and 25 of The Thomson Handbook, design rough drafts of graphics for your instructions. Graphics could be screen captures, photos, drawings, illustrations, etc. Post your sample graphics to your blog as attachments. Include at least two graphics. Though these graphics are drafts, they should be substantial and near completion for this step.

Thumbnails
Using the drawing function in Microsoft Word (or another program that is familiar), students should prepare a thumbnail sketch of each instruction set (novice and expert), convert the file to .pdf, and post it to their blog (some examples will be provided). Thumbnails should identify colors, typefaces, and other design elements the instructions will employ. They should also indicate the dimensions of the documents as well as other important physical features. Post (attached to a blog) by Friday of Week Eight.

Step Three: Rough Drafts and Usability

Turn in rough drafts of both sets of instructions by attaching them to a blog post in .pdf format. Rather than traditional peer review, students will create usability tests (described in Technical Communication Today and discussed in Instructor Blog #6) that their fellow students will complete. Usability testing focuses explicitly on the documents' usability in the real world. These tests should be attached to the blog post with the instruction set drafts. The body of the blog post should describe the instruction sets, the key (and concrete) distinctions between an expert and novice user, and how each set differs to account for each audience. It also should describe the basics of the corresponding usability test and how you wish to receive feedback (a completed survey email, a summary posted as a comment, etc.) Students should consult the handout "Eliciting Good Responses" as they compose this blog post. Post by Friday of Week Nine. Usability Testing is to be completed by Monday of Week Eleven.

Step Four: Final Drafts

Post final drafts of your instructions in .pdf format as attachments to a blog. If it would not make sense to put your instructions in .pdf format—for example, if you produce online instructions—please contact your instructor before the due date. Instructions should comply with the grading criteria described below. Post (attached to a blog) by Friday of Week Eleven.

Step Five: Project Assessment Document

As you near the end of your work on the Instructions Project, prepare a two-page overview and analysis of your deliverables and the process you used to produce them. A handout will be provided to help guide the document. Your Project Assessment Document should reflect on what you learned during this assignment and how you will apply that knowledge later. Post (attached to a blog) by Monday of Week Twelve.

Grading

The Instructions Project is worth 25% of the course grade. The breakdown for each of its components is as follows:

• Proposal – 10%
• Sample Graphics and Thumbnails – 10%
• Rough Drafts and Usability Testing – 20%
• Final Drafts – 50%
• Project Assessment Document – 10%

Grading Criteria

In grading, the instructors will consider the following criteria:

• Each set of instructions includes appropriate words and graphics to assist readers, and is an appropriate length to cover all necessary information.
• Words and graphics complement one another in describing technology use to targeted audiences.
• Instructions include all basic features included in Chapters 19 and 20 of Technical Communication Today.
• Each set of instructions is clear, concise, helpful, and user-centered.
• Instructions are visually appealing, applying the four design principles found in Chapter 25 of The Thomson Handbook.
• Instructions are of a professional quality and appropriate for a professional context. If the instructions could not be packaged as is for distribution with your technology to real customers, they will not earn an A.