| Preface |
|
xix | |
| Acknowledgments |
|
xxiii | |
|
Introduction to Technical Communication |
|
|
1 | (13) |
|
Technical Communication Is User Centered |
|
|
3 | (1) |
|
Technical Communication Is Efficient |
|
|
3 | (3) |
|
Technical Communication Comes in All Sizes and Shapes |
|
|
6 | (2) |
|
Technical Communicators Employ a Broad Array of Skills |
|
|
8 | (1) |
|
Technical Communication Is Part of Most Careers |
|
|
9 | (1) |
|
Communication Has Both an Electronic and a Human Side |
|
|
10 | (1) |
|
Communication Reaches a Diverse Audience |
|
|
11 | (3) |
|
Consider This: Twenty-First Century Jobs Require Portable Skills |
|
|
12 | (1) |
|
|
|
13 | (1) |
|
|
|
13 | (1) |
|
|
|
13 | (1) |
|
PART I Communicating in the Workplace |
|
|
14 | (102) |
|
Preparing an Effective Technical Document |
|
|
16 | (11) |
|
|
|
17 | (5) |
|
Rely on Creative and Critical Thinking |
|
|
22 | (2) |
|
Guidelines for Writing with a Computer |
|
|
23 | (1) |
|
Make Proofreading Your Final Step |
|
|
24 | (3) |
|
Guidelines: for Proofreading |
|
|
24 | (1) |
|
Consider This: Workplace Settings Are Increasingly ``Virtual'' |
|
|
25 | (1) |
|
|
|
25 | (1) |
|
|
|
26 | (1) |
|
|
|
26 | (1) |
|
Delivering the Essential Information |
|
|
27 | (16) |
|
Assess the Audience's Information Needs |
|
|
29 | (1) |
|
Identify Levels of Technicality |
|
|
30 | (4) |
|
The Highly Technical Document |
|
|
30 | (1) |
|
The Semitechnical Document |
|
|
31 | (1) |
|
The Nontechnical Document |
|
|
32 | (1) |
|
Primary and Secondary Audiences |
|
|
33 | (1) |
|
Web-Based Documents for Multiple Audiences |
|
|
34 | (1) |
|
Develop an Audience and Use Profile |
|
|
34 | (9) |
|
|
|
35 | (2) |
|
|
|
37 | (1) |
|
Audience's Technical Background |
|
|
37 | (1) |
|
Audience's Cultural Background |
|
|
37 | (1) |
|
Audience's Knowledge of the Subject |
|
|
38 | (1) |
|
Appropriate Details, Format, and Design |
|
|
39 | (1) |
|
|
|
39 | (1) |
|
Consider This: Communication Failure Can Have Drastic Consequences |
|
|
40 | (1) |
|
|
|
41 | (1) |
|
|
|
41 | (1) |
|
|
|
42 | (1) |
|
|
|
43 | (30) |
|
Identify Your Specific Goal |
|
|
45 | (1) |
|
Arguing to Influence People's Opinions |
|
|
45 | (1) |
|
Arguing to Enlist People's Support |
|
|
45 | (1) |
|
|
|
45 | (1) |
|
Arguing to Change People's Behavior |
|
|
46 | (1) |
|
Try to Predict Audience Reaction |
|
|
46 | (1) |
|
Expect Audience Resistance |
|
|
47 | (1) |
|
Know How to Connect with the Audience |
|
|
48 | (3) |
|
|
|
51 | (1) |
|
Ask for a Specific Response |
|
|
51 | (1) |
|
|
|
51 | (1) |
|
Recognize All Communication Constraints |
|
|
52 | (4) |
|
Organizational Constraints |
|
|
52 | (1) |
|
|
|
53 | (1) |
|
|
|
54 | (1) |
|
|
|
54 | (1) |
|
Social and Psychological Constraints |
|
|
54 | (1) |
|
Consider This: People Often React Emotionally to Persuasive Appeals |
|
|
55 | (1) |
|
|
|
56 | (3) |
|
Offer Convincing Evidence |
|
|
57 | (2) |
|
Appeal to Common Goals and Values |
|
|
59 | (1) |
|
Consider the Cultural Context |
|
|
59 | (2) |
|
|
|
61 | (12) |
|
Guidelines for Making Your Case |
|
|
66 | (2) |
|
Checklist for Cross-Cultural Documents |
|
|
68 | (1) |
|
|
|
69 | (1) |
|
|
|
70 | (2) |
|
|
|
72 | (1) |
|
Weighing the Ethical Issues |
|
|
73 | (23) |
|
Recognize Unethical Communication in the Workplace |
|
|
74 | (1) |
|
Know the Major Causes of Unethical Communication |
|
|
75 | (2) |
|
Yielding to Social Pressure |
|
|
75 | (1) |
|
Mistaking Groupthink for Teamwork |
|
|
76 | (1) |
|
Understand the Potential for Communication Abuse |
|
|
77 | (4) |
|
Suppressing Knowledge the Public Needs |
|
|
77 | (1) |
|
Hiding Conflicts of Interest |
|
|
78 | (1) |
|
Exaggerating Claims about Technology |
|
|
79 | (1) |
|
Falsifying or Fabricating Data |
|
|
79 | (1) |
|
Using Visual Images That Conceal the Truth |
|
|
79 | (1) |
|
Stealing or Divulging Proprietary Information |
|
|
79 | (1) |
|
Misusing Electronic Information |
|
|
80 | (1) |
|
Withholding Information People Need for Their Jobs |
|
|
81 | (1) |
|
Exploiting Cultural Differences |
|
|
81 | (1) |
|
Rely on Critical thinking for Ethical Decisions |
|
|
81 | (2) |
|
Reasonable Criteria for Ethical Judgment |
|
|
82 | (1) |
|
|
|
83 | (1) |
|
Anticipate Some Hard Choices |
|
|
83 | (2) |
|
Never Depend Only on Legal Guidelines |
|
|
85 | (2) |
|
Learn to Recognize Plagiarism |
|
|
87 | (2) |
|
Consider This: Ethical Standards Are Good for Business |
|
|
88 | (1) |
|
Decide Where and How to Draw the Line |
|
|
89 | (7) |
|
Checklist for Ethical Communication |
|
|
90 | (2) |
|
Guidelines for Ethical Communication |
|
|
92 | (1) |
|
|
|
93 | (1) |
|
|
|
94 | (1) |
|
|
|
94 | (2) |
|
|
|
96 | (20) |
|
Examples of Successful Collaboration |
|
|
97 | (1) |
|
The Role of Project Management in Successful Collaboration |
|
|
97 | (2) |
|
Guidelines for Managing a Collaborative Project |
|
|
98 | (1) |
|
Sources of Conflict in Collaborative Groups |
|
|
99 | (6) |
|
Interpersonal Differences |
|
|
100 | (1) |
|
Gender and Cultural Differences |
|
|
101 | (4) |
|
|
|
105 | (1) |
|
Overcoming Differences by Active Listening |
|
|
106 | (1) |
|
Guidelines for Active Listening |
|
|
107 | |
|
|
|
106 | (3) |
|
|
|
107 | (1) |
|
|
|
108 | (1) |
|
|
|
109 | (1) |
|
|
|
109 | (1) |
|
Reviewing and Editing Others' Work |
|
|
109 | (2) |
|
Guidelines for Peer Reviewing and Editing |
|
|
110 | (1) |
|
Face-to-Face versus Electronically Mediated Collaboration |
|
|
111 | (1) |
|
Ethical Abuses in Workplace Collaboration |
|
|
112 | (4) |
|
|
|
112 | (1) |
|
Claiming Credit for Other's Work |
|
|
112 | (1) |
|
|
|
113 | (1) |
|
Consider This: How You Speak Shows Where You Rank |
|
|
113 | (1) |
|
|
|
114 | (1) |
|
|
|
114 | (1) |
|
|
|
115 | (1) |
|
PART II The Research Process |
|
|
116 | (100) |
|
Thinking Critically about the Research Process |
|
|
118 | (10) |
|
Asking the Right Questions |
|
|
120 | (1) |
|
Exploring a Balance of Views |
|
|
121 | (1) |
|
Achieving Adequate Depth in Your Search |
|
|
122 | (2) |
|
|
|
124 | (1) |
|
Interpreting Your Findings |
|
|
124 | (4) |
|
Consider This: Expert Opinion Is Not Always Reliable |
|
|
125 | (1) |
|
Guidelines for Evaluating Expert Information |
|
|
126 | (1) |
|
|
|
126 | (2) |
|
Exploring Electronic and Hard Copy Sources |
|
|
128 | (21) |
|
Hard Copy versus Electronic Sources |
|
|
129 | (2) |
|
Consider This: Information Can be ``Pushed'' or ``Pulled'' |
|
|
130 | (1) |
|
|
|
131 | (4) |
|
|
|
131 | (1) |
|
|
|
131 | (1) |
|
|
|
131 | (1) |
|
Electronic Magazines (E-zines) |
|
|
131 | (1) |
|
|
|
131 | (1) |
|
|
|
131 | (3) |
|
|
|
134 | (1) |
|
Keyword Searches Using Boolean Operators |
|
|
135 | (2) |
|
Guidelines for Researching on the Internet |
|
|
136 | (1) |
|
|
|
137 | (2) |
|
|
|
137 | (1) |
|
Online Retrieval Services |
|
|
137 | (1) |
|
Consider This: Information in Electronic Form Is Copyright Protected |
|
|
138 | (1) |
|
|
|
139 | (10) |
|
|
|
140 | (1) |
|
|
|
141 | (1) |
|
|
|
141 | (1) |
|
|
|
141 | (1) |
|
|
|
142 | (1) |
|
Access Tools for U.S. Government Publications |
|
|
143 | (1) |
|
|
|
144 | (1) |
|
Consider This: Frequently Asked Questions about Copyright of Hard Copy Information |
|
|
144 | (2) |
|
|
|
146 | (1) |
|
|
|
147 | (1) |
|
|
|
148 | (1) |
|
Exploring Primary Sources |
|
|
149 | (15) |
|
|
|
150 | (4) |
|
Selecting the Best Interview Medium |
|
|
150 | (1) |
|
Guidelines for Informative Interviews |
|
|
151 | (3) |
|
|
|
154 | (1) |
|
Surveys and Questionnaires |
|
|
154 | (5) |
|
Defining the Survey's Purpose and Target Population |
|
|
156 | (1) |
|
Identifying the Sample Group |
|
|
156 | (1) |
|
Defining the Survey Method |
|
|
156 | (1) |
|
Guidelines for Developing a Questionnaire |
|
|
157 | (2) |
|
|
|
159 | (1) |
|
Inquiry Letters, Phone Calls, and Email Inquiries |
|
|
159 | (1) |
|
Public Records and Organizational Publications |
|
|
159 | (3) |
|
Personal Observation and Experiment |
|
|
162 | (1) |
|
|
|
162 | (2) |
|
|
|
163 | (1) |
|
|
|
163 | (1) |
|
|
|
163 | (1) |
|
Evaluating and Interpreting Information |
|
|
164 | (33) |
|
|
|
165 | (4) |
|
Is the Source Up-to-Date? |
|
|
165 | (1) |
|
Is the Printed Source Dependable? |
|
|
166 | (1) |
|
Is the Electronic Source Trustworthy? |
|
|
166 | (1) |
|
Is the Information Relatively Unbiased? |
|
|
166 | (3) |
|
How Does This Source Measure Up to Others? |
|
|
169 | (1) |
|
Guidelines for Evaluating Sources on the Web |
|
|
170 | |
|
|
|
169 | (5) |
|
Is the Evidence Sufficient? |
|
|
169 | (3) |
|
Is the Presentation of Evidence Balanced and Reasonable? |
|
|
172 | (1) |
|
Can the Evidence Be Verified? |
|
|
173 | (1) |
|
|
|
174 | (3) |
|
What Level of Certainty Is Warranted? |
|
|
174 | (2) |
|
Are the Underlying Assumptions Sound? |
|
|
176 | (1) |
|
To What Extent Has Personal Bias Influenced the Interpretation? |
|
|
176 | (1) |
|
Are Other Interpretations Possible? |
|
|
177 | (1) |
|
Consider This: Standards of Proof Vary for Different Audiences and Cultural Settings |
|
|
178 | |
|
Avoid Errors in Reasoning |
|
|
177 | (4) |
|
|
|
178 | (1) |
|
|
|
179 | (2) |
|
Avoid Statistical Fallacies |
|
|
181 | (6) |
|
Consider This: Correlation Does Not Equal Causation |
|
|
182 | (1) |
|
Common Statistical Fallacies |
|
|
183 | (2) |
|
The Limitations of Number Crunching |
|
|
185 | (2) |
|
|
|
187 | (1) |
|
Interpret the Reality Behind the Numbers |
|
|
187 | (1) |
|
Acknowledge the Limits of Research |
|
|
188 | (9) |
|
Obstacles to Validity and Reliability |
|
|
188 | (1) |
|
|
|
189 | (1) |
|
Sources of Measurement Error |
|
|
190 | (1) |
|
|
|
191 | (1) |
|
Guidelines for Evaluating and Interpreting Information |
|
|
192 | (2) |
|
Checklist for the Research Process |
|
|
194 | (1) |
|
|
|
194 | (2) |
|
|
|
196 | (1) |
|
|
|
196 | (1) |
|
Summarizing and Abstracting Information |
|
|
197 | (19) |
|
|
|
198 | (2) |
|
Guidelines for Summarizing Information |
|
|
199 | (1) |
|
What Users Expect from a Summary |
|
|
200 | (1) |
|
A Situation Requiring a Summary |
|
|
200 | (6) |
|
Forms of Summarized Information |
|
|
206 | (4) |
|
|
|
207 | (1) |
|
|
|
207 | (1) |
|
|
|
208 | (1) |
|
|
|
208 | (2) |
|
Ethical Considerations in Summarizing Information |
|
|
210 | (6) |
|
Checklist for Usability of Summaries |
|
|
211 | (1) |
|
|
|
212 | (1) |
|
|
|
212 | (1) |
|
|
|
213 | (3) |
|
PART III Structural and Style Elements |
|
|
216 | (70) |
|
|
|
218 | (25) |
|
Partitioning and Classifying |
|
|
219 | (3) |
|
|
|
222 | (5) |
|
|
|
222 | (1) |
|
|
|
223 | (2) |
|
Outlining and Reorganizing on a Computer |
|
|
225 | (2) |
|
Organizing for Cross-Cultural Audiences |
|
|
227 | (1) |
|
The Report Design Worksheet |
|
|
227 | (1) |
|
|
|
227 | (3) |
|
|
|
230 | (5) |
|
|
|
230 | (2) |
|
|
|
232 | (1) |
|
|
|
233 | (1) |
|
|
|
233 | (2) |
|
|
|
235 | (1) |
|
|
|
235 | (4) |
|
|
|
235 | (1) |
|
|
|
236 | (1) |
|
|
|
236 | (1) |
|
|
|
237 | (1) |
|
|
|
237 | (1) |
|
Problem-Causes-Solution Sequence |
|
|
237 | (1) |
|
Comparison-Contrast Sequence |
|
|
238 | (1) |
|
|
|
239 | (2) |
|
|
|
241 | (2) |
|
|
|
241 | (1) |
|
|
|
241 | (2) |
|
Editing for Readable Style |
|
|
243 | (43) |
|
|
|
245 | (8) |
|
|
|
245 | (1) |
|
Avoid Ambiguous Pronoun References |
|
|
245 | (1) |
|
Avoid Ambiguous Punctuation |
|
|
246 | (1) |
|
Avoid Telegraphic Writing |
|
|
246 | (1) |
|
Avoid Ambiguous Modifiers |
|
|
246 | (2) |
|
|
|
248 | (1) |
|
Arrange Word Order for Coherence and Emphasis |
|
|
248 | (2) |
|
|
|
250 | (2) |
|
Use Passive Voice Selectively |
|
|
252 | (1) |
|
Avoid Overstuffed Sentences |
|
|
253 | (1) |
|
|
|
253 | (7) |
|
|
|
254 | (1) |
|
|
|
254 | (1) |
|
Avoid Needless Repetition |
|
|
254 | (1) |
|
Avoid There Sentence Openers |
|
|
255 | (1) |
|
Avoid Some It Sentence Openers |
|
|
255 | (1) |
|
|
|
256 | (1) |
|
|
|
256 | (1) |
|
Delete Needless To Be Constructions |
|
|
257 | (1) |
|
Avoid Excessive Prepositions |
|
|
257 | (1) |
|
|
|
258 | (1) |
|
|
|
259 | (1) |
|
|
|
259 | (1) |
|
Delete Needless Qualifiers |
|
|
260 | (1) |
|
|
|
260 | (4) |
|
|
|
261 | (1) |
|
Vary Sentence Construction and Length |
|
|
262 | (1) |
|
Use Short Sentences for Special Emphasis |
|
|
263 | (1) |
|
|
|
264 | (10) |
|
Use Simple and Familiar Wording |
|
|
264 | (2) |
|
|
|
266 | (1) |
|
|
|
267 | (1) |
|
|
|
268 | (1) |
|
Avoid Misleading Euphemisms |
|
|
268 | (1) |
|
|
|
269 | (1) |
|
|
|
269 | (2) |
|
|
|
271 | (2) |
|
Use Analogies to Sharpen the Image |
|
|
273 | (1) |
|
|
|
274 | (8) |
|
Guidelines for Deciding about Tone |
|
|
276 | (1) |
|
Use an Occasional Contraction |
|
|
276 | (1) |
|
|
|
276 | (1) |
|
Use I and We When Appropriate |
|
|
277 | (1) |
|
|
|
277 | (1) |
|
|
|
278 | (1) |
|
Avoid an Overly Informal Tone |
|
|
278 | (1) |
|
|
|
278 | (2) |
|
|
|
280 | (1) |
|
Avoid Offensive Usage of All Types |
|
|
280 | (1) |
|
Guidelines for Nonsexist Usage |
|
|
281 | (1) |
|
Guidelines for Inoffensive Usage |
|
|
282 | (1) |
|
Considering the Cultural Context |
|
|
282 | (1) |
|
Legal and Ethical Implications of Word Choice |
|
|
283 | (1) |
|
Using Automated Editing Tools Effectively |
|
|
284 | (2) |
|
PART IV Visual, Design, and Usability Elements |
|
|
286 | (96) |
|
Designing Visual Information |
|
|
288 | (51) |
|
Why Visuals Are Important |
|
|
289 | (2) |
|
|
|
291 | (1) |
|
|
|
292 | (1) |
|
What Types of Visuals to Consider |
|
|
293 | (2) |
|
How to Select Visuals for Your Purpose and Audience |
|
|
295 | (2) |
|
|
|
297 | (3) |
|
|
|
300 | (10) |
|
|
|
300 | (6) |
|
|
|
306 | (3) |
|
Graphs with Three Variables |
|
|
309 | (1) |
|
|
|
310 | (5) |
|
|
|
310 | (2) |
|
|
|
312 | (1) |
|
|
|
312 | (1) |
|
|
|
312 | (1) |
|
|
|
312 | (1) |
|
|
|
313 | (2) |
|
|
|
315 | (8) |
|
|
|
316 | (3) |
|
|
|
319 | (1) |
|
|
|
320 | (3) |
|
|
|
323 | (6) |
|
|
|
323 | (1) |
|
|
|
323 | (1) |
|
|
|
324 | (5) |
|
Using Web Sites for Graphics Support |
|
|
329 | (1) |
|
How to Avoid Visual Distortion |
|
|
330 | (9) |
|
|
|
330 | (1) |
|
Present the Complete Picture |
|
|
330 | (1) |
|
Don't Mistake Distortion for Emphasis |
|
|
331 | (1) |
|
Checklist for Usability of Visuals |
|
|
332 | (2) |
|
Guidelines for Fitting Visuals with Printed Text |
|
|
334 | (1) |
|
|
|
335 | (2) |
|
|
|
337 | (2) |
|
Designing Pages and Documents |
|
|
339 | (26) |
|
Page Design in Workplace Documents |
|
|
340 | (1) |
|
How Page Design Transforms a Document |
|
|
340 | (1) |
|
Design Skills Needed in Today's Workplace |
|
|
341 | (3) |
|
|
|
343 | (1) |
|
|
|
343 | (1) |
|
Using Style Sheets and Company Style Guides |
|
|
344 | (1) |
|
|
|
344 | (21) |
|
|
|
344 | (8) |
|
Styling the Words and Letters |
|
|
352 | (2) |
|
Highlighting for Emphasis |
|
|
354 | (2) |
|
Using Headings for Access and Orientation |
|
|
356 | (4) |
|
Audience Considerations in Page Design |
|
|
360 | (1) |
|
Designing On-Screen Documents |
|
|
360 | (1) |
|
|
|
360 | (1) |
|
|
|
361 | (1) |
|
|
|
361 | (2) |
|
Checklist for Usability of Page Design |
|
|
363 | (1) |
|
|
|
363 | (1) |
|
|
|
364 | (1) |
|
Designing and Testing the Document for Usability |
|
|
365 | (17) |
|
Why a Usable Design Is Essential |
|
|
366 | (1) |
|
How to Achieve a Usable Design |
|
|
366 | (5) |
|
Outline the Main Tasks Involved |
|
|
367 | (1) |
|
Analyze the Audience and the Setting |
|
|
368 | (1) |
|
|
|
368 | (1) |
|
|
|
368 | (3) |
|
How to Test Your Document for Usability |
|
|
371 | (2) |
|
|
|
371 | (2) |
|
|
|
373 | (1) |
|
|
|
373 | (1) |
|
Usability Issues in Online or Multimedia Documents |
|
|
373 | (1) |
|
Usability Testing in the Classroom |
|
|
374 | (8) |
|
Guidelines for Testing a Document's Usability |
|
|
376 | (3) |
|
|
|
379 | (1) |
|
|
|
379 | (1) |
|
|
|
380 | (2) |
|
PART V Specific Documents and Applications |
|
|
382 | (296) |
|
Memo Reports and Electronic Mail |
|
|
384 | (25) |
|
Informational versus Analytical Reports |
|
|
385 | (1) |
|
Formal versus Informal Reports |
|
|
385 | (1) |
|
|
|
385 | (1) |
|
Elements of a Usable Memo |
|
|
386 | (1) |
|
Interpersonal Considerations in Writing a Memo |
|
|
386 | (2) |
|
Direct versus Indirect Organizing Patterns |
|
|
388 | (1) |
|
Informational Reports in Memo Form |
|
|
388 | (6) |
|
|
|
388 | (4) |
|
Periodic Activity Reports |
|
|
392 | (1) |
|
|
|
393 | (1) |
|
Analytical Reports in Memo Form |
|
|
394 | (6) |
|
|
|
395 | (2) |
|
|
|
397 | (2) |
|
|
|
399 | (1) |
|
|
|
400 | (5) |
|
|
|
400 | (2) |
|
|
|
402 | (1) |
|
|
|
402 | (1) |
|
Guidelines for Using Electronic Mail |
|
|
403 | (2) |
|
|
|
405 | (4) |
|
Guidelines for Choosing Email versus Paper or the Telephone |
|
|
405 | (1) |
|
Checklist for Usability of Memo Reports |
|
|
406 | (1) |
|
|
|
406 | (2) |
|
|
|
408 | (1) |
|
Letters and Employment Correspondence |
|
|
409 | (50) |
|
Elements of Usable Letters |
|
|
410 | (8) |
|
|
|
410 | (6) |
|
Specialized Parts of Letters |
|
|
416 | (1) |
|
|
|
417 | (1) |
|
Interpersonal Considerations in Workplace Letters |
|
|
418 | (3) |
|
|
|
421 | (2) |
|
|
|
421 | (2) |
|
Telephone and Email Inquiries |
|
|
423 | (1) |
|
|
|
423 | (2) |
|
|
|
423 | (1) |
|
|
|
424 | (1) |
|
Resumes and Job Applications |
|
|
425 | (1) |
|
Employment Outlook in the Twenty-First Century |
|
|
425 | (1) |
|
|
|
426 | (15) |
|
|
|
428 | (4) |
|
|
|
432 | (2) |
|
|
|
434 | (1) |
|
Preparing Your Job Application Letter |
|
|
434 | (6) |
|
Consider This: How Applicants Are Screened for Personal Qualities |
|
|
440 | (1) |
|
|
|
441 | (7) |
|
Online Employment Resources |
|
|
441 | (2) |
|
Electronic Scanning of Resumes |
|
|
443 | (1) |
|
How to Prepare Content for a Scannable Resume |
|
|
443 | (1) |
|
How to Design a Scannable Resume |
|
|
444 | (1) |
|
|
|
444 | (1) |
|
Protecting Privacy and Security When You Post a Resume Online |
|
|
445 | (3) |
|
Support for the Application |
|
|
448 | (11) |
|
|
|
448 | (1) |
|
Your Professional Portfolio |
|
|
448 | (1) |
|
|
|
449 | (2) |
|
Guidelines for Surviving a Job Interview |
|
|
451 | (2) |
|
|
|
453 | (1) |
|
Letters of Acceptance or Refusal |
|
|
453 | (1) |
|
Consider This: How to Evaluate a Job Offer |
|
|
454 | (3) |
|
Checklist for Usability of Letters |
|
|
457 | (1) |
|
|
|
457 | (1) |
|
|
|
458 | (1) |
|
Web Pages and Other Electronic Documents |
|
|
459 | (21) |
|
|
|
460 | (1) |
|
|
|
461 | (1) |
|
|
|
462 | (2) |
|
|
|
464 | (1) |
|
Text versus Images: Current Preferences |
|
|
464 | (2) |
|
|
|
466 | (1) |
|
Consider This: How Web Sites Enhance Workplace Transactions |
|
|
467 | |
|
Elements of a Usable Web Site |
|
|
466 | (9) |
|
|
|
466 | (2) |
|
|
|
468 | (1) |
|
|
|
468 | (1) |
|
Good Writing and Page Design |
|
|
468 | (1) |
|
Good Graphics and Special Effects |
|
|
468 | (4) |
|
Consider This: Web Site Needs and Expectations Differ Across Cultures |
|
|
472 | (1) |
|
Guidelines for Creating a Web Site |
|
|
473 | (2) |
|
Privacy Issues in Online Communication |
|
|
475 | (5) |
|
Checklist for Usability of Web Sites |
|
|
478 | (1) |
|
Individual or Collaborative Projects |
|
|
479 | (1) |
|
|
|
479 | (1) |
|
|
|
480 | (22) |
|
Purpose of Technical Definitions |
|
|
481 | (1) |
|
Levels of Detail in a Definition |
|
|
482 | (2) |
|
|
|
482 | (1) |
|
|
|
482 | (1) |
|
|
|
483 | (1) |
|
|
|
484 | (6) |
|
|
|
485 | (1) |
|
|
|
485 | (1) |
|
|
|
486 | (1) |
|
|
|
486 | (1) |
|
|
|
487 | (1) |
|
|
|
488 | (1) |
|
|
|
488 | (1) |
|
Required Materials or Conditions |
|
|
489 | (1) |
|
|
|
489 | (1) |
|
Situations Requiring Definitions |
|
|
490 | (3) |
|
|
|
493 | (9) |
|
Guidelines for Defining Clearly and Precisely |
|
|
496 | (1) |
|
Checklist for Usability of Definitions |
|
|
497 | (1) |
|
|
|
497 | (1) |
|
|
|
498 | (1) |
|
|
|
498 | (4) |
|
Technical Descriptions and Specifications |
|
|
502 | (30) |
|
Purposes and Types of Technical Description |
|
|
503 | (1) |
|
Elements of a Usable Description |
|
|
503 | (7) |
|
|
|
503 | (1) |
|
Appropriate Level of Detail and Technicality |
|
|
503 | (3) |
|
|
|
506 | (1) |
|
|
|
507 | (1) |
|
Clearest Descriptive Sequence |
|
|
507 | (3) |
|
An Outline and Model for Product Description |
|
|
510 | (3) |
|
Introduction: General Description |
|
|
510 | (1) |
|
Description and Function of Parts |
|
|
511 | (1) |
|
Summary and Operating Description |
|
|
512 | (1) |
|
A Situation Requiring Product Description |
|
|
513 | (3) |
|
An Outline for Process Description |
|
|
516 | (1) |
|
A Situation Requiring Process Description |
|
|
517 | (3) |
|
|
|
520 | (4) |
|
Technical Marketing Literature |
|
|
524 | (8) |
|
Checklist for Usability of Technical Descriptions |
|
|
527 | (1) |
|
|
|
527 | (1) |
|
|
|
528 | (4) |
|
Instructions and Procedures |
|
|
532 | (35) |
|
Purpose of Instructional Documents |
|
|
533 | (1) |
|
Formats for Instructional Documents |
|
|
533 | (2) |
|
Faulty Instructions and Legal Liability |
|
|
535 | (3) |
|
Elements of Usable Instruction |
|
|
538 | (14) |
|
|
|
538 | (1) |
|
|
|
539 | (1) |
|
|
|
539 | (1) |
|
Appropriate Level of Detail and Technicality |
|
|
539 | (7) |
|
|
|
546 | (1) |
|
|
|
546 | (1) |
|
|
|
547 | (2) |
|
|
|
549 | (3) |
|
An Outline and Model for Instructions |
|
|
552 | (2) |
|
|
|
552 | (1) |
|
|
|
553 | (1) |
|
|
|
554 | (1) |
|
A Situation Requiring Instructions |
|
|
554 | (6) |
|
|
|
560 | (7) |
|
Checklist for Usability of Instructions |
|
|
561 | (2) |
|
|
|
563 | (2) |
|
|
|
565 | (1) |
|
|
|
565 | (2) |
|
|
|
567 | (38) |
|
How Proposals and Reports Differ in Purpose |
|
|
568 | (1) |
|
|
|
568 | (1) |
|
|
|
569 | (3) |
|
|
|
572 | (6) |
|
|
|
573 | (2) |
|
|
|
575 | (2) |
|
|
|
577 | (1) |
|
Elements of a Persuasive Proposal |
|
|
578 | (6) |
|
|
|
579 | (1) |
|
Clear Understanding of the Audience's Needs |
|
|
579 | (1) |
|
A Clear Focus on Benefits |
|
|
579 | (1) |
|
Honest and Supportable Claims |
|
|
580 | (1) |
|
|
|
581 | (1) |
|
|
|
581 | (1) |
|
|
|
582 | (1) |
|
|
|
582 | (1) |
|
|
|
583 | (1) |
|
Supplements Tailored for a Diverse Audience |
|
|
583 | (1) |
|
Proper Citation of Sources and Contributors |
|
|
583 | (1) |
|
An Outline and Model for Proposals |
|
|
584 | (5) |
|
|
|
584 | (2) |
|
|
|
586 | (3) |
|
|
|
589 | (1) |
|
A Situation Requiring a Proposal |
|
|
589 | (16) |
|
Checklist for Usability of Proposals |
|
|
601 | (1) |
|
|
|
602 | (1) |
|
|
|
602 | (3) |
|
Formal Analytical Reports |
|
|
605 | (37) |
|
|
|
606 | (1) |
|
Typical Analytical Problems |
|
|
607 | (2) |
|
Causal Analysis: ``Why Does X Happen?'' |
|
|
607 | (1) |
|
Comparative Analysis: ``Is X or Y Better for Our Purpose?'' |
|
|
607 | (1) |
|
Feasibility Analysis: ``Is This a Good Idea?'' |
|
|
608 | (1) |
|
Combining Types of Analysis |
|
|
609 | (1) |
|
Elements of a Usable Analysis |
|
|
609 | (7) |
|
Clearly Identified Problems or Goal |
|
|
609 | (1) |
|
Adequate but Not Excessive Data |
|
|
609 | (1) |
|
Accurate and Balanced Data |
|
|
610 | (2) |
|
|
|
612 | (1) |
|
Subordination of Personal Bias |
|
|
612 | (1) |
|
|
|
612 | (1) |
|
Valid Conclusions and Recommendations |
|
|
612 | (4) |
|
|
|
616 | (1) |
|
An Outline and Model for Analytical Reports |
|
|
616 | (12) |
|
|
|
617 | (1) |
|
|
|
618 | (9) |
|
|
|
627 | (1) |
|
|
|
628 | (1) |
|
A Situation Requiring an Analytical Report |
|
|
628 | (14) |
|
Checklist for Usability of Analytical Reports |
|
|
630 | (1) |
|
Guidelines for Reasoning through an Analytical Problem |
|
|
630 | (10) |
|
|
|
640 | (1) |
|
|
|
641 | (1) |
|
Front Matter and End Matter in Long Documents |
|
|
642 | (11) |
|
|
|
643 | (1) |
|
|
|
643 | (1) |
|
|
|
643 | (3) |
|
|
|
646 | (2) |
|
List of Tables and Figures |
|
|
648 | (1) |
|
Abstract or Executive Summary |
|
|
648 | (1) |
|
|
|
649 | (1) |
|
|
|
650 | (1) |
|
|
|
651 | (2) |
|
|
|
652 | (1) |
|
|
|
653 | (25) |
|
Advantages and Disadvantages of Oral Reports |
|
|
654 | (1) |
|
Avoiding Presentation Pitfalls |
|
|
654 | (1) |
|
Planning Your Presentation |
|
|
655 | (3) |
|
|
|
655 | (1) |
|
Work from an Explicit Purpose Statement |
|
|
655 | (1) |
|
Analyze Your Speaking Situation |
|
|
656 | (1) |
|
Select an Appropriate Delivery Method |
|
|
656 | (2) |
|
Preparing Your Presentation |
|
|
658 | (12) |
|
|
|
658 | (1) |
|
Aim for Simplicity and Conciseness |
|
|
658 | (1) |
|
Anticipate Audience Questions |
|
|
659 | (1) |
|
Outline Your Presentation |
|
|
659 | (1) |
|
|
|
660 | (2) |
|
|
|
662 | (1) |
|
Guidelines for Readable Visuals |
|
|
663 | (1) |
|
Guidelines for Understandable Visuals |
|
|
663 | (1) |
|
Consider the Available Technology |
|
|
663 | (3) |
|
Use PowerPoint or other Software Wisely |
|
|
666 | (3) |
|
Guidelines for Using Presentation Software |
|
|
669 | (1) |
|
|
|
669 | (1) |
|
Delivering Your Presentation |
|
|
670 | (8) |
|
Cultivate the Human Landscape |
|
|
670 | (1) |
|
Keep Your Listeners Oriented |
|
|
670 | (1) |
|
|
|
671 | (1) |
|
Guidelines for Presenting Visuals |
|
|
672 | (1) |
|
Manage Your Presentation Style |
|
|
672 | (1) |
|
Manage Your Speaking Situation |
|
|
673 | (1) |
|
Guidelines for Managing Listener Questions |
|
|
674 | (1) |
|
Consider This: Cross-Cultural Audiences May Have Specific Expectations |
|
|
674 | (1) |
|
|
|
675 | (3) |
|
PART VI A Brief Handbook with Additional Sample Documents |
|
|
678 | (2) |
|
APPENDIX A Recording and Documenting Research Findings |
|
|
680 | (38) |
|
|
|
681 | (1) |
|
Guidelines for Recording Research Findings |
|
|
681 | (1) |
|
Quoting the Work of Others |
|
|
682 | (2) |
|
Guidelines for Quoting the Work of Others |
|
|
682 | (2) |
|
Paraphrasing the Work of Others |
|
|
684 | (1) |
|
Guidelines for Paraphrasing |
|
|
684 | (1) |
|
|
|
685 | (1) |
|
|
|
685 | (1) |
|
|
|
686 | (16) |
|
MLA Parenthetical References |
|
|
686 | (1) |
|
|
|
687 | (11) |
|
MLA Sample Works Cited page |
|
|
698 | (4) |
|
|
|
702 | (12) |
|
APA Parenthetical References |
|
|
702 | (1) |
|
APA Reference List Entries |
|
|
703 | (9) |
|
APA Sample Reference List |
|
|
712 | (2) |
|
CBE and Other Numerical Documentation Styles |
|
|
714 | (4) |
|
|
|
714 | (1) |
|
CBE Reference List Entries |
|
|
715 | (3) |
|
APPENDIX B A Casebook of Sample Documents Illustrating the Writing Process |
|
|
718 | (33) |
|
Critical Thinking in the Writing Process |
|
|
719 | (1) |
|
Case 1---An Everyday Writing Situation: The Evolution of a Short Report |
|
|
720 | (9) |
|
Working with the Information |
|
|
721 | (1) |
|
|
|
722 | (1) |
|
|
|
723 | (2) |
|
|
|
725 | (4) |
|
Case 2---Preparing a Personal Statement in an Internship or Fellowship Application |
|
|
729 | (4) |
|
Case 3---Documents for the Course Project: A Sequence Culminating in the Final Report |
|
|
733 | (18) |
|
|
|
734 | (1) |
|
|
|
734 | (1) |
|
The Progress Report Stage |
|
|
734 | (3) |
|
|
|
737 | (14) |
|
APPENDIX C Editing for Grammar, Usage and Mechanics |
|
|
751 | (28) |
|
|
|
752 | (10) |
|
|
|
752 | (1) |
|
|
|
753 | (1) |
|
|
|
754 | (1) |
|
|
|
754 | (1) |
|
Faulty Agreement---Subject and Verb |
|
|
755 | (1) |
|
Faulty Agreement---Pronoun and Referent |
|
|
756 | (1) |
|
|
|
756 | (1) |
|
|
|
757 | (1) |
|
|
|
758 | (1) |
|
|
|
759 | (2) |
|
|
|
761 | (1) |
|
|
|
761 | (1) |
|
|
|
762 | (10) |
|
|
|
762 | (1) |
|
|
|
763 | (1) |
|
|
|
764 | (1) |
|
|
|
764 | (4) |
|
|
|
768 | (2) |
|
|
|
770 | (1) |
|
|
|
771 | (1) |
|
|
|
771 | (1) |
|
|
|
771 | (1) |
|
|
|
771 | (1) |
|
|
|
772 | (1) |
|
|
|
772 | (1) |
|
|
|
773 | (6) |
|
|
|
774 | (2) |
|
|
|
776 | (1) |
|
|
|
776 | (1) |
|
|
|
777 | (1) |
|
|
|
778 | (1) |
| Works Cited |
|
779 | (16) |
| Index |
|
795 | |