Editing and Fine Tuning

Post on 18-Dec-2014

72 Views

Category:

Education

5 Downloads

Preview:

Click to see full reader

DESCRIPTION

Editing and Fine Tuning in Software Documentation.

Transcript

Manisha C. Dharmali MCA-IV SEM

Editing and Fine Tuning

Institute : SRCOEM, Nagpur

Presented By :

A Page With Editing Marks

Guide Installatin

The following program should not be installed on the hard drive. Install the program on a floppy disk by copying the distribution disk. Installing on a floppy. 1. Start the computer.

2. Insert the TTM distribution disk into the drive and double click on the disk icon.

3. The TTM window will appear.

Installation

Installation Guide

To do that, follow the steps below.

Not proper aligned.

A Copy Editor’s Marks

Establish Project Guidelines

Suppose, one writer of windows-2000 operating

system documentation faced the challenge of editing over 2 million words in over 20,000 source documents.

Establish Project Guidelines

What hurdles in terms of use or understanding do you have to overcome with your project?

What special production demands do you have to meet?

Do you have any schedule a product with the release of other products?

Are you trying something different with your project that you haven’t done before?

Understand Types Of Editing

Editing documentation plans, project reports, product specifications, outlines.

Managerial Editing

Understand Types Of Editing

Editing outlines, rough drafts, organization and structure of contents.

Substantive Editing

Understand Types Of Editing

Editing sentence-level style and organization, clarity of phasing, mechanical (grammar and punctuation) consistency, format consistency and readability.

Copy Editing

Understand Types Of Editing

Editing for consistency and correctness in all terminology, spelling and mechanical correctness, format consistency, consistency of the document against copy editor’s marks.

Proofreading Editing

Plan Your Editing Tasks

Task Time

Managerial Editing 10-15% of all activities

Substantive Editing 6-8 pages per hour

Copy Editing 1-3 hours per page

Proofreading 5-10 pages per hour

Develop The Appropriate Editing Forms

Editing Cover sheets

Allows to easily see the terms of the edit. Acts as an internal editing contract.

Develop The Appropriate Editing Forms

Editing checklist

Acts as an reminder of elements to examine in editing

Develop The Appropriate Editing Forms

Contains information about the documents and editing activities.

Editing Review form

Develop The Appropriate Editing Forms

To understand the editing relationship and accept suggestions

Policy documents

Develop The Appropriate Editing Forms

To remember the changes you made at other places in a document. It enables to maintain consistency within a document.

Style sheet

Develop The Appropriate Editing Forms

To remember the changes you made at other places in a document. It enables to maintain consistency within a document.

Style sheet

Conduct Editing Sessions

Conduct Editing Sessions

Flip Test

Get the overall organization and layout of pages, check for glaring inconsistencies.

Ten seconds per manual

Conduct Editing Sessions

Skimming

SSpelling, mechanics, punctuation.

six to ten pages per minute

Conduct Editing Sessions

Reading Selectively

Spot-checking for tone, grammar, complete sentences, transitions, parallel sections.

two to three minutes per page

Conduct Editing Sessions

Reading Analytically

Missing information, technical inaccuracies, paragraph organization and unity.

five pages per hour

Conduct Editing Sessions

The Long Look

Omissions in title pages, table of contents, indexes, headers and rules out of place, misaligned graphics, tiny extra spaces in front of some words, double spaces between words, stupid mistakes.

one to two minutes per page

CONCLUSION

Take a Constructive Attitude

THANK YOU!

top related