Editing and Revising

From CompSciWiki
Revision as of 13:27, 8 April 2008 by Aliasger (Talk | contribs)

Jump to: navigation, search

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

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