Writing in the Technical Fields

Mike Markel is the author of Writing in the Technical Fields: A Step-by-Step Guide for Engineers, Scientists, and Technicians, published by Wiley.

• Preface xiiiPart I: Techniques 1Chapter I. Introduction 3Treat Workplace Writing as a Craft, Not an Art 3Unlearn What You Learned in School 4Focus on What You Know About Writing at Work 6Characteristics of Effective Workplace Writing 7Chapter 2 Before You Start Writing 13Use Short Writing Sessions, Not Long Ones 13Write Collaboratively 15Analyze Your Audience 17Define Your Purpose 18Evaluate the Implications of Your Audience and Purpose 19Make Sure Your Boss Agrees with What You've Decided 21Chapter 3. Understanding the Writing Process 23Generate Ideas to Include in the Document 23Organize Your Information 26Write the Draft Quickly 34Spend Your Time Revising 34Chapter 4 Using the Computer to Improve Your Writing 39Understand What the Computer Can—and Cannot—Do for You 40Use the Computer When You're Just Getting Started on a Document 40Use the Computer When You're Drafting 41Use the Computer When You're Revising 42Use Specialized Software 43Chapter 5. Improving the Coherence of Your Writing 47Write Informative Titles and Headings 48Use Lists to Communicate Parallel Information 50Use Introductions to Forecast Discussions 52Use Conclusions to Complete Discussions 55Chapter 6 Writing Better Paragraphs 59Begin with a Clear Topic Sentence 59Support the Topic Sentence Logically 61Emphasize the Coherence of the Paragraph 62Keep Paragraphs to a Manageable Length 65Chapter 7. Writing Better Sentences 67Determine the Appropriate Stylistic Guidelines 68Use the Active and Passive Voices Appropriately 68Choose Appropriate Sentence Patterns 70Focus on the Real Subject 72Focus on the Real Verb 73Use Modifying Elements Effectively 74Keep Parallel Items Parallel 76Chapter 8 Choosing the Right Word 79Choose Simple, Clear Words and Phrases 79Avoid Unnecessary Jargon 82Avoid Euphemisms 82Avoid Cliches 82Avoid Sexist Language 83Use Readability Formulas Carefully 84Chapter 9 Creating and Integrating Graphics 87Determine Whether You Need Graphics 87Determine What Kind of Graphic to Use 89Make the Graphic Honest 90Make the Graphic Self-Sufficient 91Determine Where to Put the Graphic 95Tie the Graphic to the Text 95Chapter 10. Improving Page Design 99Leave Adequate Margins 100Consider a Multicolumn Format 101Use Appropriate Line Spacing 102Use Appropriate Justification 104Understand the Readability Levels of Type Fonts 106Use the Different Members of a Type Family 107Use Type Sizes Appropriately 108Use Uppercase and Lowercase 110Design Titles and Headings for Emphasis and Clarity 110Design Lists for Clarity 112Part II: Applications 115Chapter 11. Letters 117Learn the Standard Letter Formats 117Learn Letter Protocol 118Forecast the Purpose of the Letter 122End on a Positive Note 123Achieve a Natural Tone 124Chapter 12 Memos 127Create an Informative Heading 128State the Purpose Up Front 128Include a Summary 129Conclude with an Action Statement 130Chapter 13. Minutes 135Include the Necessary Housekeeping Details 136Record Events Accurately 136Record Events Diplomatically 137Chapter 14 Procedures and Manuals 141Emphasize Safety 142Orient the Reader 145Write Clear Instructions 148Add Graphics to Clarify the Text 150Design the Document for Easy Use in the Field 152Anticipate the Need for Updates 154Include Troubleshooting Tips 154Chapter 15. Formal Elements of Reports 157Transmittal Letter 158Title Page 160Table of Contents 160Abstract 162Executive Summary 164Appendices 166Chapter 16 Proposals I69Plan Before You Start Writing 170Show That You Understand the Readers’ Needs 171Propose a Clear, Specific Technical Plan for the Project 174Demonstrate Your Professionalism and Credibility 176Use Graphics to Help Your Readers See Your Ideas 177Evaluate the Proposal Carefully Before You Send It Out 178Chapter 17. Progress Reports 183Clarify the Context 183Explain the Progress Clearly 184Explain the Progress Honestly 185Chapter 18. Completion Reports 189Introduce the Report Clearly 190Describe Your Methods 191Present Your Results 192Draw Conclusions from the Results 194Present Your Recommendations 195Appendices 197A. Checklists 199B. Handbook 207C. Commonly Misused Words and Phrases 241D. Guidelines for Speakers of English as a Second Language 247E. Guidelines for Writing to Speakers of English as a Second Language 261F. Selected Bibliography 265Index 271