editing and fine tuning
DESCRIPTION
Editing and Fine Tuning in Software Documentation.TRANSCRIPT
![Page 1: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/1.jpg)
Manisha C. Dharmali MCA-IV SEM
Editing and Fine Tuning
Institute : SRCOEM, Nagpur
Presented By :
![Page 2: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/2.jpg)
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.
![Page 3: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/3.jpg)
A Copy Editor’s Marks
![Page 4: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/4.jpg)
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.
![Page 5: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/5.jpg)
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?
![Page 6: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/6.jpg)
Understand Types Of Editing
Editing documentation plans, project reports, product specifications, outlines.
Managerial Editing
![Page 7: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/7.jpg)
Understand Types Of Editing
Editing outlines, rough drafts, organization and structure of contents.
Substantive Editing
![Page 8: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/8.jpg)
Understand Types Of Editing
Editing sentence-level style and organization, clarity of phasing, mechanical (grammar and punctuation) consistency, format consistency and readability.
Copy Editing
![Page 9: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/9.jpg)
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
![Page 10: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/10.jpg)
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
![Page 11: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/11.jpg)
Develop The Appropriate Editing Forms
Editing Cover sheets
Allows to easily see the terms of the edit. Acts as an internal editing contract.
![Page 12: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/12.jpg)
Develop The Appropriate Editing Forms
Editing checklist
Acts as an reminder of elements to examine in editing
![Page 13: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/13.jpg)
Develop The Appropriate Editing Forms
Contains information about the documents and editing activities.
Editing Review form
![Page 14: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/14.jpg)
Develop The Appropriate Editing Forms
To understand the editing relationship and accept suggestions
Policy documents
![Page 15: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/15.jpg)
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
![Page 16: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/16.jpg)
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
![Page 17: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/17.jpg)
Conduct Editing Sessions
![Page 18: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/18.jpg)
Conduct Editing Sessions
Flip Test
Get the overall organization and layout of pages, check for glaring inconsistencies.
Ten seconds per manual
![Page 19: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/19.jpg)
Conduct Editing Sessions
Skimming
SSpelling, mechanics, punctuation.
six to ten pages per minute
![Page 20: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/20.jpg)
Conduct Editing Sessions
Reading Selectively
Spot-checking for tone, grammar, complete sentences, transitions, parallel sections.
two to three minutes per page
![Page 21: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/21.jpg)
Conduct Editing Sessions
Reading Analytically
Missing information, technical inaccuracies, paragraph organization and unity.
five pages per hour
![Page 22: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/22.jpg)
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
![Page 23: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/23.jpg)
CONCLUSION
Take a Constructive Attitude
![Page 24: Editing and Fine Tuning](https://reader035.vdocument.in/reader035/viewer/2022081413/5492fe66b47959654d8b4733/html5/thumbnails/24.jpg)
THANK YOU!