Writing Project: Instructions

Develop one of the most important applications of technical writing—instructions. Learn planning and formatting strategies for this bread-and-butter application.

Objectives

When you finish this unit, you'll be good at:

• Distinguishing between imperative, passive-voice, and second-person writing.
• Using the provided notice guidelines to label and format notice text correctly.
• Using vertical lists correctly according to the provided list guidelines.
• Clearly, concisely explainong how to perform procedures.
• Providing illustrative graphics to facilitate reader performance of instructions.

Readings

Instructions in the Online Textbook

If your instructions involve computers in some way, use these resources:

Highlighting
Notice logos

Practice: Headings and Paragraph Styles

In this practice, study the design of headings and then design your own for some text without headings.

1. Read the chapter on headings and the chapter on Microsoft Word paragraph styles.
2. Go to this link for practice text and instructions on designing headings for it.
3. Copy the text above into an app such as Microsoft Word, and format it according to the instructions.
4. Watch this video to see how.

5. Name your file with some part of your name and _headings, for example, davidmc_headings.docx (or whichever extension your app uses).
6. Send this practice file by e-mail attachment to your instructor at davidm@austincc.edu.

Final-grade points: 2

Practice: Vertical Lists

In this practice, read about vertical lists (bulleted and numbered), and format plain text and according to a model:

1. Read the lists chapter and learn which list types should be used in which circumstances and how punctuation and capitalization should be used.
2. Use this PDF Click for more options PDF as a model.
3. Copy this plain text into an app such as Microsoft Word, and format it according to the model.
4. Suggestion: create paragraph styles: bulleted1, bulleted2. Watch this video to see how.
5. Name your file with some part of your name and _lists, for example, davidmc_lists.docx (or whichever extension your app uses).
6. Send this practice file by e-mail attachment to your instructor at davidm@austincc.edu.

Final-grade points: 2

Practice: Notices

In this practice, learn about notices and the specifications for the different types of notices, and then format chunks of text, using the correct label (note, caution, warning, danger).

1. Read the notices chapter.
2. Go to this link Click for more options this link - Alternative Formats for practice text and instructions on designing notices for it.
3. Copy the text above into an app such as Microsoft Word, and format it according to the instructions.
4. Use this video to how to format warning and danger notices.
5. Optionally, use these notice logos Click for more options Notice logos - Alternative Formats in the notices you create.
6. Name your file with some part of your name and _notices, for example, davidmc_notices.docx (or whichever extension your app uses).
7. Send this practice file by e-mail attachment to your instructor at davidm@austincc.edu.

Final-grade points: 2

Discussion Board

Instructions: Brainstorming Forum

Post here telling everybody what you're thinking about for instructions assignment. If you've still got several ideas, post them all! (Not required)

Instructions Assignment: Requirements

Final-grade points: 10

Caution: Name your assignment files with some identifiable part of your name: for example, davidmcm_resume.docx. Send files by e-mail attachment to davidm@austincc.edu; do not upload to Blackboard.

Here's a video on creating instructions. You do not have to use the free access to MS Word or OneDrive. Just pay attention to the format of the instructions.

Here are the requirements for this assignment:

• Please include a cover-sheet note or footnote describing the needs and limitations of your audience for the instructions.
• Use this example as a model. Notice that it uses headings, notices, graphics, and imperative writing style. Use can see other examples at examples.
• 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.
• Be sure to 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.
• Before you turn this writing project in, scan it for these errors which you studied at the beginning of semester:

Comma splices
Fragments
Pronoun-reference agreement
Apostrophes
Introductory element commas
Compound sentence commas

Remember that errors in the list will cause unfortunate problems with your grades.

Instructions: Planning Guide

Use these questions to define the key details for your instructions (not required):

• If you've not already done so, read the chapter on instructions.
• Be sure and take a look at these example instructions.
• Describe the topic of your instructions.
• Describe the intended audience for your instructions—who are these readers? What skills or knowledge do they need to perform the instructions.
• Explain what tasks or procedures you want your readers to be able to perform as a result of reading your instructions.
• If your instructions divide into tasks, list the tasks for which you will provide directions; if your instructions divide into phases, list the phases.
• List the equipment and supplies needed to perform these instructions.
• Describe the warning, caution, and danger notices you think these instructions will require.
• Describe the illustrations (drawings, diagrams, schematics, photos) you think you'll need in these instructions.
• If you think that these instructions will require some introductory discussion of theory, explain that in the box below.
• List the title and first- and second-level headings you'll use in these instructions.

Information and programs provided by admin@mcmassociates.io.