| |
| |
| Preface | |
| |
| |
| |
| Foundations | |
| |
| |
| |
| Introduction to Technical Communication | |
| |
| |
| What Is Technical Communication? | |
| |
| |
| Who Creates Technical Communication? | |
| |
| |
| Main Features of Technical Communication | |
| |
| |
| Three Primary Purposes of Effective Technical Communication | |
| |
| |
| Common Types of Technical Documents | |
| |
| |
| The Importance of Proofreading | |
| |
| |
| |
| Teamwork and Global Issues in Technical Communication | |
| |
| |
| Teamwork in Technical Communication | |
| |
| |
| Global Issues in Technical Communication | |
| |
| |
| |
| The Research Process in Technical Communication | |
| |
| |
| Thinking Critically about Research | |
| |
| |
| Primary versus Secondary Sources | |
| |
| |
| Exploring Secondary Sources | |
| |
| |
| Exploring Primary Sources | |
| |
| |
| |
| Providing Audiences with Usable Information | |
| |
| |
| Analyze the Document's Audience | |
| |
| |
| Determine the Document's Purpose | |
| |
| |
| Know How to Be Persuasive | |
| |
| |
| Create a Task Analysis for the Document | |
| |
| |
| Consider Other Related Usability Factors | |
| |
| |
| Develop an Information Plan for the Document | |
| |
| |
| Write, Test, and Revise the Document | |
| |
| |
| |
| Recognizing Ethical Issues in Technical Communication | |
| |
| |
| Ethics, Technology, and Communication | |
| |
| |
| Types of Ethical Choices | |
| |
| |
| How Workplace Pressures Affect Ethical Values | |
| |
| |
| Recognizing and Avoiding Ethical Abuses | |
| |
| |
| |
| Blueprints | |
| |
| |
| |
| Structuring Information for Your Readers | |
| |
| |
| The Importance of an Understandable Structure | |
| |
| |
| Outlining | |
| |
| |
| Chunking | |
| |
| |
| Sequencing | |
| |
| |
| Paragraphing | |
| |
| |
| Clarifying Headings | |
| |
| |
| Providing an Overview | |
| |
| |
| |
| Writing with a Readable Style | |
| |
| |
| The Importance of a Readable Style | |
| |
| |
| Writing Clearly | |
| |
| |
| Writing Concisely | |
| |
| |
| Writing Fluently | |
| |
| |
| Writing Personably | |
| |
| |
| |
| Using Audience-Centered Visuals | |
| |
| |
| The Importance of Using Audience-Centered Visuals | |
| |
| |
| When to Use Visuals | |
| |
| |
| Types of Visuals | |
| |
| |
| Special Considerations When Using Visuals | |
| |
| |
| |
| Designing User-Friendly Documents | |
| |
| |
| The Importance of User-Friendly Document Design | |
| |
| |
| Characteristics of Well Designed Documents | |
| |
| |
| Specific Design Elements | |
| |
| |
| |
| Documents | |
| |
| |
| |
| R�sum�s and Other Employment Materials | |
| |
| |
| Assessing Your Skills and Aptitudes | |
| |
| |
| Researching the Job Market | |
| |
| |
| R�sum�s | |
| |
| |
| Application Letters | |
| |
| |
| Dossiers, Portfolios, and Webfolios | |
| |
| |
| Interviews and Follow-Up Letters | |
| |
| |
| |
| Memos and Letters | |
| |
| |
| Memo Basics | |
| |
| |
| Memo Parts and Format | |
| |
| |
| Memo Tone | |
| |
| |
| Types of Memos | |
| |
| |
| Letter Basics | |
| |
| |
| Letter Parts and Formats | |
| |
| |
| Letter Tone | |
| |
| |
| Types of Letters | |
| |
| |
| |
| Definitions | |
| |
| |
| Audience and Purpose of Definitions | |
| |
| |
| Legal, Ethical, and Societal Implications of Definitions | |
| |
| |
| Types of Definitions | |
| |
| |
| Methods for Expanding Definitions | |
| |
| |
| Using Multiple Expansion Methods | |
| |
| |
| Placement of Definitions | |
| |
| |
| |
| Descriptions | |
| |
| |
| Audience and Purpose of Descriptions | |
| |
| |
| Objectivity in Descriptions | |
| |
| |
| Elements of Descriptions | |
| |
| |
| Product and Process Descriptions | |
| |
| |
| A Complex Product Description | |
| |
| |
| A Complex Process Description | |
| |
| |
| Specifications | |
| |
| |
| |
| Instructions and Procedures | |
| |
| |
| Audience and Purpose of Definitions | |
| |
| |
| Types of Instructional Formats | |
| |
| |
| Ethical and Legal Implications | |
| |
| |
| Elements of Effective Instructions | |
| |
| |
| Content, Style, and Design Considerations | |
| |
| |
| Procedures | |
| |
| |
| Usability Testing | |
| |
| |
| |
| Summaries | |
| |
| |
| Audience and Purpose of Summaries | |
| |
| |
| Elements of Effective Summaries | |
| |
| |
| Writing Summaries Step-by-Step | |
| |
| |
| Special Types of Summaries | |
| |
| |
| Ethical Considerations In Summarizing Information | |
| |
| |
| |
| Informal Reports | |
| |
| |
| Two Categories of Reports: Informational and Analytical | |
| |
| |
| Progress Reports (Informational) | |
| |
| |
| Periodic Activity Reports (Informational) | |
| |
| |
| Trip Reports (Informational) | |
| |
| |
| Meeting Minutes (Informational) | |
| |
| |
| Feasibility Reports (Analytical) | |
| |
| |
| Recommendation Reports (Analytical) | |
| |
| |
| Peer Review Reports (Analytical) | |
| |
| |
| |
| Formal Reports | |
| |
| |
| Audience and Purpose of Formal Reports | |
| |
| |
| Elements of Effective Formal Reports | |
| |
| |
| Parts of Formal Reports | |
| |
| |
| A Sample Formal Report | |
| |
| |
| |
| Proposals | |
| |
| |
| Audience and Purpose of Proposals | |
| |
| |
| Types of Proposals | |
| |
| |
| Organization of Informal and Formal Proposals | |
| |
| |
| A Sample Formal Proposal | |
| |
| |
| |
| Digital Media And Presentations | |
| |
| |
| |
| Email and Text Messages | |
| |
| |
| Email | |
| |
| |
| Text Messages | |
| |
| |
| Comparing Email and Text Messaging | |
| |
| |
| Copyright and Privacy in Digital Communication | |
| |
| |
| Be Prepared for Technology to Fail | |
| |
| |
| |
| Blogs, Wikis, and Social Networks | |
| |
| |
| Internal Corporate Blogs | |
| |
| |
| External Corporate Blogs | |
| |
| |
| Corporate Wikis | |
| |
| |
| Social Networks | |
| |
| |
| |
| Web Pages and Online Videos | |
| |
| |
| Audience and Purpose of Web Pages | |
| |
| |
| Elements of Effective Web Pages | |
| |
| |
| Online Videos | |
| |
| |
| Ethical and Legal Considerations | |
| |
| |
| PDF Files | |
| |
| |
| Differences in Media Types | |
| |
| |
| |
| Oral Presentations | |
| |
| |
| Audience and Purpose of Oral Presentations | |
| |
| |
| Types of Oral Presentations | |
| |
| |
| Parts of Oral Presentations | |
| |
| |
| Preparing Oral Presentations | |
| |
| |
| Using Presentation Software | |
| |
| |
| Delivering Oral Presentations | |
| |
| |
| Appendices | |
| |
| |
| |
| Documenting Sources | |
| |
| |
| What Is Plagiarism? | |
| |
| |
| Identifying Sources and Information to be Documented | |
| |
| |
| Taking Effective and Accurate Notes | |
| |
| |
| Quoting, Paraphrasing, and Summarizing Properly | |
| |
| |
| Documentation: The Key to Avoiding Plagiarism | |
| |
| |
| MLA Documentation Style | |
| |
| |
| APA Documentation Style | |
| |
| |
| CSE Documentation Style | |
| |
| |
| Recognizing Copyright Issues | |
| |
| |
| |
| A Brief Handbook | |
| |
| |
| Grammar | |
| |
| |
| Punctuation | |
| |
| |
| Mechanics | |
| |
| |
| Usage | |
| |
| |
| Transitions | |
| |
| |
| Lists | |
| |
| |
| Works Cited | |
| |
| |
| Photo Credits | |
| |
| |
| Index | |