What Every Engineer Should Know: Series Statement |
|
xv | |
Preface |
|
xvii | |
Acknowledgments |
|
xix | |
1 The Nature of Technical Writing |
|
1 | (12) |
|
|
1 | (1) |
|
1.2 Who Writes Technical Documentation? |
|
|
2 | (1) |
|
1.3 Taxonomy of Technical Writing |
|
|
3 | (1) |
|
|
4 | (1) |
|
1.5 Business Communications |
|
|
5 | (1) |
|
|
6 | (4) |
|
|
7 | (1) |
|
|
7 | (1) |
|
|
8 | (1) |
|
1.6.4 Conference Proceedings |
|
|
8 | (1) |
|
|
9 | (1) |
|
|
9 | (1) |
|
1.6.7 Vignette: Nontechnical Writing |
|
|
9 | (1) |
|
1.6.8 Vignette: Technical Writing Sample |
|
|
9 | (1) |
|
|
10 | (1) |
|
|
11 | (1) |
|
|
11 | (2) |
2 Technical Writing Basics |
|
13 | (34) |
|
|
13 | (1) |
|
2.2 Structuring Your Writing |
|
|
13 | (3) |
|
2.3 Positioning Your Writing |
|
|
16 | (1) |
|
|
16 | (1) |
|
2.3.2 Are You Talking to Me? |
|
|
16 | (1) |
|
2.4 Choosing the Right Words |
|
|
17 | (8) |
|
|
17 | (3) |
|
2.4.2 Precision and Hedging |
|
|
20 | (3) |
|
2.4.3 Universal and Existential Quantification |
|
|
23 | (1) |
|
|
24 | (1) |
|
2.4.5 Vignette: Brake Retarder Prohibitions |
|
|
25 | (1) |
|
|
25 | (8) |
|
|
26 | (1) |
|
2.5.2 Anthropomorphic Writing |
|
|
26 | (1) |
|
|
27 | (1) |
|
2.5.4 Erroneous Heterographs |
|
|
27 | (2) |
|
2.5.5 Opinion versus Fact |
|
|
29 | (1) |
|
2.5.6 Acronyms, Domain-Specific Terms, and Jargon |
|
|
29 | (2) |
|
2.5.7 The Laziness of "Very" |
|
|
31 | (1) |
|
|
32 | (1) |
|
2.6 Making Your Technical Writing More Interesting |
|
|
33 | (3) |
|
|
33 | (1) |
|
2.6.2 Vignette: The Joy of Spam |
|
|
34 | (1) |
|
|
35 | (1) |
|
2.7 The 5 Cs of Technical Writing |
|
|
36 | (5) |
|
2.7.1 Qualities of Good Writing |
|
|
36 | (1) |
|
|
37 | (1) |
|
|
38 | (1) |
|
|
38 | (1) |
|
|
39 | (1) |
|
|
39 | (1) |
|
|
39 | (2) |
|
|
41 | (2) |
|
2.8.1 Choose the Right References |
|
|
41 | (1) |
|
|
42 | (1) |
|
|
42 | (1) |
|
|
43 | (1) |
|
|
44 | (1) |
|
|
45 | (2) |
3 The Writing Process |
|
47 | (28) |
|
|
47 | (1) |
|
3.2 The Traditional Writing Process |
|
|
48 | (10) |
|
|
49 | (1) |
|
|
50 | (1) |
|
|
50 | (1) |
|
|
51 | (3) |
|
|
54 | (1) |
|
3.2.6 Vignette: A Paper on Software Control on Oil Rigs |
|
|
54 | (4) |
|
|
58 | (1) |
|
3.4 Dealing with Writer's Block |
|
|
58 | (1) |
|
|
59 | (1) |
|
|
59 | (1) |
|
3.7 Permissions and Plagiarism |
|
|
60 | (8) |
|
|
60 | (2) |
|
|
62 | (1) |
|
|
63 | (1) |
|
|
64 | (1) |
|
|
64 | (3) |
|
3.7.6 Vignette: Determining Authorship-The Federalist Papers |
|
|
67 | (1) |
|
3.8 Making Your Writing Understandable to All |
|
|
68 | (3) |
|
|
68 | (2) |
|
3.8.2 British versus American English |
|
|
70 | (1) |
|
|
71 | (1) |
|
|
72 | (1) |
|
|
72 | (3) |
4 Scientific Writing |
|
75 | (26) |
|
|
75 | (1) |
|
|
76 | (1) |
|
|
77 | (2) |
|
|
79 | (2) |
|
|
81 | (10) |
|
4.5.1 Survey of the Field |
|
|
81 | (3) |
|
4.5.2 Based on Survey Data |
|
|
84 | (3) |
|
4.5.3 Based on Experimentation |
|
|
87 | (4) |
|
4.6 Reviews of Books, Papers, and Reports |
|
|
91 | (6) |
|
|
91 | (1) |
|
4.6.2 Journal and Conference Paper Reviews |
|
|
91 | (2) |
|
|
93 | (2) |
|
|
95 | (2) |
|
4.6.5 Vignette: Scientific Proposal |
|
|
97 | (1) |
|
|
97 | (1) |
|
|
98 | (1) |
|
|
99 | (2) |
5 Business Communications |
|
101 | (34) |
|
|
101 | (1) |
|
|
101 | (14) |
|
|
102 | (1) |
|
5.2.2 Contact Information |
|
|
103 | (1) |
|
|
103 | (1) |
|
5.2.4 Statement of Objective |
|
|
104 | (1) |
|
|
104 | (1) |
|
5.2.6 Education and Training |
|
|
104 | (1) |
|
5.2.7 Licenses and Certifications |
|
|
105 | (1) |
|
|
105 | (1) |
|
5.2.9 Hardware and Software |
|
|
105 | (1) |
|
|
106 | (1) |
|
5.2.11 Security Clearance |
|
|
107 | (1) |
|
5.2.12 Military and Other Service |
|
|
107 | (1) |
|
|
107 | (1) |
|
|
108 | (1) |
|
|
108 | (1) |
|
|
108 | (1) |
|
|
109 | (1) |
|
|
109 | (1) |
|
5.2.19 Things to Avoid on a Resume |
|
|
110 | (1) |
|
5.2.20 Honesty Is the Best Policy |
|
|
111 | (1) |
|
|
111 | (4) |
|
|
115 | (1) |
|
5.4 Writing Letters of Reference |
|
|
115 | (5) |
|
5.4.1 Letter of Reference for a Subordinate |
|
|
116 | (1) |
|
5.4.2 Letter of Reference for a Casual Acquaintance |
|
|
117 | (1) |
|
5.4.3 Generic Letter of Reference |
|
|
118 | (1) |
|
5.4.4 Form-Based Letter of Reference |
|
|
119 | (1) |
|
|
120 | (1) |
|
5.6 Meetings, Agendas, and Minutes |
|
|
121 | (4) |
|
5.6.1 Meeting Invitations |
|
|
121 | (2) |
|
|
123 | (1) |
|
|
123 | (2) |
|
5.7 Customer Relations Writing |
|
|
125 | (2) |
|
5.7.1 Vignette: A Customer Inquiry Letter |
|
|
125 | (1) |
|
5.7.2 Vignette: Response to a Customer Inquiry Letter |
|
|
126 | (1) |
|
|
127 | (2) |
|
|
129 | (4) |
|
5.9.1 Vignette: A Presentation on Cyberpandemics |
|
|
129 | (4) |
|
5.10 Marketing and Sales Materials |
|
|
133 | (1) |
|
|
133 | (1) |
|
|
134 | (1) |
|
|
134 | (1) |
6 Technical Reporting |
|
135 | (28) |
|
|
135 | (1) |
|
|
136 | (7) |
|
6.2.1 Vignette: PC Repair Book |
|
|
136 | (2) |
|
6.2.2 Vignette: Building an Aquarium |
|
|
138 | (2) |
|
6.2.3 Vignette: Operational Instructions for Krav Maga |
|
|
140 | (2) |
|
6.2.4 Vignette: Recipe for Fennell Pasta |
|
|
142 | (1) |
|
|
143 | (7) |
|
6.3.1 Vignette: Grant Proposal |
|
|
144 | (3) |
|
6.3.2 Vignette: Proposal for Consulting Services |
|
|
147 | (3) |
|
|
150 | (1) |
|
6.5 Strategic Plans and Planning |
|
|
151 | (6) |
|
|
152 | (1) |
|
6.5.2 The Mission Statement |
|
|
153 | (1) |
|
|
154 | (1) |
|
6.5.4 Competitive Market Analysis |
|
|
155 | (1) |
|
6.5.5 Goals, Objectives, and Strategies |
|
|
155 | (2) |
|
|
157 | (1) |
|
|
157 | (1) |
|
|
158 | (2) |
|
6.7.1 Vignette: Disaster from a User Manual |
|
|
160 | (1) |
|
|
160 | (1) |
|
|
161 | (1) |
|
|
161 | (2) |
7 Using Graphical Elements |
|
163 | (28) |
|
7.1 Breaking up the Monotony |
|
|
163 | (1) |
|
7.2 Modeling Ideas with Graphics |
|
|
163 | (7) |
|
7.2.1 A Picture Is Worth 1437.4 Words |
|
|
164 | (1) |
|
|
165 | (3) |
|
7.2.3 The Evolution of an Idea |
|
|
168 | (2) |
|
7.3 Selecting the Best Model for a Schedule |
|
|
170 | (2) |
|
|
172 | (3) |
|
7.4.1 Callouts, Captioning, and Placement |
|
|
172 | (2) |
|
7.4.2 Permissions for Figures |
|
|
174 | (1) |
|
|
175 | (2) |
|
7.6 Dealing with Equations |
|
|
177 | (6) |
|
7.6.1 Using Microsoft Equation Editor |
|
|
179 | (1) |
|
|
179 | (1) |
|
|
179 | (2) |
|
7.6.4 Vignette: Typesetting Books |
|
|
181 | (2) |
|
7.7 Dealing with Dynamic Content |
|
|
183 | (4) |
|
7.7.1 Vignette: The Minard Map |
|
|
185 | (2) |
|
|
187 | (1) |
|
|
188 | (1) |
|
|
188 | (3) |
8 Publishing Your Work |
|
191 | (22) |
|
|
191 | (1) |
|
8.1.1 What Kinds of Work Can Be Published? |
|
|
191 | (1) |
|
8.1.2 Why Publish Your Work? |
|
|
191 | (1) |
|
8.2 Making a Living as a Writer |
|
|
192 | (6) |
|
|
193 | (1) |
|
8.2.2 Writing Technical Books |
|
|
193 | (1) |
|
8.2.3 Getting Rich Writing Books |
|
|
194 | (2) |
|
8.2.4 Why Are Technical Books So Expensive? |
|
|
196 | (1) |
|
8.2.5 Vignette: A Writing Failure |
|
|
197 | (1) |
|
|
198 | (3) |
|
8.3.1 Administrative Rejection |
|
|
198 | (1) |
|
|
199 | (1) |
|
|
200 | (1) |
|
|
201 | (4) |
|
|
201 | (1) |
|
8.4.2 Responding to Rejection Letters |
|
|
202 | (1) |
|
8.4.3 Succeeding at Publishing |
|
|
203 | (1) |
|
8.4.4 Vignette: Experiences with Reviews |
|
|
204 | (1) |
|
8.5 Open Access Publishing |
|
|
205 | (2) |
|
8.5.1 The Traditional Publishing Model |
|
|
205 | (1) |
|
8.5.2 The Open-Access Publishing Model |
|
|
205 | (2) |
|
8.5.3 Vignette: Experience with Open Access Publishing |
|
|
207 | (1) |
|
|
207 | (2) |
|
|
207 | (1) |
|
|
208 | (1) |
|
8.6.3 Vignette: Bootleg Books |
|
|
209 | (1) |
|
|
209 | (1) |
|
|
210 | (1) |
|
|
211 | (2) |
9 Writing for E-Media |
|
213 | (18) |
|
|
213 | (1) |
|
9.2 E-Mail Can Be Dangerous |
|
|
214 | (4) |
|
|
215 | (1) |
|
|
215 | (2) |
|
|
217 | (1) |
|
|
218 | (3) |
|
9.3.1 Vignette: A Newsletter for CIO Institute |
|
|
219 | (2) |
|
|
221 | (1) |
|
|
222 | (1) |
|
|
223 | (1) |
|
|
224 | (2) |
|
|
224 | (1) |
|
|
225 | (1) |
|
|
226 | (2) |
|
9.8.1 Massively Open Online Course (MOOC) |
|
|
227 | (1) |
|
9.8.2 Vignette: Experiences with MOOCs |
|
|
227 | (1) |
|
|
228 | (1) |
|
|
229 | (1) |
|
|
229 | (2) |
10 Writing with Collaborators |
|
231 | (18) |
|
|
231 | (1) |
|
10.2 Writing in Different Voices |
|
|
232 | (3) |
|
10.2.1 Using Metrics to Detect Nonhomogeneous Writing |
|
|
233 | (1) |
|
10.2.2 Dealing with Different Voices |
|
|
234 | (1) |
|
10.2.3 Paul Erdos: The Ultimate Coauthor |
|
|
234 | (1) |
|
10.3 Very Large Collaborative Writing Projects |
|
|
235 | (2) |
|
10.3.1 Vignette: Building a Dictionary |
|
|
235 | (1) |
|
10.3.2 Vignette: Building an Encyclopedia |
|
|
236 | (1) |
|
|
237 | (4) |
|
|
238 | (1) |
|
|
239 | (1) |
|
|
239 | (1) |
|
|
239 | (1) |
|
|
240 | (1) |
|
|
240 | (1) |
|
10.4.7 Vignette: Determining Author Order |
|
|
240 | (1) |
|
10.5 Other Paradigms for Team Building |
|
|
241 | (2) |
|
10.5.1 Group Writing and Improvisational Comedy |
|
|
241 | (1) |
|
10.5.2 Team Technical Writing as Scriptwriting |
|
|
242 | (1) |
|
10.6 Antipatterns in Organizations |
|
|
243 | (3) |
|
|
244 | (1) |
|
|
245 | (1) |
|
10.6.3 Vignette: Experiences Co-Writing Books and Papers |
|
|
245 | (1) |
|
|
246 | (1) |
|
|
247 | (1) |
|
|
247 | (2) |
Appendix A |
|
249 | (2) |
Appendix B: Templates |
|
251 | (10) |
Glossary |
|
261 | (6) |
Index |
|
267 | |