4.1 The Types of Review and Edit Review and Editing Methodology

Technical Writing

Module – 4

Review and Editing

4.1 The Types of Review and Edit, Review and Editing Methodology

The Types of Review and Edit-

Developmental Editing

A developmental edit happens early in the writing process, often when an author has an idea for a book or a rough outline, but they need help bringing the pieces together.

2. Evaluation Editing

With an evaluation edit, an editor looks at your manuscript to assess structure, flow, completeness, and overall quality. The editor will usually provide you with a short memo that summarizes their key points, areas of concern, and suggestions for your book.

3. Content Editing

Whereas developmental and evaluation edits look mainly at big picture issues, a content edit is the level at which an editor also starts to dig into the words on the page.

4. Line Editing

As the name implies, a line editor performs a line-by-line review of your manuscript. Up to this point, the editors have worked on your manuscript a high level—either the macro level where they consider the entire book, or the chapter and paragraph level.

5. Copyediting

When you have a finished manuscript—and I mean completely finished, not one that’s close to done or has a few gaps to fill in—it’s time to hire a copyeditor.

A copyeditor will meticulously go through your book and find the spelling, punctuation, and grammar mistakes.

6. Proofreading

Although the terms “copyediting” and “proofreading” are often used interchangeably, they describe different processes that benefit your book in unique ways.

A proof reader takes the printed version of your book after it’s been designed and formatted (called a “proof) and gives it a final review before the book goes to print. Since it comes right before publication, proofreading is the last line of defence against errors.

Review and Editing Methodology-

First-pass editing is done before technical reviews.

This method is best when dealing with inexperienced writers or those unfamiliar with the company style, so that the review copy is free of grammatical, spelling, word use, and other errors that might distract the SMEs from focusing on the accuracy of the information.

4.2 Types of Oral Presentations, Preparation, Visual Aids, Impediments to Technical Writing, Maintaining Writing Skills, Measuring Report Results

Types of Oral Presentations- Oral communication describes any type of inter-action that makes use of spoken words, and it is a vital, integral part of the modern business world. The types of oral communication commonly used within an organization include staff meetings, personal discussions, presentations, telephone discourse, and informal conversation.

Preparation- Preparing an oral presentation is much like preparing any other assignment; it needs to be planned researched and written before it is delivered.

Analyze your audience. What are their needs, constraints, knowledge level?

Research your topic. You must demonstrate an understanding of the main points of your tutorial readings, but you will need to read further. Use your course reading list to find additional relevant information.

Brainstorm your topic and write a rough outline in point form,

Plan and prepare your visual aids.

Rehearse your presentation and get its length right. Ask a friend to listen and time you.

Visual Aids- Using visual aids can add support and impact to your presentation. Visual aids can :

illustrate something that is difficult or time consuming to describe

show reality in ways that words alone cannot (photographs, plans, maps)

summarize information

add colour and interest to a ‘dry’ topic

Visuals can include PowerPoint slides, OHTs, white boards or videos.

Impediments to Technical Writing- Technical writing is a great field, but there are some Impediments that technical writers must sometimes overcome:

Rework and repetition

Complexity of help documentation

Respect

Long working hours

Keep it specific

Maintaining Writing Skills- It is important to maintain your writing skills so as be relevant. Practice the following steps for maintaining writing skills:

Write Every Day

Create an Outline

Read What You Want to Write About

Choose Simple Words

Convey Your Message Easily

Keep Sentences and Paragraphs Short.

writingb