Procedure Description

Slides:



Advertisements
Similar presentations
Create Your Own Instruction Manual. Objectives Create an instruction manual, step-by-step guide to perform a task or project. Create an instruction manual,
Advertisements

Solano College Federle, English 1
descriptions, and instructions?
WRITING INSTRUCTIONS GUIDING A READER THROUGH A PROCESS.
Writing Instructions Guiding a reader through a process.
English & Communications for College
Technical Writing: Process and Product 5th Edition
The Process Essay.
Writing User-Friendly Instructions. You’ll have 4 sets of readings World Wide Web site (click here for access)World Wide Web site an instruction checklist.
Technical Writing II Acknowledgement: –This lecture notes are based on many on-line documents. –I would like to thank these authors who make the documents.
Writing Instructions Guiding a reader through a process.
W RITING E FFECTIVE I NSTRUCTIONS AUDIENCE AND PURPOSE novice: first-time user experienced: has performed a similar task Instructions help the reader.
Writing User-Oriented Instructions and Manuals Debopriyo Roy.
The Process Essay Third Lecture.
© M. Reber 9/6/2015 Instructions Writing Step-By-Step Procedures.
Chapter 19 Writing Instructions and Manuals. Analyze your audience and purpose. Gather and organize your information. Design the document. Draft the document.
Mechanism Description Description of a tool, machine, or other mechanical device—usually with moving parts—designed to perform a specific kind of work.
TECHNICAL WRITING October 31 st, With a partner Write simple “step-by-step” instructions for sending a Kakao Talk message with a phone.
PROCESS MANUAL PROCESS MANUAL Teaching Someone to do Something.
Copyright © 2002 by Pearson Education, Inc., publishing as Longman Publishers. All rights reserved. Chapter 15 Procedures, Processes, and Specifications.
Dobrin / Keller / Weisser : Technical Communication in the Twenty-First Century. © 2008 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
© 2010 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 13 Instructions and Procedures Strategies for Technical Communication in the.
Preparing Written and Oral Reports Effective Communication in CH402.
Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.
Technical Writing 1ST Lecture.
Chapter 20. Writing Instructions and Manuals © 2004 by Bedford/St. Martin's1 Plan for Safety Writing clear safety information Be clear and concise. Avoid.
Human Factors Issues Chapter 9. Human Factors = ergonomics WWII based – military significance… … a necessary part of medical device design…
The Process Essay Summary & Essay Writing. What is a process?  A process essay explains how to do something or how something occurs.  An obvious example.
Instructions Usable instructions IDG's Dummies guides reveals how most of us feel when we read instructions: like dummies. We read and reread complex.
© 2008 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 11 th Edition John.
Writing Instructions Guiding a reader through a process.
Lecture 6: Writing the Project Documentation Part IV.
William Sanborn Pfeiffer Kaye Adkins
Human Factors Issues Chapter 8. What is Human Factors? Application of the scientific knowledge of human capabilities and limitations to the design of.
1 Technical Communication A Reader-Centred Approach First Canadian Edition Paul V. Anderson Kerry Surman
TECHNICAL WRITING October 22, With a partner Write simple “step-by-step” instructions for: - downloading Kakao Talk and - sending a Kakao Talk message.
© 2005 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 10/e John M. Lannon.
Technical Instructions. 2 Every manufactured product comes with a short instruction booklet. Common life examples include –Assembling toys –Making noodles.
Writing to Guide - Procedures Chapter 3. Relate Task to Meaningful Workplace Activities A Procedure is a step-by-step series of commands for accomplishing.
The Conclusion.  A conclusion is the last paragraph in your research paper, or the last part in any other type of presentation.
Intro to Instructions Instructions unit/Auto Time Applied Communication.
Instructions Teco-61 M. Reber 01_04. What are instructions? A form of writing that tells/teaches readers how to do something: create a product perform.
12 Steps to More Effective Instructions
Understanding definitions, descriptions, and instructions
Page Design and Elements
QuickServe Online Service Training
Writing Instructions 15 June 2015 Based upon Auburn.
Understanding Standards: Higher Course Event
Instructions and Procedures
Chapter 16 Technical Descriptions and Specifications
What is technical communication?
THE LANGUAGE OF INSTRUCTIONS or TECHNICAL WRITING
Instructions and Procedure Descriptions
GE 6757 TOTAL QUALITY MANAGEMENT
The Process Essay.
Giving instructions on how to do something
The Process Essay.
Guiding a reader through a process
Chapter 15 Technical Descriptions
Chapter 20 Instructions and Procedures
Teaching Someone to do Something
PROCESS DESCRIPTIONS INSTRUCTIONS
16: Program and Project Evaluation
Writing Instructions.
Chapter 17 Technical Instructions
QuickServe Online Service Training
QuickServe Online Service Training
Guidelines for use cases (1)
TECHNICAL REPORTS WRITING
Teaching Someone to do Something
Presentation transcript:

