Technical Communication Fundamentals Chapter 6 Process Explanations and
- Slides: 24
Technical Communication Fundamentals Chapter 6 Process Explanations and Instructions William Sanborn Pfeiffer Kaye Adkins Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 1 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Process Explanations and Instructions n n n Process Explanations Versus Instructions Guidelines for Process Explanations Guidelines for Instructions Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 2 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Process Explanations Versus Instructions n Process Explanations n n Provide information to help readers understand what has been, is being, or will be done Process Instructions n Show readers how to perform the process Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 3 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Process Explanations Versus Instructions Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 4 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Purposes n n Describing an experiment Explaining how a machine works Recording steps in developing a new product Describing what happened during a field test Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 5 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n n n Know Your Purpose and Audience Follow the ABC Format Use an Objective Point of View Choose the Right Amount of Detail Use Flowcharts for Complex Processes Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 6 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Know Your Purpose and Audience n n Do you need to provide an overview or specific details? Do readers understand the technical content or are they general readers? Do readers have mixed technical backgrounds? Does the description supply supporting information or is it the main part of document? Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 7 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Follow the ABC Format n Abstract n n Purpose statement Overview or list of the main steps that follow List of equipment or materials used in the process Body n n Paragraphs List of steps Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 8 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Follow the ABC Format n Conclusion n Keeps the process from ending abruptly Helps the reader put the steps together into a coherent whole Shows how the process fits into a larger context Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 9 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Use an Objective Point of View n Explain a process rather than direct how it is to be done Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 10 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Choose the Right Amount of Detail n Subdivide information for easy reading n In paragraph format use… n n n In list format use… n n headings subheadings an outline arrangement of points and subpoints Place related steps into groups Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 11 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations n Use Flowcharts for Complex Processes n Supplement a paragraph or list description with a flowchart Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 12 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Process Explanations Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 13 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n n n Select the Correct Technical Level Provide Introductory Information Use Numbered Lists in the Body Group Steps under Task Headings Place One Action in a Step Lead Off Each Action Step with a Verb Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 14 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n n n Remove Extra Information from the Step Use Bullets or Letters for Emphasis Emphasize Cautions, Warnings, and Dangers Keep a Simple Style Use Graphics Test Your Instructions Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 15 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Select the Correct Technical Level n n Select language that every reader can understand Use techniques of definition and description Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 16 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Provide Introductory Information n Follow the ABC Format n n Abstract – purpose statement Body – summary of the main steps Conclusion – list or illustration Consider the following additional items: n n Pointers Definitions Theories Notes, cautions, warnings, and dangers Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 17 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n n Use Numbered Lists in the Body Group Steps under Task Headings n n n They divide fragmented information into manageable “chunks” They give reader a sense of accomplishment Place One Action in a Step n Break up complex steps into units Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 18 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Lead Off Each Action Step with a Verb n n Remove Extra Information from the Step n n Use the command form of a verb Label with “Note” or “Result” Use Bullets or Letters for Emphasis n Save numbers for your steps n n Use bullets for a few items Use letters for several items Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 19 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Emphasize Cautions, Warnings, and Dangers n Caution n n Warning n n Possibility of damage to equipment or materials Possibility of injury to people Danger n Probability of injury or death to people Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 20 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Emphasize Cautions, Warnings, and Dangers n Placement options n n n Place in a separate section right before the instructions begin Place in the text of the instructions Place repeatedly throughout the instructions Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 21 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Keep a Simple Style n n Keep sentences short Use informal definitions Use short words Be specific Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 22 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Use Graphics n Place an illustration next to every major step when… n n The instructions or equipment are complicated The audience may contain hurried readers Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 23 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
Guidelines for Instructions n Test Your Instructions n Perform usability testing n n Team up with another class member or colleague Give this person a draft of your instructions Observe this person following your instructions Revise your instructions Technical Communication Fundamentals, 1 st Edition W. S. Pfeiffer and K. Adkins 24 © 2011 Pearson Higher Education, Upper Saddle River, NJ 07458. • All Rights Reserved.
- Fundamentals of technical communication
- Technical communication fundamentals
- Technical communication: process and product
- Examples of common sense and sociological explanations
- Arguments and explanations
- New deal political cartoons and explanations
- Bolshevik revolution political cartoon
- Evaluate the atavistic form explanation for offending
- Underwood and postman 1960
- Social releasers examples
- Situational factors affecting obedience
- Cognitive explanations of schizophrenia
- Neural explanations of offending behaviour
- Gender dysphoria biological explanations
- Outline an evolutionary explanation for partner preferences
- Diathesis stress model
- Biological explanations of aggression
- Technical and general communication
- Fundamentals of data communication
- David tse wireless communications
- Fundamentals of organizational communication 9th edition
- Fundamentals of organizational communication 9th edition
- 3 golden rules
- Bpm phases
- Fundamentals of business process management dumas