seminar on technical writing

“TECHNICAL

WRITING’’

N.D.M.V.P. Samaj’s College of Pharmacy,

Gangapur Road, Nasik – 422 002

(2014-2015)

Presented by:-

Nitin P. Kanwale

Roll No. 06

M.Pharm. 1st Sem. (Q.A.T.)

• Introduction

• Purpose of technical writing

• Principle of technical writing

• Key skill to technical writer

• Qualities of good technical writing

• How make an effective technical writing

• What make an technical writing ineffective

• Technical report

• Conclusion

• references

4/13/2015 2

“Technical writing is communication, the primary aim of

which is to convey a particular piece of information to a

particular reader or group of reader for a particular

purpose.”

Technical writers design, write and edit documents for

engineering, scientific, industrial and government

organization. These include technical report, computer

manuals, brochure, proposals, technical specification,

educational and training material and marketing or public

relation releases.

4/13/2015 3

Technical Writing

Business Writing

Environmental Writing

Science Writing

4/13/2015 4

Fig. Spectrum of technical writing4/13/2015 5

What is the purpose of technical writing?

Give information that leads to the accomplishment of scientific tasks and in the making of the needed decisions.

Analyze events and their implications.

Persuade and influence decisions.

4/13/2015 6

What are the basic principles of good technical writing?

The writer of a report must have a specific reader or group of readers in mind.

He must decide what the specific purpose of his report is and make sure that every part of his report contributes to that purpose.

He must use specific, single, concrete words, and familiar language that cannot be misinterpreted.

4/13/2015 7

An experienced, professional technical writer.

An experienced writer.

An experienced professional with access to a

professional content editor.

4/13/2015 8

Facility with technology

Ability to write clearly

Talent in showing ideas graphically

Patiens in problem solving/troubleshooting

Ability to interact with SMEs.

4/13/2015 9

Planning

Clarity

Brevity

Simplicity

Word Choice

Active Voice

Committing to writing as a

process

4/13/2015 10

Good writing doesn’t happen overnight; it requires planning, drafting, rereading, revising, and editing.

Learning and improvement requires self-review, subject-matter expert feedback, and practice.

4/13/2015 11

You must communicate your work to the world.

If people don’t know about it, they won’t use it.

Increase probability of adoption.

Clear writing requires clear thinking; muddled writing is a

sign of muddled thought.

Be kind to your readers good writing can be a joy; bad

writing is agony.

4/13/2015 12

How to make an effective technical

report?

Report format

Accuracy

Clarity

Conciseness

Continuity

Good writing style

4/13/2015 13

What makes a report ineffective:

Vagueness

Wordiness

Poor Spelling/Grammar

Stresses Problems, Not Solutions

Inappropriate Language

4/13/2015 14

4/13/2015 15

Logical analysis of the subject matter

Preparation of the final outline

Preparation of the rough draft

Rewriting and polishing

Preparation of the final bibliography

Writing the final draft.

4/13/2015 16

1. Preliminary pages

2. Main text

3. End matter.

4/13/2015 17

• It should be long enough to cover the subject but

short enough to maintain interest.

• Don’t make it dull, so sustain reader interest.

• Should be written in an objective style in simple

language.

• For aquaring quick knowledge, the results are

provided in charts, graphs and in tables.

• Avoid grammatical mistakes.

4/13/2015 18

• Plan your project before you begin drafting.

• Understand basic qualities of good technical writing;

use the examples presented to guide you in your

writing and revising process.

• Good writing is a habit that takes time to develop;

practice makes perfect.

4/13/2015 19

1. Kothari CR. Research methodology, methods and

techniques. 2nd ed. New delhi: new age international

publishers; 2004. p. 346-51.

2. Gough J. WRIGHT IT DOWN Guidence for preparing

documentation that meets regulatory

requirements:interpharm;london.ed.1:97-108.

3. Best JW, Khan JV. Research in education. 7th ed. New

delhi: prentice hall of india; 2000. p. 61-80.

4. Michigan state university. TECHNICAL WRITING

GUIDE;SEP.2007(2):1-20.

5. Michael D.Basics of research paper writing and publication.

IJTEL, Germany.4/13/2015 20

4/13/2015 21