|
| |
Hints and Tips
Top 10 Editing Basics
As you edit, keep in mind the document’s audience and purpose.
-
Read through the document initially to make sure the information
flows, makes sense, and contains no glaring errors. Check
 |
Clarity
|
|
|
Consistency |
|
|
Mechanics (grammar, punctuation, and spelling)
 |
Check up-to-date spelling and usage with national newspapers and
the Internet
|
|
-
Create a checklist of possible errors and read the document more
critically.
-
Impose consistency on the document using a style guide.
-
Improve the organization of the document.
|
|
Attach a template |
|
|
Use parallel construction for lists—consistent form and function |
-
Break blocks of text into bite-sized pieces and use
|
|
Headings |
|
|
Bulleted/numbered lists |
|
|
Tables |
-
Check word choices. Ensure the use of
|
|
Correct words |
|
|
Strong verbs |
|
|
Active voice |
|
|
Plain
English—not jargon |
|
|
Consistent terminology when describing the same items or concepts |
-
Tighten the writing.
|
|
KISS
|
|
Short words (simple, direct) |
|
|
Short sentences (20–30 words maximum) |
|
|
Short paragraphs |
|
|
|
Eliminate obvious, needless, or redundant information |
-
Correct the use of too many prepositions in one sentence.
-
Pay
particular attention to transitions—add them if they are missing.
-
Use
grammar/spelling checker, but do not rely on them—proof carefully.
10
Technical Writing Standards*
Good Technical Writing is
|
|
Technically
accurate |
|
|
Useful |
|
|
Complete |
|
|
Concise |
|
|
Clear
|
|
|
Consistent |
|
|
Correct |
|
|
Targeted |
|
|
Well organized |
|
|
Interesting |
|
* Blake, G & Bly, R
Elements of Technical Writing 1993 |
