Description

Write one document containing a set of instructions, a technical description, and definitions about a technical topic. The instructions should describe how to perform an activity. The technical description should detail a process, object, or mechanism involved in the instructions. The definitions should be included as needed in the instructions. For example, if you are writing instructions to tell users how to work with a Web browser, you might also incorporate a brief description of how the browser retrieves information from the Web site and provide definitions of unfamiliar terms as part of the set of instructions.

The instructions should describe how to perform a complete activity with several major steps, as well as minor steps. Remember to include, as appropriate, the various types of information for instructions, such as cautions and warnings.

The technical description should present the process, object, or mechanism logically and understandably, if briefly. Your readers should be able to grasp the overall structure, steps, or sequence of events of the process, object, or mechanism from your technical description

The type of definitions used can be in the form of a parenthetical, sentence, or extended definition, depending on the audience and the subject of the document.

The grade on this assignment will count 15% of your final course grade. The assignment is due on January 29.

Discussion:

This assignment probably seems very complicated when you first read the assignment sheet. However, whenever you write a set of instructions, you usually need to include a technical description of a process or a mechanism as well as definitions so that the user can understand and perform the task you are writing about. For this assignment, I suggest that you focus on writing a set of instructions and then make sure you have included a technical description and definitions.

The major concern that I have with this assignment is that students have a hard time understanding what is considered plagiarism when writing their set of instructions. For this class, you are guilty of plagiarism if you copy from a set of instructions or copy graphics and do not document the use of this material. To document borrowed text correctly, you must use quotation marks around copied text, include an in-text citation, and include the document in a list of works cited. For a graphic, you must include a citation of the source either on the graphic or immediately below it.

One way to avoid problems with plagiarism is to chose a subject with which you are very familiar. It is much better to write about how to prepare a special food for your friends and family than to write about a technical topic for which you have limited first-hand information.

NOTE: In a business setting, I think this kind of writing poses many legal problems. If you have purchased a product from a company, you may be able to use some of their documentation in your company's documents, but you must get written permission first, and you should always document that use.

Tasks

• Identify and analyze the audience for your instructions.
• Plan for safety by determining what safety information you will need and where you should place it in the document.
• Draft the instructions in three parts: introduction, step-by-step instructions, and conclusion.
• Create the graphics needed for your instructions
• Add any technical descriptions or definitions that your reader will need to understand the directions.
• Use white space, typefaces, and headings and subheadings effectively to create a usable document.
• Ask a potential user to give you feedback on the instructions.
• If you want feedback on the rough draft, send a copy to the instructor as an e-mail attachment before the due date for the assignment

Length and Format

• The document should be in the form of a set of instructions.
• The minimum length for the document is three single-spaced pages, double-spaced between paragraphs, including graphics. The technical description and definitions should be included in the instructions as needed for the user to complete the task successfully.
• The document should include any graphics necessary for performing the task.
• The set of instructions should include the following elements:

  Introduction - identifies who should carry out the task, when the reader should carry out the task, the safety measures or concerns the reader should understand, and the items the reader will need.

  Step-By-Step Instructions- groups and numbers steps that are written in active voice and imperative mood (Close the door) and includes graphics as needed

  Conclusion - makes sure the reader can follow the instructions successfully by concluding with maintenance tips or a brief guide to trouble shooting

• The set of instructions should follow the basic principles of document design for effective page layout, including use of white space; use of typography; and creation of headings and subheadings.
• The instructions should include appropriate warning and safety information.
• The style of writing should be clear, active, and direct.
• Graphics should be clear and easy to understand.
• Graphics should be easily accessible to the reader.
• Graphics should have titles and labels and should be introduced and explained in the text.
• The ideas, graphics, and writing of others should be documented following MLA style guidelines for in-text citations and Works Cited

Example

Example 1 is available at http://polaris.umuc.edu/%7Enhoaglan/COMM393X/barryass5.PDF

Example 2 is available at http://polaris.umuc.edu/%7Enhoaglan/COMM393X/carolass5.PDFt

You will need Acrobat reader to view these documents.

Submission

• Submit the set of instructions as an attached file by January 29 to the WebTycho Assignments folder. If you are using Microsoft Word, you can submit your assignment as a .doc file. If you are not using Word, you can submit your assignment as a.txt (text) file or .rtf file, although some formatting and graphics will be lost when I open the file. If you have Adobe Acrobat, you can submit your work as a .pdf file. Please note that you can no longer attach .html files in WebTycho.