Procedure Description Procedure: Events that produce a predictable outcome Examples: Requesting vacation days, manufacturing an engine part, discipline for sexual harassment, balancing a checkbook A procedure description informs by helping the reader understand what happens or what should happen.

Instructions Different from a procedure description Instructions inform by explaining how to perform a procedure Examples: product manuals, assembly instructions, “how-to” instructions, assignments Instructions also persuade readers. How?

Instructions General Instructions—instructions that explain how to perform a generic procedure Specific Instructions—instructions that explain how to perform a procedure under conditions involving particular equipment, surroundings, or other such variables Trimming a hedge vs. using a 22-inch Craftsman Bushwacker electric hedge trimmer Changing a tire vs. changing a tire on a 2012 Toyota Corolla

Instructions: Components Brief introduction explaining the purpose and importance of the procedure List of materials, equipment, tools, and skills required Actual instructions: numbered, step-by-step, detailed explanation of how to perform the procedure Typically, one or more visuals for clarification Brief conclusion, if needed.

Instructions: Guidelines Use short, simple commands that start with a verb. Avoid “recipe shorthand” that omits small words such as a, an, and the. Separate steps unless closely related or simultaneous. Try to avoid more than about nine steps at a time. Use subdivisions for complicated or long steps

Example: http://www.ehow.com/how_2258249_make-ladder-golf-game.html 3. Use a T-connector to connect two more 2-foot sections of pipe, so that the T-connector is in the center of the pipes with the open end of the T-connector facing up. Do this again to make a second piece. Add 1-foot sections to either end using elbow connectors. This is the base that will support the ladder form.

Use a T-connector to connect two more 2-foot sections of pipe, so that the T-connector is in the center of the pipes with the open end of the T-connector facing up. Repeat this step to make a second piece. Add 1-foot sections to either end using elbow connectors. NOTE: This is the base that will support the ladder form.

Make the base of the ladder form. a. Use a T-connector to connect two more 2-foot sections of pipe, so that the T-connector is in the center of the pipes with the open end of the T-connector facing up. b. Repeat this step to make a second piece. c. Add 1-foot sections to either end using elbow connectors.

Instructions: Avoiding Liability Note, caution, warning, and danger Note—alerts to information that will make the procedure easier or more efficient (Blue) Caution—alerts to risk of equipment failure or damage (Yellow) Warning—alerts to possible equipment damage, serious injury, or death (Orange) Danger—alerts to probable serious injury or death (Red) ANSI (American National Standard Institute) and ISO (International Organization for Standardization)

Usability Testing Testing the effectiveness of a document (such as instructions) based on readers’ use of the document Is the document useful? Does it enable users to do what they need to do? Result: Writers can improve the document based on user needs and experiences.

Guiding Principles The users (readers) drive what is “right” for instructions. What is clear to the writer may not be clear to the users. Be open to input and suggestions and resist the temptation to argue the point. Evaluate the input and suggestions and revise as needed.