New Page 3

Klariti Home Page

Download Templates Online

Buy in Euros Buy in Pound Sterling Buy in Australian Dollars Buy in Chinese Renminbi

About Us Free Tools Tips Templates Affiliates Site Map

MS Word template

Get Your Template
Get this Proposal Template - Instant Download
Buy this template - Instant Download


Why You Need to Revise 5 Times

Even though all documentation needs to be revised at least once, for business critical documents, you need to revise your material in detail several times.

Ideally, you should revise documents five separate times: each time you read it, adopt a different reviewer's view and examine different areas.

Revision 1. Content and Emphasis

Identify what information is missing. Remove sections that dont alter the overall meaning of the document. Check that you have emphasized the important ideas, and de-emphasized the lesser ones. If you are under tight deadlines and can only give it one revision, check for content and emphasis.

Revision 2. Clarity

If you have time for two passes, check for clarity next. Study if the organization is logical, and that it helps the reader to understand the content. Keep sentences straightforward and use words understandable to the reader. Ensure that the transition from one section to the next is effective.

Revision 3. Correctness

In the third pass, look for grammar, word choice, spelling, punctuation, and sentence structure problems.

Revision 4. Brevity

Then shorten wordy phrases, eliminate unnecessary sentences, combine or delete unimportant ideas. Tighten up the text.

Revision 5. Style

The last revision is to work on style. In technical writing style is not much of an issue as the company Style Guide often prescribes the writing style. If you can use your own voice, be aware of your style and make sure it works for the piece you're writing.

and then proofread.

Proofreading means rechecking the facts every time content moves from one production phase to another.

For example, if you produce it in Microsoft Word and import it into Adobe PageMaker, conversion and text flow problems will arise. (Believe me, they will!).

These problems are usually caused by differences in font sets, unrecognized automatic functions, and other software differences.

When proofreading, look out for

  • Missing content, such as last lines in paragraphs, missing last paragraphs in a column, and missing words at the ends of lines
  • Extra hyphens and spaces inserted in odd places
  • Improperly converted symbols
  • Incorrect functions, such as figure/page numbering, running headers, or cross referencing
  • Font substitutions
  • Spelling errors that spell checkers don't find, such as form instead of from
  • Faulty alignment, especially in tables and in text associated with graphics
  • Missing and corrupt graphics.
  • Check graphics that display on the screen, but dont print out

Lastly, ask an experienced person to look at it. Your colleague will probably see things that may have escaped you.


Biz Templates: Proposal Template  RFP Template  Project Management  Proposal Manager Toolkit  SOPs

IT Templates: Software Development Templates  Testing (QA) Templates  Training Plan Template

Sales Templates: White Paper Templates   Case Study Templates

Special Offers: White Paper + Proposal  Proposal + Mgr Toolkit  Proposal + Case Study

$ 9.99: Acceptance Test Plan  Design Document  Functional Rqmnts Spec  Test Plan   User Guide   More >>>.


Ads
Template Shop

Bestsellers / Special Offers

Software Development PackDownload our new template

Software Testing Templates

Case Study Templates

Design Document

Documentation Plan

Policy ManualDownload our new template

Project Management

Proposal Template

Proposal Manager Toolkit

RFP (ITT) Template

SOPs / ProcedureDownload our new template

Test Plan

Training Plan

User Guide TemplateDownload our new template

White Paper Templates
Most Popular
Blog / MS Word Templates

Books / Software

Tech Writing / RFPs and Proposals

Business Writing
Tech Writing
Technical Writing
Business Writing
Business Writing
Proposal Writing
RFPs, ITTs, Proposals
Project Management
Project Management
White Papers
White Papers
Grant Writing
Grant Writing
Adobe Framemaker
FrameMaker to Word Conversion
Free PDF Conversion Service
A-Z Framemaker
Framemaker Training
Writers Resources
Education
Writing for the Web
Content Development
Information Architecture
Mailing Lists
Text Mining
Writing Organizations
Others
Writer's Guidelines
Copyright Free Articles
Technical Writing Ireland
10 Years As A Tech Writer