Guide to technical editing: discussion, dictionary, and exercises/ Anne Eisenberg.

Includes index.

DISCUSSION 1
1. Edit for organization that shows main points and significance.
State the idea before its explanation.
In longer documents, try statements of main ideas and significance at the top of the document, at the top of complicated sections, and before any complicated paragraph or
series of paragraphs.
Focus vague language.
Trim procedural detail in summaries or abstracts to leave room
for main points.
2. Edit for titles, headings, and subheadings that mark main points and their order.
Use the title to give the objective.
Cast the title in the active voice to emphasize the subject/ agent, in the passive to emphasize the object.
Use headings and subheadings to mark main points
and major divisions.
Use titles, headings, and subheadings to group tasks
or long lists.
Keep headings and subheadings brief, informative, and
parallel. 18 Combine explicit introductory statements of main ideas with headings and subheadings to mark the path of the argument.
Make sure the first sentence following the heading is
complete.
Use listing to give each step a distinct visual identity.
Make cautions, warnings, and notes stand out.
3. Edit for definitions crucial to reader understanding.
insert a definition with parentheses, dashes, and expressions like "that is," "called," "known as," or "is defined as."
Write out abbreviations and acronyms on first use.
Use a consistent type style to introduce key terms.
Consider an example to clarify a definition.
Consider a comparison to clarify an explanation.
Consider an analogy, metaphor, or figure to clarify an explanation.
4. Edit for a concise, consistent style.
Trim unnecessary words. 30 Tighten sentences that sprawl.
Revise paragraphs that sprawl.
Avoid negatives.
Select for voice.
Check for consistency.
Scan for common errors in grammar, punctuation, and usage: I.
Scan for common errors in grammar, punctuation,
and usage
5. Edit for tables that display data vividly and concisely.
Use informative, visually distinct titles.
Show parts of the whole in the stub column.
Use field column heads to show primary comparisons horizontally.
Align columns vertically by a common element.
Use zeros and rounded numbers in tables for precision, not
decoration.
Use footnotes for explanatory details, abbreviations, sources,
statistical significance, and units of measure that don’t fit
in column heads.
Keep wording concise.
In charts and displayed lists, use a design that helps readers see and compare the basic groups within the data.
6. Edit for figures that identify and explain.
Number figures; cite the number on first reference in the text.
Use captions, labels, and arrows to identify and explain
figures.
Explain divisions of complicated figures. Keep wording
parallel.
Explain all abbreviations, acronyms, and symbols.
Explain any arrows, pointers, or special signs.
Make sure the information in the caption and callout is consistent with the information in the text.
7. Edit for completeness, accuracy, and consistency.
Check for consistency between table or figure designator (Table 1) and in-text citation (See Table I).
Check for consistency between data discussed in narrative and data displayed in tables.
Check for consistency between figure captions and narrative.
Check accuracy of people’s names, titles, affiliations, and any
abbreviations of this information.
Check accuracy of names of organizations or agencies.
Check accuracy of publication names.
Check all abbreviations for technical terms.
Check all technical nomenclature.
Check to make sure references are complete and consistent.
Check for consistency in size and face of type used in
headings and subheadings.
Check for consistency in format of displayed lists.
DICTIONARY
EXERCISES
1. Edit for organization that shows main points and significance.
2. Edit for titles, headings, and subheadings that mark main points and their order.
3. Edit for definitions crucial to reader understanding.
4. Edit for a concise, consistent style.
5. Edit for tables that display data vividly and concisely.
6. Edit for figures that identify and explain.
7. Edit for completeness, accuracy, and consistency.
8. Final exercise: edit for a combination of errors.