When you are satisfied with the organization of your document,
review your document to ensure that all information is accurate,
complete, and comprehensible. Check to see that the information is relevant to your document's purpose and to your audience's
use. The efficient exchange of information from writer to reader is one of the main objectives
of all technical writing.
Because revising content may significantly
alter parts of a document, experienced writers review and revise the content thoroughly before they
begin to edit for style, usage, grammar, punctuation, and spelling.
Questions About Content
Read through your draft slowly, stopping at the end of each section,
and ask yourself the following questions:
- Is the information accurate?
- Are there any incorrect data entries?
- Are all outside sources documented? Is all
information from outside sources either paraphrased or quoted exactly and
enclosed in quotation marks?
- Are any graphics misleading?
- Add up all tables in both the horizontal and the vertical directions to make
sure the numbers balance. Similarly, add up all percentages in graphics and tables to check, if appropriate, that
they add up to 100 percent.
- Is the information complete? Have you omitted any facts, concepts, equations or processes
necessary for the document's aim and for the audience type and the audience's purpose?
- Is all quantitative information presented fully?
- Are all concepts explained in the detail appropriate for the document's aim
and for the audience type and the audience's purpose?
- Are there any steps missing from instructions, procedures, or descriptions of processes?
- Is any irrelevant information included in the document?
- Is the information comprehensible to your audience?
- Are all technical terms that need to be
defined for your audience clearly defined?
- Are all technical terms used correctly?
- Are all technical terms used consistently?
- Do you always use the same term to refer to something?
- Are all acronyms explained when first
- Is the density of information appropriate to the expertise and purpose of your audience?
Strategies for Revising Content
- Correct any inaccurate quantitative data or other information.
- Add further information, explanations of concepts and processes, and instructions necessary for your document's aim and audience.
- Delete from the body of the document any information
that is unessential and unimportant to most of your readers. If the information will
be important to some of your readers, include it in one or more appendixes.
- Clarify technical terms.
- Replace any term that is used incorrectly.
- Replace any vague terms.
- If a single term is used to refer to two or more separate items, replace the
term with separate terms for each item.
- If two or more terms are used to refer to a single item, choose the best term
and replace all occurrences of the other terms with the one you have
- The first time you use an acronym or an
abbreviation that may not be familiar to
all your readers, write out the complete term followed by the acronym or
abbreviation in parentheses.
- Consider adding a glossary if you use many
terms with which some readers may not be familiar.
- Separate important technical terms and concepts so that your audience may easily digest the material.
## Revising Content ##
[ Home | Table of Contents
| Writing Timeline | Index |
Help | Credits]