Strategies for Technical Communication in the Workplace

Cover......Page 1
Title Page......Page 4
Copyright Page......Page 5
Brief Contents......Page 6
Contents......Page 8
Preface......Page 17
Acknowledgments......Page 22
Part 1: Foundations......Page 24
1. Technical Communication: Global, Collaborative, and Digital......Page 25
What Is Technical Communication?......Page 26
Main Features of Technical Communication......Page 27
Three Primary Purposes of Technical Communication......Page 29
Common Types of Technical Documents......Page 32
Technical Communication Is Global, Collaborative, and Digital......Page 35
Checklist for Effective Technical Communication......Page 45
Applications......Page 46
2. The Research Process in Technical Communication......Page 48
Thinking Critically about Research......Page 49
Primary versus Secondary Sources......Page 50
Exploring Secondary Sources......Page 51
Exploring Primary Sources......Page 60
Checklist for Doing Research......Page 64
Applications......Page 65
3. Providing Audiences with Usable Information......Page 67
Analyze the Document’s Audience......Page 68
Determine the Document’s Purpose......Page 73
Know How to Be Persuasive......Page 74
Create a Task Analysis for the Document......Page 79
Consider Other Related Usability Factors......Page 80
Develop an Information Plan for the Document......Page 82
Write, Test, Revise, and Proofread the Document......Page 84
Checklist for Usability......Page 86
Applications......Page 87
4. Recognizing Ethical Issues in Technical Communication......Page 89
Types of Ethical Choices......Page 90
Recognizing and Avoiding Ethical Abuses......Page 92
Checklist for Ethical Communication......Page 95
Applications......Page 96
Part 2: Blueprints......Page 98
5. Structuring Information for Your Readers......Page 99
The Importance of an Understandable Structure......Page 100
Outlining......Page 103
Sequencing......Page 106
Paragraphing......Page 107
Clarifying Headings......Page 109
Providing an Overview......Page 110
Checklist for Structuring Information......Page 113
Applications......Page 115
6. Writing with a Readable Style......Page 116
The Importance of a Readable Style......Page 117
Writing Clearly......Page 118
Writing Concisely......Page 123
Writing Fluently......Page 125
Writing Personably......Page 128
Checklist for Style......Page 130
Applications......Page 131
7. Using Audience-Centered Visuals......Page 134
The Importance of Using Audience-Centered Visuals......Page 135
When to Use Visuals......Page 136
Types of Visuals......Page 138
Special Considerations When Using Visuals......Page 149
Checklist for Using Audience-Centered Visuals......Page 151
Applications......Page 152
8. Designing User-Friendly Documents......Page 154
The Importance of User-Friendly Document Design......Page 155
Characteristics of Well-Designed Documents......Page 156
Specific Design Elements......Page 158
Checklist for Document Design......Page 168
Applications......Page 169
Part 3: Documents......Page 172
9. Résumés and Other Employment Materials......Page 173
Let’s Get Started Résumés and Application Letters......Page 174
Assessing Your Skills and Aptitudes......Page 175
Researching the Job Market......Page 176
Résumés......Page 177
Application Letters......Page 181
Digital versus Print Job Application Materials......Page 184
Dossiers, Portfolios, and E-portfolios......Page 186
Interviews and Follow-up Letters......Page 190
Checklist for Résumés......Page 194
Checklist for Supporting Materials......Page 195
Applications......Page 196
10. Memos and Letters......Page 198
Let’s Get Started Letters......Page 199
Memo Basics......Page 200
Memo Tone......Page 201
Types of Memos......Page 204
Letter Parts and Formats......Page 208
Letter Tone......Page 211
Types of Letters......Page 216
Applications......Page 226
11. Definitions......Page 228
Let’s Get Started Definitions......Page 229
Audience and Purpose of Definitions......Page 230
Legal, Ethical, and Societal Implications of Definitions......Page 231
Types of Definitions......Page 232
Methods for Expanding Definitions......Page 233
Using Multiple Expansion Methods......Page 237
Placement of Definitions......Page 239
Applications......Page 241
12. Descriptions......Page 243
Let’s Get Started Descriptions......Page 244
Objectivity in Descriptions......Page 245
Elements of Descriptions......Page 246
Product and Process Descriptions......Page 248
A Complex Product Description......Page 251
A Complex Process Description......Page 255
Specifications......Page 259
Checklist for Descriptions and Specifications......Page 262
Applications......Page 263
13. Instructions and Procedures......Page 265
Let’s Get Started Instructions......Page 266
Audience and Purpose of Instructions......Page 267
Types of Instructional Formats......Page 268
Elements of Effective Instructions......Page 274
Content, Style, and Design Considerations......Page 277
Procedures......Page 284
Usability Testing......Page 286
Applications......Page 288
14. Summaries......Page 290
Audience and Purpose of Summaries......Page 291
Elements of Effective Summaries......Page 292
Writing Summaries Step by Step......Page 293
Special Types of Summaries......Page 296
Ethical Considerations in Summarizing Information......Page 299
Applications......Page 302
15. Informal Reports......Page 304
Let’s Get Started Informal Reports......Page 305
Progress Reports (Informational)......Page 306
Trip Reports (Informational)......Page 310
Meeting Minutes (Informational)......Page 315
Feasibility Reports (Analytical)......Page 316
Recommendation Reports (Analytical)......Page 319
Peer Review Reports (Analytical)......Page 321
Applications......Page 323
16. Formal Reports......Page 325
Let’s Get Started Formal Reports......Page 326
Audience and Purpose of Formal Reports......Page 327
Elements of Effective Formal Reports......Page 329
Parts of Formal Reports......Page 332
A Sample Formal Report......Page 336
Checklist for Formal Reports......Page 347
Applications......Page 348
17. Proposals......Page 349
Let’s Get Started Proposals......Page 350
Types of Proposals......Page 351
Organization of Informal and Formal Proposals......Page 355
A Sample Formal Proposal......Page 359
Applications......Page 370
Part 4: Digital Media and Presentations......Page 372
18. Email and Text Messages......Page 373
Email......Page 374
Text Messages......Page 380
Copyright and Privacy in Digital Communication......Page 381
Checklist for Email and Text Messages......Page 383
Applications......Page 384
19. Blogs, Wikis, and Web Pages......Page 385
Internal Blogs......Page 386
External Blogs......Page 387
Web Pages......Page 388
Audience and Purpose of Web Pages......Page 389
Elements of Effective Web Pages......Page 390
Ethical Considerations......Page 394
Checklist for Blogs, Wikis, and Web Pages......Page 396
Applications......Page 397
20. Social Media......Page 398
Let’s Get Started Social Media......Page 399
Considering Audience and Purpose......Page 400
Social Media in Technical and Workplace Communication......Page 402
Ethical and Legal Issues......Page 405
Applications......Page 407
21. Oral Presentations and Video Conferencing......Page 409
Let’s Get Started Oral Presentations......Page 410
Types of Oral Presentations......Page 411
Parts of Oral Presentations......Page 414
Preparing Oral Presentations......Page 415
Using Presentation Software......Page 422
Video Conferencing......Page 423
Delivering Oral Presentations......Page 424
Checklist for Oral Presentations......Page 425
Applications......Page 426
What Is Plagiarism?......Page 428
Taking Effective and Accurate Notes......Page 429
Quoting, Paraphrasing, and Summarizing Properly......Page 431
Documentation: The Key to Avoiding Plagiarism......Page 434
MLA Documentation Style......Page 436
APA Documentation Style......Page 448
Recognizing Copyright Issues......Page 459
B: A Brief Handbook......Page 462
Grammar......Page 463
Punctuation......Page 468
Mechanics......Page 476
Transitions......Page 479
Lists......Page 483
Photo Credits......Page 485
Index......Page 486
Editing and Revision Symbols......Page 498
Back Cover......Page 499