Addressing the key elements behind successful instructions

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

TECHNICAL REPORTS OBJECTIVE 6.01: OBJECTIVE 6.01: Explain the abilities to communicate effectively in a technical world. Explain the abilities to communicate.

Finishing Room Safety. Safety Notice - Brand Disclaimer Safety Notice The viewer is expressly advised to consider and use all safety precautions described.

Welcome to... A Game of X’s and O’s Modified from a game Developed by Presentation © All rights Reserved

The Systems Analysis Toolkit

Technical and Professional Editing Editing: A thumbnail of the Big Picture From Rude, Carolyn. Technical Editing, 4 th ed.

Writing User-Oriented Instructions and Manuals Debopriyo Roy.

Using Hand Tools. Safety Notice - Brand Disclaimer Safety Notice The viewer is expressly advised to consider and use all safety precautions described.

EMPRICAL RESEARCH REPORTS

Chapter 19 Writing Instructions and Manuals. Analyze your audience and purpose. Gather and organize your information. Design the document. Draft the document.

TECHNICAL WRITING October 31 st, With a partner Write simple “step-by-step” instructions for sending a Kakao Talk message with a phone.

Objective 6.01 Objective 6.01 Explain the abilities to communicate effectively in a technological world Technical Report Writing List the part of a technical.

TECHNICAL WRITING October 27, Instructions and Procedures Instructions explain how to perform a task in a step-by-step manner. They vary in length,

1 User Manual. 2 A user manual is a technical communication document intended to give assistance to people using a particular system A user manual is.

© 2010 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 13 Instructions and Procedures Strategies for Technical Communication in the.

Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.

Chapter 20. Writing Instructions and Manuals © 2004 by Bedford/St. Martin's1 Plan for Safety Writing clear safety information Be clear and concise. Avoid.

The Internet Writer’s Handbook 2/e Writing Instructions Writing for the Web.

Introduction to Summarizing. What is Summarizing? Summarizing is finding the key ideas and supporting details to get the “gist” of a piece of writing.

© 2008 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 11 th Edition John.

1 Technical Communication A Reader-Centred Approach First Canadian Edition Paul V. Anderson Kerry Surman

Title Authors Introduction Text, text, text, text, text, text Background Information Text, text, text, text, text, text Observations Text, text, text,

Using a Chisel.

© 2003 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 16 Adding Document Supplements Technical Communication, 9/e John M. Lannon.

Dobrin / Weisser / Keller: Technical Communication in the Twenty-First Century. © 2010 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.

.  Instructions – How to build or use something  Specifications – How a product is assembled  Procedures/protocols – how to do something (usually.

Report Writing Lecturer: Mrs Shadha Abbas جامعة كربلاء كلية العلوم الطبية التطبيقية قسم الصحة البيئية University of Kerbala College of Applied Medical.

Produce user documentation When a new computer application is implemented or changes are made to existing computer applications, documentation that explains.

1 January 31, Documenting Software William Cohen NCSU CSC 591W January 31, 2008.

Understanding definitions, descriptions, and instructions

Recommendation reports address four kinds of questions:

Recommendation reports address four kinds of questions:

Academic writing.

Instructions and Procedures

THE LANGUAGE OF INSTRUCTIONS or TECHNICAL WRITING

Document Development Cycle

Team Project 1. Use at least 4 independent variables and at least 40 data points In the beginning!) If you start with 5 independent variables you should.

Technical Writing Objective 6.01 Explain the abilities to communicate effectively in a technological world.

Using Stains, Paints, and Other Finishes

Effective Presentations

Report Writing.

TEXTBOOK EVALUATION Presented by: Mr. Abdullah Samateh Supervised by:

Preparing to Teach and Overview of Teaching Assignments

REPORT WRITING Many types but two main kinds:

Chapter 16 Communicating Research Results: Research Report, Oral Presentation, and Research Follow-Up.

Research, Writing and Presentation Task

College Entrance Essay Pre-Writing Strategies

Year 9 Extended Text Essay

Chapter 4: Job Design and Job Analysis

Giving instructions on how to do something

Research Seminar Session 7 Presenting a Research proposal By: Dr

Empirical Research Reports

TEXTBOOK EVALUATION Presented by: Mr. Abdullah Samateh Supervised by:

Process Description English 316.

Chapter 20 Instructions and Procedures

Writing reports Wrea Mohammed

Mechanism Description

Approaching the Anthology A questions

Report Writing SIT - JNTU.

Presentation skills NASC Tara Prasad Kharel.

Creating a Consulting Report

Success on the OSSLT: GRAPHIC TEXTS

Chapter 17 Technical Instructions

Conduct and Conclude an Exercise

Preparing to Teach and Overview of Teaching Assignments

-For Internal Use Only-

Technical Communication

INFORMATIONAL TEXT ENGLISH II.

THE TECHNICAL WRITING PROCESS

Presentation transcript:

Addressing the key elements behind successful instructions Hard-Core How-to Addressing the key elements behind successful instructions Source: Technical Communication Today, Richard Johnson-Sheehan

Planning Questions Who might use these instructions? Why are these instructions needed? What should the instructions include? Where will the instructions be used? When will the instructions be used? How will the instructions be used?

Addressing cross-cultural concerns Translate the text Use basic English Use icons carefully Check meanings of names and slogans

Research Elements Do background research Make observations Ask subject matter experts Use your senses Describe motion and change Collect Visuals

Introduction content elements State the purpose State the importance of the task Describe the necessary technical ability Identify the time required for completion Motivate the reader

Preparation elements List the parts required Identify tools needs Specify special conditions Discuss general hazards

Writing effective steps Use command voice State one action per step when possible Keep the steps concise Add trouble-shooting advice, notes, or tips Provide feedback Refer to the graphics

Safety information should… Describe the hazard State the seriousness of the hazard Explain how to avoid injury or damage

Conclusion elements Signal completion of the task Describe the finished product Offer troubleshooting advice For more information… Bibliography Cut list Glossary Clean-up and use Maintanence