| |
| |
| Preface | |
| |
| |
| |
| Technical Communication Techniques and Considerations | |
| |
| |
| |
| An Introduction to Technical Communication | |
| |
| |
| Communicating About Technology | |
| |
| |
| Main Characteristics of Technical Communication | |
| |
| |
| Types of Technical Communication | |
| |
| |
| Technical Communication in the Workplace | |
| |
| |
| Teamwork, Virtual Teams, and Project Management | |
| |
| |
| Societal Dimensions of Technical Communication | |
| |
| |
| Ethical Dimensions of Technical Communication | |
| |
| |
| Checklist for Quality in Technical Communication | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| A World of People and Purposes | |
| |
| |
| People, Purposes, and Communities | |
| |
| |
| Analyzing Your Audience | |
| |
| |
| Analyzing the Communication Purpose | |
| |
| |
| Analyzing the Communication Context | |
| |
| |
| Conducting an Audience-Purpose Interview | |
| |
| |
| More Tools for Understanding Audience | |
| |
| |
| Using Information from Your Analysis | |
| |
| |
| Recognizing That Audiences Are Not Passive | |
| |
| |
| Typical Audiences and Purposes for Technical Communication | |
| |
| |
| Checklist for Analyzing Audience, Purpose, and Context | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Designing Usable Information | |
| |
| |
| Usability and Technical Information | |
| |
| |
| Usability During the Planning Stages | |
| |
| |
| Usability During the Writing and Design Process | |
| |
| |
| Usability After the Information Is Released | |
| |
| |
| Writing and Organizing Information for Usability | |
| |
| |
| Proofreading Your Final Draft | |
| |
| |
| Checklist for Designing Usable Information | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Conducting Research for Technical Communication | |
| |
| |
| Thinking Critically About Research | |
| |
| |
| Primary Research | |
| |
| |
| Internet and Digital Research | |
| |
| |
| Other Electronic Research Tools | |
| |
| |
| Hard Copy Research | |
| |
| |
| Checklist for Research | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Technical Communication in a Digital World | |
| |
| |
| Communicating in Digital Space | |
| |
| |
| Designing Information for the New Media | |
| |
| |
| Online Documentation and Interface Design | |
| |
| |
| Corresponding Over the Wires: Email, Blogs, and Instant Messaging | |
| |
| |
| Telecommuting and Virtual Teams | |
| |
| |
| Presentation Software | |
| |
| |
| Checklist for Digital Communication | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Ethical Issues in Technical Communication | |
| |
| |
| Ethics, Technology, and Communication | |
| |
| |
| Examples of Ethical Issues in Technical Communication | |
| |
| |
| Types of Ethical Choices | |
| |
| |
| Legal Versus Ethical | |
| |
| |
| Additional Ways in Which Actions Can Be Unethical | |
| |
| |
| Types of Technical Communication Affected by Ethical Issues | |
| |
| |
| Responding to Ethical Situations | |
| |
| |
| Checklist for Ethical Communication | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Copyright and Privacy | |
| |
| |
| Why Technical Communicators Need to Understand Copyright and Privacy | |
| |
| |
| |
| Copyright | |
| |
| |
| Copyright-An Overview | |
| |
| |
| Documenting Your Sources | |
| |
| |
| Electronic Technologies and Copyright | |
| |
| |
| |
| Privacy | |
| |
| |
| Privacy-An Overview | |
| |
| |
| Computer Technologies, Privacy, and Technical Communication | |
| |
| |
| Checklist for Copyright and Privacy | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Page Layout and Document Design | |
| |
| |
| Creating Visually Effective Documents | |
| |
| |
| Formatting the Page Effectively | |
| |
| |
| Using Typography Effectively | |
| |
| |
| Providing Effective Search Options | |
| |
| |
| Designing Electronic Documents | |
| |
| |
| Creating and Using Style Sheets and Tools | |
| |
| |
| Checklist for Page Layout and Document Design | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Graphics and Visual Information | |
| |
| |
| The Power of the Picture | |
| |
| |
| When to Use Visuals | |
| |
| |
| Different Visuals for Different Audiences | |
| |
| |
| Text into Tables | |
| |
| |
| Numbers into Images | |
| |
| |
| Illustrations | |
| |
| |
| Diagrams | |
| |
| |
| Symbols and Icons | |
| |
| |
| Wordless Instruction | |
| |
| |
| Photographs | |
| |
| |
| Maps | |
| |
| |
| Visualization and Medical Imaging | |
| |
| |
| Software and Web-Based Images | |
| |
| |
| Using Color | |
| |
| |
| Avoiding Visual Noise | |
| |
| |
| Visuals and Ethics | |
| |
| |
| Cultural Considerations | |
| |
| |
| Checklist for Visual Communication | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Technical Communication Situations and Applications | |
| |
| |
| |
| Everyday Communication Situations | |
| |
| |
| Email | |
| |
| |
| Checklist for Email | |
| |
| |
| Memos | |
| |
| |
| Letters | |
| |
| |
| Checklist for Letters | |
| |
| |
| Resumes | |
| |
| |
| Checklist for Resumes | |
| |
| |
| Short Reports | |
| |
| |
| Checklist for Memos and Short Reports | |
| |
| |
| Oral Communication | |
| |
| |
| Checklist for Oral Presentations | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Product-Oriented Communication Situations | |
| |
| |
| Specifications | |
| |
| |
| Checklist for Specifications | |
| |
| |
| Brief Instructions | |
| |
| |
| Procedures | |
| |
| |
| Documentation and Manuals | |
| |
| |
| Checklist for Instructions, Procedures, and Manuals | |
| |
| |
| Technical Marketing Material | |
| |
| |
| Checklist for Technical Marketing Material | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Complex Communication Situations | |
| |
| |
| Definitions and Descriptions | |
| |
| |
| Checklist for Definitions and Descriptions | |
| |
| |
| Long Reports | |
| |
| |
| Checklist for Long Reports | |
| |
| |
| Proposals | |
| |
| |
| Checklist for Proposals | |
| |
| |
| Exercises | |
| |
| |
| The Collaboration Window | |
| |
| |
| The Global Window | |
| |
| |
| |
| Grammar | |
| |
| |
| Punctuation | |
| |
| |
| Lists | |
| |
| |
| Embedded Lists | |
| |
| |
| Vertical Lists | |
| |
| |
| Avoiding Sentence Fragments and Run-On Sentences | |
| |
| |
| Avoiding Sentence Fragments | |
| |
| |
| Avoiding Run-On Sentences | |
| |
| |
| Usage (Commonly Misused Words) | |
| |
| |
| Subject-Verb and Pronoun-Antecedent Agreement | |
| |
| |
| Faulty Modification | |
| |
| |
| Parallel Structure | |
| |
| |
| Transitions Within and Between Paragraphs | |
| |
| |
| Mechanics | |
| |
| |
| Abbreviations | |
| |
| |
| Hyphenation | |
| |
| |
| Capitalization | |
| |
| |
| Use of Numbers | |
| |
| |
| Spelling | |
| |
| |
| |
| Documenting Sources | |
| |
| |
| Quoting the Words of Others | |
| |
| |
| Paraphrasing the Words of Others | |
| |
| |
| What You Should Document | |
| |
| |
| How You Should Document | |
| |
| |
| MLA Documentation Style | |
| |
| |
| MLA Parenthetical References | |
| |
| |
| MLA Works Cited Entries | |
| |
| |
| MLA Works Cited Page | |
| |
| |
| APA Documentation Style | |
| |
| |
| APA Parenthetical References | |
| |
| |
| APA References Entries | |
| |
| |
| APA References List | |
| |
| |
| CSE and Other Numbered Documentation Styles | |
| |
| |
| CSE Numbered Citations | |
| |
| |
| CSE References Entries | |
| |
| |
| References | |
| |
| |
| Credits | |
| |
| |
| Index | |