Practical Models for Technical Communication

Shannon Kelley

Description

Practical Models of Technical Communication is a college-level textbook for technical writers and communicators. Written in plain and accessible language, this textbook is designed to provide students with solid tools, useful models, interesting scenarios, and a vocabulary of technical terms that will allow them to communicate effectively as part of a fast-paced, global workforce. Its approachable, real-world examples and detailed visuals guide students in creating multimodal, technical documents that reach a broad audience.

This book explores the fundamentals of technical communication, expanding on the following topics:
• Writing and organizing an array of technical documents such as definitions, descriptions, instructions, procedures, proposals, and reports
• Embracing ethical communication visually and in writing
• Designing documents for readability, emphasis, and organization
• Increasing rhetorical awareness of multimodality in all types of communication
• Researching and documenting source material effectively
• Crafting successful job materials for entering the workforce
• Communicating professionally within various work environments
• Navigating the changing needs of audiences that technical writers meet along the way

1. Introduction
2. Technical Communication Fundamentals
3. Technical Communication Ethics
4. Layout and Design
5. Multimodal and Multimedia Communication
6. Research Methods for Technical Communication
7. Job Materials
8. Workplace Communication
9. Technical Definitions and Descriptions
10. Instructions and Procedures
11. Proposals and Short Reports
12. Formal Reports
13. Make Technical Communication Work for You
14. Appendix A: MLA Report
15. Glossary Index

Sujets

• Writting
• Technical Writing
• Disciplines
• Language Arts
• COMPUTERS
• Sciences de l'éducation
• Request for proposal
• General officer
• Writing
• RFP (homonymie)
• General
• Composition

Informations

• Publié par: Chemeketa Press
• Date de parution: 21 août 2021
• Nombre de lectures: 5
• EAN13: 9781943536962
• Langue: English
• Poids de l'ouvrage: 2 Mo

Extrait

