Scientific and Technical Writing Program Nano Science & Technology Consortium http//www.nstc.in

Introduction to Technical Writing

Technical Writing Defined A specialized, structured form of writing that presents technical information to readers in such a way that it : is adapted to their needs and understanding level helps to perform a specific task or solve a specific problem

A specialized, structured form of writing that presents technical information to readers in such a way that it :

is adapted to their needs and understanding level

helps to perform a specific task or solve a specific problem

Characteristics Clear and concise – easily understandable Specific Audience - targeted to particular readers Specific Purpose- written for a specific purpose Accurate – is factual Correct – follows grammatical and technical conventions Comprehensive – contains all necessary info. Usable – includes Table of Content, headings, subheadings, indexes

Clear and concise – easily understandable

Specific Audience - targeted to particular readers

Specific Purpose- written for a specific purpose

Accurate – is factual

Correct – follows grammatical and technical conventions

Comprehensive – contains all necessary info.

Usable – includes Table of Content, headings, subheadings, indexes

Cost to the Company Costs time and money Does not produce revenue Poorly written or inaccurate documentation: Contributes to customer frustration with the product and the company thus is a cost Projects a negative image of the company and product

Costs time and money

Does not produce revenue

Poorly written or inaccurate documentation:

Contributes to customer frustration with the product and the company thus is a cost

Projects a negative image of the company and product

Why Technical Writing? In professional job, 20-40% of your time will be writing Career advancement Expanding knowledge Improving communication skills Every job profile requires versatility

In professional job, 20-40% of your time will be writing

Career advancement

Expanding knowledge

Improving communication skills

Every job profile requires versatility

Technical Writing Activities In-House Activities Letters, memos, e-mail: To ask or answer queries, to set meeting agendas Reports Project, progress, trip, incident, feasibility etc.

In-House Activities

Letters, memos, e-mail:

To ask or answer queries, to set meeting agendas

Reports

Project, progress, trip, incident, feasibility etc.

Technical Writing Activities In-House Activities (contd.) Proposals To manager or another department to highlight problems, suggest solutions and recommended action.

In-House Activities (contd.)

Proposals

To manager or another department to highlight problems, suggest solutions and recommended action.

Technical Writing Activities Out-of-House Activities Letters of inquiry, sales, etc. Request for Quotation (RFQ) preparation A standard business process with a purpose to invite suppliers to bid on specific products or services Reports to Clients Publication Articles

Out-of-House Activities

Letters of inquiry, sales, etc.

Request for Quotation (RFQ) preparation

A standard business process with a purpose to invite suppliers to bid on specific products or services

Reports to Clients

Publication Articles

Reference Gerson, S. J. & Gerson, S. M. (2006). Technical writing: Process and product . Upper Saddle River, NJ: Pearson/Prentice Hall.

Gerson, S. J. & Gerson, S. M. (2006). Technical writing: Process and product . Upper Saddle River, NJ: Pearson/Prentice Hall.

Contact Information Program Coordinator Scientific and Technical Writing Nano Science and Technology Consortium C-56 A/28, Sector-62, Noida, U.P -201301 Mob. No. 09958161117 E-mail : tech.writing@nstc.in Website : http://www.nstc.in Helpline No. 0120-4330376 , 09818206463

Program Coordinator

Scientific and Technical Writing

Nano Science and Technology Consortium

C-56 A/28, Sector-62, Noida, U.P -201301

Mob. No. 09958161117

E-mail : tech.writing@nstc.in

Website : http://www.nstc.in

Helpline No. 0120-4330376 , 09818206463