SEMINAR NEW ON Technical Writing

Seminar on:-

“TECHNICAL WRITING’’

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

Gangapur Road, Nasik – 422 002 (2014-2015)

Presented by:- Nitin P. Kanwale M.Pharm. 1st Sem. (Q.A.T.)

Content:• 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

04/15/2023 2

3

What is technical writing:-

“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.04/15/2023

4

These are not distinct categories, so thinking of them as separate is not correct:-

Technical Writing

Business Writing

Environmental Writing

Science Writing

04/15/2023

5Fig. Spectrum of technical writing

04/15/2023

6

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.

04/15/2023

7

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.

04/15/2023

8

Who does technical writing? An experienced, professional technical writer.

An experienced writer.

An experienced professional with access to a professional content editor.

04/15/2023

9

Key skills in technical writer:Facility with technologyAbility to write clearlyTalent in showing ideas graphicallyPatiens in problem solving/troubleshootingAbility to interact with SMEs.

04/15/2023

10

Qualities of good technical writing:-

PlanningClarityBrevitySimplicityWord ChoiceActive VoiceCommitting to writing as a

process

04/15/2023

Writing Is a Process:

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.

04/15/2023 11

12

Why should you care about writing?

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.

04/15/2023

13

How to make an effective technical report? Report format Accuracy Clarity Conciseness Continuity Good writing style

04/15/2023

14

What makes a report ineffective: Vagueness Wordiness Poor Spelling/Grammar Stresses Problems, Not

Solutions Inappropriate

Language04/15/2023

15

TECHNICAL REPORT

04/15/2023

16

Step in writing report:Logical analysis of the subject matterPreparation of the final outlinePreparation of the rough draftRewriting and polishingPreparation of the final bibliographyWriting the final draft.

04/15/2023

17

Layout of the research report:

1. Preliminary pages2. Main text3. End matter.

04/15/2023

18

Precaution for writing research reports:• 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.04/15/2023

19

Conclusion:

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

04/15/2023

20

References: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.

04/15/2023

THANK YOU !

04/15/2023 21