Home
Home Template Shop Tech Writing Biz Writing  

Google Custom Search

C:\Program Files\WS_FTP\klariti 06\a.html
Side Menu
Blog
Template Shop
Book Shop Our FREE Affiliate Program Pays You 50% Commission!
Template Shop

Bestsellers
Special Offers
Software Development  Pack
QA Templates
Case Study Templates
Project Management
Proposal Template
Proposal Manager Toolkit
RFP (ITT) Template
White Paper Templates
Recommended Reading
How to Write a Business Plan Report Writing Toolkit Report Writing Toolkit
Create Special Reports
E-Newsletters That Work
Read About...
Technical Writing
RFPs, ITTs, Proposals
Business Writing
Project Management Report Writing Toolkit
White Papers
Grant Writing
FrameMaker
FrameMaker to Word Conversion
Template Design
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

 

 

 



Technical Writing - Technical Editing Visit the Template Shop
___________________________________________________________________

What is Technical Editing?

Technical Editing involves the proofing of a technical document, (for example, a System Administration Guide), against the original specifications to ensure that the facts are accurate.

This includes checking that every instruction, procedure, hyperlink and graphic corresponds to what is in the application.

There are three levels of technical editing:

1. Editing the text for grammatical, spelling, and style errors.

2. Editing the organization of content, emphasis, appropriateness of content and adherence to standards and guidelines.

3. Editing for the accuracy of content.

Why editing and proofreading are not the same

Proofreading (which usually is carried out in conjunction with editing) is checking the final draft to ensure that all of the previous editing has made it into that document.

As there can be many breakdowns in communications, and technical glitches, editing ensures that all content - in the correct format - has made it to the final draft.

When editing, things to watch out for include:

  • Wrong graphics or graphics in the wrong location.

  • Style-sheets that have broken down.

  • Errors in the Table of Contents.

  • Indexes that have not been updated.

Technical editing is the final task before releasing the final document.

Editing Is Very Demanding 

There are several stages in the editing cycle. In addition to those three levels mentioned above, you also need to consider the following:

  • Content editing, i.e. checking facts, assessing the document's purpose

  • Line-editing, i.e. going through the document to check the use of language, visual presentation and other details

As editing is so demanding, it is best to breakdown the process into smaller procedures (and use checklists and cheat-sheets) and check-off the tasks as you work down the document.

If you try to edit the entire document in one pass, you will be overwhelmed. Small steps are more effective. Pace yourself on large projects.

Some books worth getting include:

  • Anne Eisenberg - (Oxford University Press) Guide to Technical Editing
  • Arthur Plotnik - (MacMillan) The Elements of Editing

Finally, version control and code-tracking software are recommended for any large–scale or collaborative projects.

If you do not have version control in place, you are exposing yourself to complete document mismanagement. This can result in the wrong document, with the wrong edits, making it into the final published draft.

Be careful out there!

INSTANT DOWNLOAD
Visit the Template ShopINSTANT DOWNLOAD!

Visit the Template Store and get your royalty-free templates.
Case Study Templates, 50 PM Templates, Proposal Template, Toolkit, RFP Template Software Template, QA Testing, White Paper Templates
. Go Shop!


footer

TEMPLATE SHOP | Software Development Template Packs | Proposal Manager Toolkit       

Project Management Templates | Proposal Template | RFP Template Great deals on Project Managment, White Papers, Proposal, and Software Templates for only $9.99.| Case Study Template Pack

IT Solutions for Sarbanes Oxley Act |  Assessment Tests | White Paper Template Pack

Google
Web

www.klariti.com

Business Writing | Proposal Writing |Technical Writing | Grant Writing
Word/Framemaker Template Design | FrameMaker Training Ireland | FrameMaker to Word Conversion Great deals on Project Managment, White Papers, Proposal, and Software Templates for only $9.99.

Ask Ivan | Information Architecture | 99 Freelance Writing Jobs | E-mail Us

Our 1 Minute Pitch  | What We Do | Site Map