Better Writing
Compact, precise and literal writing is desirable in most disciplines, but is essential in technical fields. Wordy, imprecise and metaphoric text dilutes and confuses the reader of a technical document. In this exercise we will work on improving our skills.
-
Checklist for concise writing:
- Eliminate small words: Scan each sentence for groups of small words. Often the sentence can be re-worded to eliminate them. Goal: increase average character count per words.
- Avoid gratuitous adjectives and adverbs unless they are
reallyneeded: Remove adjectives and adverbs that only vaguely help the reader. Goal: Really, truly, eliminate unneeded adjectives and adverbs. - Remove redundant sentences: Scan each paragraph for sentences that don't carry their own weight. Goal: Each sentence should be essential so that, if you remove it, the paragraph will not make sense.
- Remove redundant paragraphs: Do for paragraphs what you did for sentences.
- Tips for Compact Writing: Grammar Girl , Mignon Fogarty
- Technical Writing Overview: Overview , David A. McMurrey.
- A Template for Writing an Original Technical Report: Primary Research Report , David A. McMurrey.
- Writing Tips: Three Sins of Authors in Computer Science and Math , Jonathan Shewchuk.
Exercises
- Identify three elements of your survey paper that are out of sync with the suggestions in the above links.
- Revise your text for better alignment.
- Turn in both the original and revised text on assigned due date.