This market-leading text has been thoroughly revised to reflect recent changes in technology, workplace practices and the global marketplace. The book progresses from concepts and basic copyediting to comprehensive editing, management and production issues. Coverage now includes a new chapter on client projects.
Technical Editing takes a comprehensive approach to editing and defining editorial responsibility in terms of information design and the overall effectiveness of a document in helping readers understand and complete tasks. Expanding the concept of editing from a narrow focus on sentence-level revisions for correctness, this book encourages students to think about the effects of word choices, sentences, organization and design. Students learn that the measure of a “good” document is in part outside that document, in the document’s “match” to the users' needs and the author's goals.
The textbook with its supplementary Web site and instructor’s manual offers a complete editing course, including materials for daily workshops and discussion and longer documents for graded assignments. In a password-protected portion of the Web site, instructors can also retrieve illustrations of edited versions as well as suggested responses to daily activities. Both focused and flexible, Technical Editing includes assignments carefully crafted to develop specific editing competencies and modular chapters that allow instructors to adapt the text to meet their own course goals and methods.
Author(s): Carolyn D. Rude
Edition: 4
Publisher: Pearson, Longman
Year: 2006
Language: English
Pages: 480
I. PEOPLE AND PURPOSES.
1. Editing: The Big Picture.
Scenario One: Print Document, In-House Editor.
The Product Team.
Project Definition and Planning.
Writing and Editing.
Publication.
Collaboration of Writer and Editor.
Scenario Two: Online Tutorial, Contract Company.
The Product Team.
Project Definition and Planning: Content, Structure.
Planning for Design and Production.
Editorial Review.
Client Review.
Comment: Editing at BMC Software and SAIC.
Editorial Functions and Responsibilities.
Text Editing.
Preparing Documents for Publication.
Document Development and Production: Summary of the Process.
The Technical Part of Technical Editing.
Technical Subject Matter and Method.
Technical Genres.
In-house or Contract Setting.
Qualifications for Technical Editing.
Using Your Knowledge.
Further Reading.
Discussion and Application.
2. Readers, Users, Browsers, Problem Solvers.
Texts and Contexts.
Origins and Impact: The Problem and Solution.
Readers and Use of the Document.
Culture and Expectations.
Accessibility.
Constraints on Development and Production.
Using Context to Improve the Text.
How Readers Use Documents.
Creating Meaning.
Reading Selectively.
Reading To Comprehend: Content, Signals, Noise.
Content.
Signals.
Undesirable Signals: Noise.
Researching Readers, Usability Testing.
Designing Documents for Use.
Using Your Knowledge.
Notes.
Further Reading.
Discussion and Application.
3. Collaborating with Writers.
Who Are the Writers of Technical Documents?
The Editor—Writer Relationship.
Strategies for Working with Writers.
Edit Effectively.
Manage Efficiently and Communicate Well.
Develop an Attitude of Professionalism.
Correspondence with Writers.
Queries.
Letters of Transmittal.
Email Correspondence and Shared Files.
Corresponding with International Writers.
Using Your Knowledge.
Note.
Further Reading.
Discussion and Application.
II. METHODS AND TOOLS.
4. Marking Paper Copy.
The Symbols of Editorial Markup.
Placing the Marks on the Page.
Marking Consistently.
Distinguishing Marginal Notes from Text Emendations.
Special Problems of Markup.
Punctuation.
Hyphens and Dashes.
Ambiguous Letters and Symbols; Unusual Spellings.
Headings, Tables, References, and Lists.
Illustrations.
Marks for Graphic Design.
Queries to Writers.
Using Your Knowledge.
Further Reading.
Discussion and Application.
5. Marking Digital Copy.
Procedural Markup versus Structural Markup.
Styles and Templates.
Markup Languages for Online Documents.
SGML.
HTML.
XML.
Cascading Style Sheets.
Editing and Information Management.
Using Your Knowledge.
Further Reading.
Discussion and Application.
6. Electronic Editing by David Dayton.
How Do Technical Communicators Edit Online?
What’s It to You?
Benefits of Electronic Editing.
Working Efficiently at a Distance.
Speeding up the Process.
Semi-Automating Tedious Tasks.
Improving Job Satisfaction.
Tradeoffs of Electronic Editing.
The Problem of On-Screen Markup.
Reading Difficulties and Quality Concerns.
Portability and Compatibility Constraints.
The Hazards of Heavy Computer Use.
An Overview of On-Screen Markup and Query Methods.
Automated Typographic Markup.
Manual Typographic Markup.
Electronic Overlay Markup.
Electronic Queries.
Change Tracking in Word: Tips and Techniques.
Configuring and Activating Track Changes.
Tips for Using Track Changes in Word.
Using Your Knowledge.
Acknowledgments.
Notes.
Further Reading.
Websites for Products Mentioned.
Discussion and Application.
III. BASIC COPYEDITING.
7. Basic Copyediting: An Introduction.
Making the Document Correct and Consistent.
Making the Document Accurate.
Making the Document Complete.
Parts of a Book, Manual, or Long Report.
Parts of a Website.
Copyediting Illustrations.
Parts of Illustrations.
Callouts, Legends, Captions, and Footnotes.
Placement of Illustrations in the Text.
Quality of Reproduction.
Copyediting Online Documents.
Steps in Copyediting.
Using Your Knowledge.
Further Reading.
Discussion and Application.
8. Copyediting for Consistency.
Document Consistency.
Verbal Consistency.
Visual Consistency.
Consistency of Mechanics.
Structural Consistency.
Content Consistency.
A Foolish Consistency…
Style Manuals.
Comprehensive Style Manuals.
International Style Manuals.
Discipline Style Manuals.
Organization (“House”) Style Manuals.
Document Style Sheet.
Using Your Knowledge.
Further Reading.
Discussion and Application.
9. Spelling, Capitalization, and Abbreviations.
Spelling.
Guidelines and Tools.
Frequently Misused Words.
International Variations.
Capitalization.
Abbreviations.
Identifying Abbreviations.
Periods and Spaces with Abbreviations.
Latin Terms.
Measurement and Scientific Symbols.
States.
Using Your Knowledge.
Online Resources.
Discussion and Application.
10. Grammar and Usage.
Parts of Speech.
Sentence Structure.
Verbs and Sentence Patterns.
Adjectives, Adverbs, and Modifying Phrases.
Relationships among Words in Sentences.
Subjects and Predicates.
Verb Tense and Sequence.
Modifiers.
Misplaced Modifiers.
Dangling Modifiers.
Pronouns.
Conventions of Usage.
Using Your Knowledge.
Further Reading.
Online Resources.
Discussion and Application.
11. Punctuation.
Clauses, Conjunctions, and Relative Pronouns.
Independent and Dependent Clauses.
Conjunctions.
Relative Pronouns.
Sentence Types and Punctuation.
Punctuating Simple Sentences: Don’t Separate the Subject and Verb with a Single Comma.
Punctuating Compound Sentences: Determine Whether there Is a Coordinating Conjunction.
Punctuating Complex Sentences.
Punctuating Compound-Complex Sentences.
Punctuating Phrases.
Series Comma and Semicolon.
Commas with a Series of Adjectives (Coordinate Adjectives).
Parallelism.
Introductory and Interrupting Phrases.
Punctuation within Words.
The Apostrophe.
The Hyphen.
Marks of Punctuation.
Quotation Marks.
Dash.
Colon.
Ellipsis Points.
Typing Marks of Punctuation to Emulate Typesetting.
Using Your Knowledge.
Further Reading.
Online Resources.
Discussion and Application.
12. Quantitative and Technical Material.
Using Numbers.
Measurement.
Marking Mathematical Material.
Fractions.
Equations.
Copymarking for Typesetting.
Statistics.
Tables.
General Guidelines.
Application: Editing a Table.
Standards and Specifications.
Using Your Knowledge.
Note.
Further Reading.
Discussion and Application.
13. Proofreading.
Distinguishing Proofreading from Copyediting.
The Value and Goals of Proofreading.
Proofreading Marks and Placement on the Page.
Using Your Knowledge.
Further Reading.
Online Resource.
Discussion and Application.
IV. COMPREHENSIVE EDITING.
14. Comprehensive Editing: Definition and Process.
Example: Copyediting versus Comprehensive Editing.
The Process of Comprehensive Editing.
Analyze the Document’s Purpose, Readers, and Uses.
Evaluate the Document.
Establish Editing Objectives.
Review Your Editing Plans with the Writer.
Complete the Editing.
Evaluate the Outcome.
Review the Edited Document with the Writer or Product Team.
Application: The Service Call Memo.
Analysis.
Evaluation.
Editing Objectives.
The Outcome of Editing.
Determining whether Comprehensive Editing is Warranted.
Using Your Knowledge.
Further Reading.
Discussion and Application.
15. Style: Definition and Sentence Structures.
Definition of Style.
Writer’s Persona and Tone.
Style and Comprehension.
Example: Analysis of Style.
Guidelines for Editing for Style.
Context: Make Style Serve Readers and Purpose.
Sentence Structures: Use Structure to Reinforce Meaning.
Place the Main Idea of the Sentence in the Structural Core.
Use Subordinate Structures for Subordinate Ideas.
Use Parallel Structure for Parallel Items.
Sentence Arrangement.
Place the Subject and Verb Near the Beginning of the Sentence.
Arrange Sentences for End Focus and Cohesion.
Prefer S-V-O or S-V-C Word Order.
Sentence Length and Energy.
Adjust Sentence Length to Increase Readability.
Use People as Agents When Possible.
Prefer Positive Constructions.
Using Your Knowledge.
Further Reading.
Discussion and Application.
16. Style: Verbs and Other Words.
Verbs: Convey the Action in the Sentence Accurately.
Build Sentences around Action Verbs.
Choose Strong Verbs.
Avoid Nominalizations.
Prefer the Active Voice.
Use Concrete, Accurate Nouns.
Prefer Single Words to Phrases or Pairs and Simple to Complex Words.
Application: Editing for Style.
Analysis.
Evaluation and Review.
The Language of Discrimination.
Application: Discriminatory Language.
Editing for a Nonsexist Style.
Using Your Knowledge.
Further Reading.
Discussion and Application.
17. Organization: The Architecture of Information.
Organization for Performance: Task-Based Order.
Organization for Comprehension: Content-Based Order.
Principles of Content Organization.
Follow Pre-Established Document Structures.
Anticipate Reader Questions and Needs.
Arrange from General to Specific and Familiar to New.
Use Conventional Patterns of Organization:
Match Structure to Meaning.
Group Related Material.
Use Parallel Structure for Parallel Sections.
Paragraph Organization.
Linking Sentences.
Repetitions and Variations.
Application: The Problem Statement for a Research Proposal.
Organizing for Reuse.
Using Your Knowledge.
Further Reading.
Discussion and Application.
18. Visual Design.
Definitions of Terms Related to Visual Design.
Visual Design Options.
Page layout.
Type.
Display of information.
Structural Signals, Navigation.
Functions of Visual Design.
Comprehension.
Usability.
Motivation.
Headings.
Wording.
Levels of Headings.
Frequency of Headings.
Application: Radar Target Classification Program.
Using Your Knowledge.
Further Reading.
Discussion and Application.
19. Editing Illustrations.
What Illustrations Do.
Help Readers Understand and Use Information.
Motivate Readers, Convey Values.
Types of Illustrations.
Editing Illustrations for Accuracy and Clarity: Content, Organization, and Style.
Content: Appropriateness and Number, Accuracy and Clarity.
Match of Form, Content, and Purpose=.
Organization: Sequential and Spatial.
Style: Discriminatory Language and Good Taste.
Editing for Graphic Elements.
Emphasis and Detail.
Perspective, Size, and Scale.
Maximizing Data Ink.
Integrating Text and Illustrations.
Placement on the Page or Screen.
Nonverbal Instructions.
Application: Cassette Instructions.
Preparing Illustrations for Print or Online Display.
Using Your Knowledge.
Further Reading.
Discussion and Application.
20. Editing for Global Contexts.
Preparing Documents for a Global Workplace.
International Rhetorical Expectations.
Globalization versus Localization.
Globalization.
Terminology Management and Controlled Language.
International English.
Using Visual Instructions.
Localization.
Translation.
Writing to Facilitate Translation: Minimize Ambiguity.
Translation Quality.
Machine Translation.
Other Localization Tips.
Researching Social and Cultural Information.
Using Your Knowledge.
Further Reading.
Discussion and Application.
21. Editing Websites.
Websites as Content Repositories and Databases.
Reading and Searching Online.
Planning and Developing Websites.
Defining the Concept and Specifications.
Templates.
Style Guide.
Making Content Work for Readers.
Organization.
Navigation and Searching.
Screen Design and Color.
Effects of Hardware and Software on Screen Design Choices.
Legibility of Type.
Visual Consistency and Simplicity.
Style.
Usability Testing and Accessibility.
Maintenance and Updates.
Using Your Knowledge.
Further Reading.
Online Resources.
Discussion and Application.
V. MANAGEMENT AND PRODUCTION.
22. Legal and Ethical Issues in Editing.
Legal Issues in Editing.
Intellectual Property: Copyright, Trademarks, Patents, Trade Secrets.
Copyright.
Permissions and “Fair Use”.
Copyright and Online Publication.
Trademarks, Patents, and Trade Secrets.
Product Safety and Liability.
Libel, Fraud, and Misrepresentation.
Ethical Issues in Editing.
Users, Clients, and Employers.
Misrepresentation of Content or Risks.
Professional Codes of Conduct.
Environmental Ethics.
Bases for Ethical Decisions.
Establishing Policies for Legal and Ethical Conduct.
Using Your Knowledge.
Further Reading.
Discussion and Application.
23. Type and Production.
Working with Type.
Fonts and Their Uses.
Font Selection.
Type Size.
Leading, Letterspacing, Wordspacing, and Line Length.
Design Tips for Beginning Designers.
Working with Illustrations.
Halftones.
Resolution.
Correction of Photographs.
Photographic Releases from Subjects.
Choosing Paper.
Understanding the Production Process for Print Documents.
Desktop Publishing and Digital Printing.
Fullscale Commercial Services: Typesetting, Page Makeup, and Offset Printing.
Binding.
Working with Commercial Printers.
Obtaining a Quotation from a Printer.
Delivering Materials to the Printer.
Using Your Knowledge.
Acknowledgment.
Further Reading.
Discussion and Application.
24. Project Management with Heather Eisenbraun.
The Case for Managing the Document Development Process.
The Life-Cycle Model of Publications Development.
Planning.
Estimating Time and Developing Budgets.
Classification of Editorial Tasks and Responsibilities.
Record Keeping.
Sampling.
Setting Priorities.
Document Scheduling and Tracking.
Scheduling.
Tracking the Document through Development and Production.
Version Control.
Evaluation.
Setting Policy.
Project Management for Online Documents.
Using Your Knowledge.
Notes.
Further Reading.
Discussion and Application.
25. Client Projects.
Selecting a Good Project.
Establishing a Contract.
Conferencing with the Writer or Client.
Conference Organization.
Review of the Edited Document.
The Language of Good Relationships.
Furniture Arrangement.
Presenting the Project Orally.
Discussion and Application.
