Difference between revisions of "Editing and Revising"

From CompSciWiki
Jump to: navigation, search
(Introduction)
(Introduction)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
Having a perfect technical documentation requires revision. In this section, we will go through some steps to help you achieve this goal. Remember, mistakes, be they grammatical or otherwise, provide the reader with an excuse not to read your writing.
+
Imagine you were given a manual on how to fix your car engine. You took the book home, opened it up started reading it. What would make you throw the book away? How would you react if there was no 'Table of Contents'? Would you continue reading the book if there were no definitions on terms such as "carburetor" or "distribution cap"?
 +
 
 +
The analogy provided above is an excellent example of a document that lacks revision. Revision is a writing process that allows you to structure your document so that the reader understands it without having to flip pages, look for dictionaries, or worse, throw away your work!
  
 
== Revision Step 1: Adjust and Reorganize Content ==
 
== Revision Step 1: Adjust and Reorganize Content ==

Revision as of 14:09, 8 April 2008

Introduction

Imagine you were given a manual on how to fix your car engine. You took the book home, opened it up started reading it. What would make you throw the book away? How would you react if there was no 'Table of Contents'? Would you continue reading the book if there were no definitions on terms such as "carburetor" or "distribution cap"?

The analogy provided above is an excellent example of a document that lacks revision. Revision is a writing process that allows you to structure your document so that the reader understands it without having to flip pages, look for dictionaries, or worse, throw away your work!

Revision Step 1: Adjust and Reorganize Content

Revision Step 2: Edit for Style

Revision Step 3: Edit for Grammar

Revision Step 4: Edit for Mechanics