Foreword By the Series Editor |
|
xiii | |
Preface |
|
xiv | |
|
PART 1 PEOPLE AND PURPOSES |
|
|
1 | (46) |
|
|
3 | (16) |
|
Scenario One: Print Document, In-House Editor |
|
|
4 | (3) |
|
Scenario Two: Online Tutorial, Contract Company |
|
|
7 | (4) |
|
Comment: Editing at BMC Software and SAIC |
|
|
11 | (1) |
|
Editorial Functions and Responsibilities |
|
|
11 | (3) |
|
Document Development and Production: Summary of the Process |
|
|
14 | (1) |
|
The Technical Part of Technical Editing |
|
|
15 | (1) |
|
Qualifications for Technical Editing |
|
|
16 | (1) |
|
|
17 | (1) |
|
|
17 | (1) |
|
|
17 | (1) |
|
Discussion and Application |
|
|
18 | (1) |
|
Readers, Users, Browsers, Problem Solvers |
|
|
19 | (16) |
|
|
20 | (4) |
|
How Readers Use Documents |
|
|
24 | (2) |
|
Reading to Comprehend: Content, Signals, Noise |
|
|
26 | (4) |
|
Researching Readers, Usability Testing |
|
|
30 | (1) |
|
Designing Documents for Use |
|
|
30 | (1) |
|
|
31 | (1) |
|
|
31 | (1) |
|
Discussion and Application |
|
|
32 | (3) |
|
Collaborating with Writers |
|
|
35 | (12) |
|
Who Are the Writers of Technical Documents? |
|
|
35 | (1) |
|
The Editor-Writer Relationship |
|
|
36 | (1) |
|
Strategies for Working with Writers |
|
|
37 | (4) |
|
Correspondence with Writers |
|
|
41 | (3) |
|
|
44 | (1) |
|
|
44 | (1) |
|
Discussion and Application |
|
|
44 | (3) |
|
|
47 | (58) |
|
|
49 | (17) |
|
The Symbols of Editorial Markup |
|
|
50 | (7) |
|
Special Problems of Markup |
|
|
57 | (2) |
|
|
59 | (2) |
|
|
61 | (2) |
|
|
63 | (1) |
|
|
63 | (1) |
|
Discussion and Application |
|
|
63 | (3) |
|
|
66 | (17) |
|
Procedural Markup versus Structural Markup |
|
|
67 | (1) |
|
|
68 | (3) |
|
Markup Languages for Online Documents |
|
|
71 | (7) |
|
|
78 | (2) |
|
Editing and Information Management |
|
|
80 | (1) |
|
|
81 | (1) |
|
|
81 | (1) |
|
|
81 | (1) |
|
Discussion and Application |
|
|
82 | (1) |
|
|
83 | (22) |
|
|
How Do Technical Communicators Edit Online? |
|
|
85 | (2) |
|
Benefits of Electronic Editing |
|
|
87 | (1) |
|
Tradeoffs of Electronic Editing |
|
|
88 | (5) |
|
An Overview of On-Screen Markup and Query Methods |
|
|
93 | (5) |
|
Change Tracking in Word: Tips and Techniques |
|
|
98 | (3) |
|
|
101 | (1) |
|
|
102 | (1) |
|
|
102 | (1) |
|
Websites for Products Mentioned |
|
|
102 | (1) |
|
Discussion and Application |
|
|
103 | (2) |
|
|
105 | (124) |
|
Basic Copyediting: An Introduction |
|
|
107 | (17) |
|
Making the Document Correct and Consistent |
|
|
108 | (1) |
|
Making a Document Accurate |
|
|
109 | (1) |
|
Making a Document Complete |
|
|
110 | (3) |
|
Copyediting Illustrations |
|
|
113 | (5) |
|
Copyediting Online Documents |
|
|
118 | (1) |
|
|
119 | (2) |
|
|
121 | (1) |
|
|
121 | (1) |
|
Discussion and Application |
|
|
121 | (3) |
|
Copyediting for Consistency |
|
|
124 | (15) |
|
|
125 | (6) |
|
|
131 | (6) |
|
|
137 | (1) |
|
|
137 | (1) |
|
Discussion and Application |
|
|
138 | (1) |
|
Spelling, Capitalization, and Abbreviations |
|
|
139 | (13) |
|
|
139 | (6) |
|
|
145 | (1) |
|
|
146 | (3) |
|
|
149 | (1) |
|
|
149 | (1) |
|
Discussion and Application |
|
|
150 | (2) |
|
|
152 | (21) |
|
|
153 | (1) |
|
|
153 | (5) |
|
Relationships of Words in Sentences |
|
|
158 | (2) |
|
|
160 | (2) |
|
|
162 | (1) |
|
|
163 | (2) |
|
|
165 | (1) |
|
|
166 | (1) |
|
|
167 | (1) |
|
|
167 | (1) |
|
Discussion and Application |
|
|
168 | (5) |
|
|
173 | (24) |
|
Clauses, Conjunctions, and Relative Pronouns |
|
|
173 | (3) |
|
Sentence Types and Punctuation |
|
|
176 | (5) |
|
|
181 | (4) |
|
|
185 | (3) |
|
|
188 | (2) |
|
|
190 | (1) |
|
|
191 | (1) |
|
|
191 | (1) |
|
Discussion and Application |
|
|
192 | (5) |
|
Quantitative and Technical Material |
|
|
197 | (17) |
|
|
197 | (1) |
|
|
198 | (1) |
|
Marking Mathematical Material |
|
|
199 | (5) |
|
|
204 | (1) |
|
|
205 | (5) |
|
Standards and Specifications |
|
|
210 | (1) |
|
|
211 | (1) |
|
|
211 | (1) |
|
Discussion and Application |
|
|
212 | (2) |
|
|
214 | (15) |
|
Distinguishing Proofreading from Copyediting |
|
|
214 | (1) |
|
The Value and Goals of Proofreading |
|
|
215 | (3) |
|
Proofreading Marks and Placement on the Page |
|
|
218 | (6) |
|
|
224 | (1) |
|
|
225 | (1) |
|
|
225 | (1) |
|
Discussion and Application |
|
|
225 | (4) |
|
PART 4 COMPREHENSIVE EDITING |
|
|
229 | (152) |
|
Comprehensive Editing: Definition and Process |
|
|
231 | (19) |
|
Example: Copyediting versus Comprehensive Editing |
|
|
232 | (4) |
|
The Process of Comprehensive Editing |
|
|
236 | (4) |
|
Application: The Service Call Memo |
|
|
240 | (5) |
|
Determining Whether Comprehensive Editing Is Warranted |
|
|
245 | (1) |
|
|
246 | (1) |
|
|
246 | (1) |
|
Discussion and Application |
|
|
246 | (4) |
|
Style: Definition and Sentence Structures |
|
|
250 | (16) |
|
|
251 | (1) |
|
Example: Analysis of Style |
|
|
251 | (2) |
|
Guidelines for Editing for Style |
|
|
253 | (1) |
|
Context: Make Style Serve Purpose and Readers |
|
|
254 | (1) |
|
Sentence Structures: Use Structure to Reinforce Meaning |
|
|
254 | (3) |
|
|
257 | (2) |
|
Sentence Length and Energy |
|
|
259 | (3) |
|
|
262 | (1) |
|
|
262 | (1) |
|
Discussion and Application |
|
|
263 | (3) |
|
Style: Verbs and Other Words |
|
|
266 | (18) |
|
Verbs: Convey the Action in the Sentence Accurately |
|
|
266 | (5) |
|
Use Concrete, Accurate Nouns |
|
|
271 | (2) |
|
Application: Editing for Style |
|
|
273 | (3) |
|
The Language of Discrimination |
|
|
276 | (5) |
|
|
281 | (1) |
|
|
281 | (1) |
|
Discussion and Application |
|
|
281 | (3) |
|
Organization: The Architecture of Information |
|
|
284 | (20) |
|
Organization for Performance: Task-Based Order |
|
|
285 | (1) |
|
Organization for Comprehension: Content-Based Order |
|
|
286 | (1) |
|
Principles of Content Organization |
|
|
287 | (6) |
|
|
293 | (1) |
|
Application: The Problem Statement for a Research Proposal |
|
|
294 | (6) |
|
|
300 | (1) |
|
|
300 | (1) |
|
|
300 | (1) |
|
Discussion and Application |
|
|
301 | (3) |
|
|
304 | (19) |
|
Definitions of Terms Related to Visual Design |
|
|
305 | (1) |
|
|
306 | (3) |
|
Functions of Visual Design |
|
|
309 | (3) |
|
|
312 | (1) |
|
Application: Radar Target Classification Program |
|
|
313 | (6) |
|
|
319 | (1) |
|
|
320 | (1) |
|
Discussion and Application |
|
|
321 | (2) |
|
|
323 | (24) |
|
|
323 | (2) |
|
|
325 | (1) |
|
Editing Illustrations for Accuracy and Clarity: Content, Organization, and Style |
|
|
325 | (5) |
|
Editing for Graphic Elements |
|
|
330 | (4) |
|
Integrating Text and Illustrations |
|
|
334 | (1) |
|
Application: Cassette Instructions |
|
|
335 | (5) |
|
Preparing Illustrations for Print or Online Display |
|
|
340 | (2) |
|
|
342 | (2) |
|
|
344 | (1) |
|
Discussion and Application |
|
|
344 | (3) |
|
Editing for Global Contexts |
|
|
347 | (20) |
|
|
Preparing Documents for a Global Workplace |
|
|
347 | (1) |
|
International Rhetorical Expectations |
|
|
348 | (1) |
|
Globalization versus Localization |
|
|
349 | (1) |
|
|
349 | (6) |
|
|
355 | (1) |
|
|
355 | (9) |
|
Researching Social and Cultural Information |
|
|
364 | (1) |
|
|
365 | (1) |
|
|
365 | (1) |
|
Discussion and Application |
|
|
365 | (2) |
|
|
367 | (14) |
|
Websites as Content Repositories and Databases |
|
|
368 | (1) |
|
Reading and Searching Online |
|
|
369 | (1) |
|
Planning and Developing Websites |
|
|
370 | (2) |
|
Making Content Work for Readers |
|
|
372 | (1) |
|
|
373 | (1) |
|
|
374 | (1) |
|
|
375 | (2) |
|
|
377 | (1) |
|
Usability Testing and Accessibility |
|
|
377 | (1) |
|
|
378 | (1) |
|
|
378 | (1) |
|
|
379 | (1) |
|
|
379 | (1) |
|
Discussion and Application |
|
|
380 | (1) |
|
PART 5 MANAGEMENT AND PRODUCTION |
|
|
381 | (71) |
|
Legal and Ethical Issues in Editing |
|
|
383 | (15) |
|
|
384 | (4) |
|
Ethical Issues in Editing |
|
|
388 | (6) |
|
Establishing Policies for Legal and Ethical Conduct |
|
|
394 | (1) |
|
|
395 | (1) |
|
|
395 | (1) |
|
Discussion and Application |
|
|
396 | (2) |
|
|
398 | (21) |
|
|
398 | (8) |
|
Working with Illustrations |
|
|
406 | (2) |
|
|
408 | (2) |
|
Understanding the Production Process for Print Documents |
|
|
410 | (5) |
|
Working with Commercial Printers |
|
|
415 | (2) |
|
|
417 | (1) |
|
|
417 | (1) |
|
|
418 | (1) |
|
Discussion and Application |
|
|
418 | (1) |
|
|
419 | (19) |
|
|
The Case for Managing the Document Development Process |
|
|
420 | (1) |
|
The Life-Cycle Model of Publications Development |
|
|
421 | (1) |
|
Planning and Content Specifications |
|
|
421 | (1) |
|
Estimating Time and Developing Budgets |
|
|
422 | (6) |
|
Document Scheduling and Tracking |
|
|
428 | (6) |
|
|
434 | (1) |
|
|
434 | (1) |
|
|
435 | (1) |
|
|
435 | (1) |
|
|
435 | (1) |
|
Discussion and Application |
|
|
435 | (3) |
|
|
438 | (14) |
|
|
438 | (1) |
|
Project Plans and Proposals |
|
|
439 | (3) |
|
|
442 | (1) |
|
Conferencing with the Writer or Client |
|
|
442 | (5) |
|
Presenting the Project Orally |
|
|
447 | (2) |
|
|
449 | (1) |
|
|
450 | (1) |
|
Discussion and Application |
|
|
450 | (2) |
Glossary |
|
452 | (11) |
Index |
|
463 | |