Editing and Fine Tuning in Software Documentation.

1. Manisha C. Dharmali
MCA-IV SEM
Editing and Fine Tuning
Institute : SRCOEM, Nagpur
Presented By :

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

4. Suppose, one writer of windows-2000 operating
system documentation faced the challenge of
editing over 2 million words in over 20,000
source documents.

5. 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?

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

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

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

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

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

11. Editing Cover sheets
Allows to easily see the terms of the
edit. Acts as an internal editing
contract.

12. Editing checklist
Acts as an reminder of elements to
examine in editing

13. Contains information about the
documents and editing activities.
Editing Review form

14. To understand the editing relationship and
accept suggestions
Policy documents

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

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

18. Flip Test
Get the overall organization
and layout of pages, check
for glaring inconsistencies.
Ten seconds per manual

19. Skimming
SSpelling, mechanics, punctuation.
six to ten pages per
minute

20. Reading Selectively
Spot-checking for tone, grammar,
complete sentences, transitions,
parallel sections.
two to three minutes
per page

21. Reading Analytically
Missing information, technical
inaccuracies, paragraph organization
and unity.
five pages per hour

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

23. Take a Constructive Attitude

24. THANK
YOU!