Practical Models for Technical Communication
Edition 1.0
Shannon Kelley
Practical Models for Technical Communication
2018, 2019, 2021 Chemeketa Community College
ISBN-13: 978-1-943536-95-5
All rights reserved. Edition 0.8 2018. Edition 0.9 2019. Edition 0.95 2021. Edition 1.0 2021.
No part of this book may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, without permission in writing from the publisher.
Chemeketa Press
Chemeketa Community College
4000 Lancaster Dr NE
Salem, Oregon 97301
[e-mail]
chemeketapress.org
For desk copies or ordering inquiries, contact [e-mail] .
Cover design by Ronald Cox IV
Interior design by Ronald Cox IV, Cassandra Johns, Brice Spreadbury
Acknowledgments appear on page 356 and constitute an extension of the copyright page.
References to website URLs were accurate at the time of writing. Neither the author nor Chemeketa Press is responsible for URLs that have changed or expired since the manuscript was prepared.
This textbook is made possible, in part, by a grant from John and Bobby Clyde to support faculty involvement in textbook affordability efforts.
Printed in the United States of America.
Land Acknowledgment
Chemeketa Press is located on the land of the Kalapuya, who today are represented by the Confederated Tribes of the Grand Ronde and the Confederated Tribes of the Siletz Indians, whose relationship with this land continues to this day. We offer gratitude for the land itself, for those who have stewarded it for generations, and for the opportunity to study, learn, work, and be in community on this land. We acknowledge that our College s history, like many others, is fundamentally tied to the first colonial developments in the Willamette Valley in Oregon. Finally, we respectfully acknowledge and honor past, present, and future Indigenous students of Chemeketa Community College.
Contents
Introduction
Chapter 1: Technical Communication Fundamentals
Why Technical Communication Matters
The Problem-Solution Framework
Purposeful Communication
Characteristics of Technical Communication
Creating User-Friendly Content
Conclusion
Chapter 2: Technical Communication Ethics
Why Ethics Matter
Ethics Defined
Ethics at Work
Distorted or Misleading Information
Visual Misrepresentation
Using Information Ethically
Conclusion
Chapter 3: Layout and Design
Why Layout and Design Matters
Principles of Document Design
Design for Readability
Design for Emphasis
Design for Organization
Types of Visuals
Conclusion
Chapter 4: Multimodal and Multimedia Communication
Why Multimodal and Multimedia Communication Matter
Multimodal Communication at Work
Rhetorical Awareness and Digital Literacy
Output Options
Conclusion
Chapter 5: Research Methods for Technical Communication
Why Research Matters
Steps for Research
Primary and Secondary Research
Using Sources Effectively
Citing Sources
Intellectual Property
Advanced Research
Conclusion
Chapter 6: Job Materials
Why Job Materials Matter
Organize Your Materials
Steps for Creating Job Materials
Build a Cover Letter
Characteristics of Effective Job Materials
Job Materials Best Practices
Ethical Considerations
Be Competitive
Conclusion
Chapter 7: Workplace Communication
Why Workplace Communication Matters
Types of Workplace Communication
Communicating Professionally
Collaboration
Global Workplace Etiquette
Conclusion
Chapter 8: Technical Definitions and Descriptions
Why Definitions and Descriptions Matter
Creating Definitions and Descriptions
Parenthetical Definitions
Sentence Definitions
Extended Definitions
Descriptions
The Known-New Contract
Legal and Ethical Implications
Conclusion
Chapter 9: Instructions and Procedures
Why Instructions and Procedures Matter
Instructions
Procedures
Legal and Ethical Concerns
Usability Testing
Conclusion
Chapter 10: Proposals and Short Reports
Why Proposals and Short Reports Matter
Proposals Defined
Types of Proposals
Typical Elements of a Proposal
Short Reports Defined
Steps for Writing Proposals and Short Reports
Principles for Proposals and Short Reports
Conclusion
Chapter 11: Formal Reports
Why Formal Reports Matter
Types of Formal Reports
The Formal Report Process
Writing the Formal Report
Conclusion
Chapter 12: Make Technical Communication Work for You
Bridging the Gap
Types of Communicators
Meet the Professionals
Tips for Success
Conclusion
Acknowledgments
Appendix A: MLA Report
Glossary Index
Introduction
Welcome to the future of technical communication. This book began with feedback from students in technical communication courses. They wanted a book with better visuals, organization, and models. They wanted a book that was easy to navigate and streamlined for their needs. They wanted a useful and practical book with a price tag that didn t make them break out in a cold sweat. At every step of the way, the instructors who contributed to this book had you in mind.
We invite you to approach this textbook as a term-length usability study. In usability testing, the developers of a product evaluate its performance by observing how the target audience use the product. This textbook is designed to provide you with solid tools, useful models, interesting scenarios, and a vocabulary of technical terms that will allow you to communicate effectively as part of a fast-paced, global workforce.
To get the most out of this book, you must first read the pages assigned by your instructor. After you ve done that, take a step back and consider how the book, chapter, or section you just read works as an example of technical communication. Like any text, you should approach this book with a curious and critical mind. If one of the book s models or templates helps you understand a concept, let your instructor know. If we fail to follow our own rules, let your instructor know. You are part of our development team now.
Key Features
Abstracts: The abstracts at the beginning of each chapter demonstrate concise, specific writing that sums up the chapter. This pedagogical element reinforces an essential technical skill.
Annotated models: Marginal notes accompany every model to identify places where the document is working or needs work. The notes encourage you to interact critically with the documents and understand specific examples of the chapter s concepts.
Bold terms and glossary: Each chapter begins with a list of key terms that will be introduced. When important terms are first mentioned, they are always in bold and accompanied by a sentence definition. This book has an entire chapter on technical descriptions and definitions, but each bold term can be treated as a mini-lesson in writing effective definitions. The glossary at the end collects all the definitions for easy reference.
Case studies: At the end of each chapter, case studies invite you to think about ways to apply the concepts you re learning. These compact scenarios show how individuals interact with technical communication principles in the workplace and beyond.
Checklists: The checklists at the end of each chapter break down complex tasks into smaller steps. They are designed to be used, so check off each box to track your progress.
Extended technical scenarios: In each chapter, you will follow a character who must create a technical document. As with any good story, each character encounters challenges, and their drafts serve as a starting place to begin seeing yourself as a technical communicator.
Figures, tables, and charts: Whenever possible, this book aims to translate concepts into visuals to support the text.
Instructional captions: The captions are designed to reinforce the visual information provided by the figures. Rather than restating the book s content, the captions provide bite-sized supplemental information about the concept to enhance understanding.
Looking Ahead sections: Every chapter opens with a table of contents in miniature. This section offers a quick overview of the chapter to assist in your preparation for class.
Marginal notes: The notes in the margins reveal the connections within the text by pointing to other chapters where a concept is discussed in greater depth.
Problem-Solution Framework: This framework provides a conceptual model to illustrate the goals of technical communication. This model embraces the importance of purpose, audience, and message and adds to it by emphasizing how technical communicators are hired to solve problems.
Traffic signals: Models of technical documents are accompanied by traffic signals that indicate how finished the document is. A red light indicates a document that is at the beginning stages or insufficient. The hope is that you ll stop at these models to examine why they aren t working. Models with a yellow light show a work in progress. Models with a green light are final versions that are ready to go out into the world.
A Note for Instructors
Chemeketa Press would like to build resources that align with this textbook. If you have a classroom activity, student model, assignment, or syllabus that works with this text, please share it with us. We hope to use these resources (with your permission) to create a toolbox for future instructors who use this textbook. Please feel free to contact us at [e-mail] .
Chapter 1
Technical Communication Fundamentals
Abstract: Welcome to technical communication. Each chapter begins with an abstract that models concise writing and prepares you for the content to come. As you ll learn in this book, technical communication is a journey from problem to solution. The technical communicator must use and arrange clear, concise, precise, and accurate information to cre