Instructions Planning Guide
This guide contains requirement for this assignment and a planning process for thinking about key details of this assignment:
- Planning process
Please include a cover-sheet note or footnote describing the needs and limitations of your audience for the instructions.
For the instructions:
- To get started on this project, read the chapter on instructions.
- To test your understanding of this section, take the online reading quiz on instructions. (You can keep taking it until you get all the answers right.)
- Use this example as a model. Notice that it uses headings, notices, graphics, and imperative writing style. Use can see other examples at examples.
- Find a procedure that contains multiple tasks, phases, or both.
- If possible, look for more challenging topics than changing flat tires or engine oil or washing cars or dishes.
- Make your instructions as clear, readable, and understandable as possible. Avoid telegraphic writing style: omitting "understood" words like a, an, the, simple verbs.
- Make sure you organize your instructions and format them using the step-by-step approach.
- In the introduction to the instructions, make sure you list the main tasks or phases you're going to discuss and appropriate audience for your instructions.This is an important requirement for this assignment.
- If you are not sure about some technical details, look them up, or send out an inquiry to the open forum.
- Make sure you use the format for headings that is standard in this course.
Note: In these short assignments, do not use first-level headings; begin with the second-level, but center the title. This is another important requirement for this assignment; use at least one level of headings.
- Make sure you use the various types of lists in the standard format for this course. In particular, use numbered vertical lists as the format for the steps in your instructions whenever possible.
- Use the standard format for notices (format for notes, warning, caution, and danger notices in the standard format for this course. Make sure you use some combination of note, caution, warning or danger—correctly.
- Include at least one graphic in this writing project using the guidelines in the graphics chapter. If this is a problem, just insert a textbox at each point you want a graphics and provide a brief description of the graphic you would have used. Use the format that is standard for this course (for example, standard labels, titles, cross-references).
- On the first page of the document, include a brief note describing the audience of your instructions. Indicate information about the skill or knowledge level of your audience, and other details that affect how you develop your instructions. Another important requirement. It should have the level of detail similar to this audience note for a set of instructions:
Note to Instructor: These instructions are intended for individuals who want to view their digital photographs on a TV using a DVD player by creating their own slideshows. They understand how to download photos from cameras or the Internet and can put photos into files on their PC. They are comfortable using Windows software and moving back and forth between windows. They may also know how to copy music from a CD or download from online sources, but the music aspect of the slideshow is optional. They are familiar with various file types such as .jpg and .wav.
- Indicate the source of any information you borrow using the guidelines provided by the documentation chapter.
- As with all writing assignments in this course, use the standards of good writing style, grammar, punctuation, usage, and spelling. Of course!
- This assignment should be a minimum of 2 pages.
- Name your file with your handle and _instrux, for example, davidmc_instrux.docx.
Caution: Keep a safe copy of this and all other assignments. If you do not receive confirmation of receipt from your instructor, doublecheck with your instructor.
Before you turn this writing project in, scan it for these errors which you studied at the beginning of semester:
- Comma splices
- Pronoun-reference agreement
- Introductory element commas
- Compound sentence commas
- Compound predicate commas
Remember that errors in the list will cause unfortunate problems with your grades.
Use this planner to define the key details for your instructions (it is not required). When you are through, you can e-mail this planning information to yourself (and to your instructor, if you wish).
Maintained by firstname.lastname@example.org.