Hints and Tips

• General Writing Principles

• Top 50 Misspelled Words

• Online Help Basics

• Top 10 Editing Basics

• Print Preparation Basics

• Writing Subheads, Captions, and Closings

• Commonly Confused Words

Top 10 Editing Basics

As you edit, keep in mind the document’s audience and purpose.

1. 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

2. Create a checklist of possible errors and read the document more critically.

3. Impose consistency on the document using a style guide.

4. Improve the organization of the document.

• Attach a template

• Use parallel construction for lists—consistent form and function

5. Break blocks of text into bite-sized pieces and use

• Headings

• Bulleted/numbered lists

• Tables

6. 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

7. Tighten the writing.

• KISS

  • Short words (simple, direct)

  • Short sentences (20–30 words maximum)

  • Short paragraphs

• Eliminate obvious, needless, or redundant information

8. Correct the use of too many prepositions in one sentence.

9. Pay particular attention to transitions—add them if they are missing.

10. 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