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
4.
Characteristics Clear andconcise – 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
5.
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
6.
WhyTechnical Writing? In professional job, 20-40% of your time will be writing Career advancement Expanding knowledge Improving communication skills Every job profile requires versatility
7.
Technical Writing ActivitiesIn-House Activities Letters, memos, e-mail: To ask or answer queries, to set meeting agendas Reports Project, progress, trip, incident, feasibility etc.
8.
Technical Writing ActivitiesIn-House Activities (contd.) Proposals To manager or another department to highlight problems, suggest solutions and recommended action.
9.
Technical Writing ActivitiesOut-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
10.
Reference Gerson, S.J. & Gerson, S. M. (2006). Technical writing: Process and product . Upper Saddle River, NJ: Pearson/Prentice Hall.