Chapter 19: “Writing Instructions and Manuals” Matthew Frase.

Slides:



Advertisements
Similar presentations
“How to” Writing to Explain Instructions
Advertisements

Criteria for writing a user manual User manual components
Writing an action research report
Writing. Writing Process Prewriting Drafting Revising Editing/Proofreading Publishing/Presenting.
Welcome to... A Game of X’s and O’s Modified from a game Developed by Presentation © All rights Reserved
Writing a Research Report Complementary Material for Marketing Research by Burns and Bush 1 Copyright © 2010 Pearson Education, Inc. Publishing as Prentice.
 Format Instructions: ◦ Margins=1 inch ◦ Font=Times New Roman  Be sure font matches research paper font ◦ Font Size=12 pt. ◦ Double-space body ◦ Indent.
Writing Formal Reports
Technical and Professional Editing Editing: A thumbnail of the Big Picture From Rude, Carolyn. Technical Editing, 4 th ed.
Final Report Document. Format Title Page Executive Summary Table of Contents Introduction Mission Statement Main PDS items Brief justification of the.
Chapter 15 Conducting & Reading Research Baumgartner et al Chapter 17 Writing the Research Report.
Technical Documents: Types and Standards Week 6 Technical Communication Fall 2003, DAHMEN.
Introduction to Technical Writing. Why Technical Writing? In industry, 20-40% of your time will be writing Career advancement People judge by communication.
7 Explaining a Process: Cultures &Traditions. 2 2 Learning Outcomes Identify real world applications for explaining a process in writing. Understand the.
Writing User-Oriented Instructions and Manuals Debopriyo Roy.
Chapter 19 Writing Instructions and Manuals. Analyze your audience and purpose. Gather and organize your information. Design the document. Draft the document.
Gerson & Gerson: Technical Writing, 5th Edition© 2006 Pearson Education, Upper Saddle River, NJ All Rights Reserved. 1 Chapter 17: Proposals This.
Copyright © 2002 by Pearson Education, Inc., publishing as Longman Publishers. All rights reserved. Chapter 15 Procedures, Processes, and Specifications.
Laws of Life Essay: FINAL DRAFT INSTRUCTIONS. When preparing your FINAL DRAFT, please do the following: 1.After making all corrections, print one final,
Dobrin / Keller / Weisser : Technical Communication in the Twenty-First Century. © 2008 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
Manuals, Instructions, and Guides (oh my!) The Different Documents  Instructions  Help reader perform a specific task  Process Instructions  Narrative.
Chapter 14. Writing Definitions, Descriptions, and Instructions © 2013 by Bedford/St. Martin's1 What are definitions, descriptions, and instructions? A.
PREPARING REPORTS CoB Center for Professional Communication.
Chapter 20. Writing Instructions and Manuals © 2004 by Bedford/St. Martin's1 Plan for Safety Writing clear safety information Be clear and concise. Avoid.
Testing Drafts for Usability and Persuasiveness Paul V. Anderson’s Technical Communication, 6 th ed.
Ch3 – Usibility During the Planning Stages Melek OKTAY (Ceng-bilm 403)
1 Business Communication Process and Product Brief Canadian Edition, Mary Ellen Guffey Kathleen Rhodes Patricia Rogin (c) 2003 Nelson, a division of Thomson.
Building Critical Thinking and Academic Writing Skills Assignment 4: Synthesis/Analysis Paper.
Chapter 19. Writing Recommendation Reports © 2010 by Bedford/St. Martin's1 Recommendation reports address four kinds of questions: What should we do about.
© 2008 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 21 Technical Descriptions and Specifications Technical Communication, 11 th.
©2011 Cengage Learning. All Rights Reserved. May not be scanned, copied or duplicated, or posted to a publicly accessible website, in whole or in part.
RESEARCH PROJECT Everything you need to know, but are afraid to ask!
The Essentials of Technical Communication Highlights from: Chapter 2: Writing for your readers Chapter 7: s, Memos, and Letters.
© 2005 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 22 Instructions and Procedures Technical Communication, 10/e John M. Lannon.
Copyright © 2012 Pearson Education, Inc.. Chapter 6 Technical Descriptions, Specifications & Definitions Copyright © 2012 Pearson Education, Inc.
© 2008 Pearson Education, Inc., publishing as Longman Publishers. 1 Chapter 3 Delivering Usable Information Technical Communication, 11 th edition John.
4 © 2005 Thomson South-Western THE WRITING PROCESS TECHNICAL WRITING FOR SUCCESS A Process for Technical Writing Planning Drafting and Revising Copyediting.
COMMUNICATION EFFECTIVE WRITING. Plan Prepare Perform Present.
Dobrin / Weisser / Keller: Technical Communication in the Twenty-First Century. © 2010 Pearson Education. Upper Saddle River, NJ, All Rights Reserved.
Standard Manual Content and Bookmarked PDF’s Dr. Lam TECM 4250.
Sharing responses to a story... Response to Literature In a response to literature, you can share your interpretation of a piece of literature. You may.
5 Paragraph Essay.
In Concert: An Integrated Reading and Writing Approach by Kathleen T
Communi-cating your research
Formal Analytical Reports
The Writing Process Spiral: pg
“How to” Writing to Explain Instructions
Writing the Textbook External Feature Analysis Paper
Front Matter and End Matter in Long Documents
Chapter 18 Formal Reports
Highway Safety Manual The purpose of the HSM is to provide the best factual information and tools, in a useful and widely accepted form to facilitate roadway.
Preparing your final draft
Technical Report Writing
Technical Communication, 9/e PowerPoint prepared by Jimidene Murphy
Conducting Reader-Centered Research
“How to” Writing to Explain Instructions
TECHNICAL WRITING – THE BLENDED LEARNING INITIATIVE
مناهــــج البحث العلمي
Writing Careful Long Reports
Chapter 1: Introduction
Superstructures REPORTS
Nationella provet – some good advice!
Understanding Types of Formal Reports
Introductions and Conclusions
Technical Descriptions, Specifications, and Marketing Materials
Title Introduction: Discussion & Conclusion: Methods & Results:
“How to” Writing to Explain Instructions
“How to” Writing to Explain Instructions
Creating Reader-Centered Instructions
Presentation transcript:

Chapter 19: “Writing Instructions and Manuals” Matthew Frase

Understanding the process of writing instructions and manuals Involves all the normal processes of writing a technical document

Designing a set of instructions Designing the document Readers expectations Designing the pages Excite the reader

Planning for safety Writing effective safety information Designing effective safety information Placing safety information in the appropriate location

Drafting effective instructions Drafting the title Drafting the general introduction Drafting step-by-step instructions Drafting the conclusion

Revising, editing, and proofreading instructions Should be done to all documents To ensure the readers safety and satisfaction

Drafting effective manuals Drafting the front matter Drafting the body Drafting the back matter Drafting revisions of manuals

Usability testing The goals of usability testing The basic concepts of usability testing Preparing for a usability test Conducting a usability test Interpreting and reporting the data from a usability test