Oxford University Press 2011. All rights reserved.
Technical Communication, Principles
and Practice, 2/E Meenakshi Raman, Group Leader, Humanities and Management, BITS Pilani, Goa
Sangeeta Sharma, Associate Professor of the Languages Group at BITS, Pilani Oxford University Press 2011. All rights reserved. Chapter 13
Technical Writing Oxford University Press 2011. All rights reserved. Agenda: Introduction Audience Analysis Language Elements of Style Techniques for good technical writing Referencing and Styling Oxford University Press 2011. All rights reserved. Introduction
Technical writing : subset of formal communication that requires in-depth technical knowledge.
Presents highly technical information to the audiences in a very comprehensible form Oxford University Press 2011. All rights reserved. Importance To present information comprehensively, in appropriate format To organize details with conciseness and appropriateness To use Jargons sparingly and after an audience analysis To showcase the industry and organization's achievements in the desired light To accurately record the activities of an organization Oxford University Press 2011. All rights reserved. Characteristics: Four Qualities-
Clarity Accuracy Correctness Descriptiveness Oxford University Press 2011. All rights reserved. Audience Analysis The parameters for analyzing the audience-
Demographics
Identification with the Readers
Oxford University Press 2011. All rights reserved. Language The choice of words reflect clarity of thoughts. In technical writing language should be used for : Appropriateness Avoiding slang Acceptability Conciseness and flow Editing phrases Avoiding euphemisms Oxford University Press 2011. All rights reserved.
Appropriateness:- Using suitable level of language formality -Avoiding deceitful language and euphemisms - Avoiding slang:- -Using apt idiomatic expressions - Using group-specific jargon - Avoiding biased/ stereotypical language Acceptability Oxford University Press 2011. All rights reserved. Contd Conciseness and flow Guidelines for writing concise text: - Remove redundancy - Reduce clauses to phrases and phrases to single words - Avoid using words such as really, very, extremely, etc. when they are not necessary Oxford University Press 2011. All rights reserved. Conti Edit out phrases Avoid euphemisms
Steps to achieve flow in writing: -Make the sentence relationship apparent -Use cohesive devices t join the sentence -Interlink the sentences with proper ideas - Arrange the sentences in logical order -develop the thought consistency Oxford University Press 2011. All rights reserved. Bias-free writing:
Technical writing should be non discriminatory in all aspects: Gender bias Age bias Disability bias Racial and ethnic bias
Oxford University Press 2011. All rights reserved. Tips for plain writing: Avoid abstract words Avoid noun clustering Prefer short sentence Avoid redundant words Use active voice and verbs Use positive language Remove clichs and jargons Use subjects, verbs and object in the order Oxford University Press 2011. All rights reserved. Elements of Style Features of style:
Clarity of thoughts Identify the audience Economy of words Spelling Oxford University Press 2011. All rights reserved. Techniques for good Technical writing Overcoming Writers Block Measures help to prevent a writers block - Think positive Write for your pleasure Overcome Criticism Change your place of work Do not sit at the writing table very long Take short breaks in between Oxford University Press 2011. All rights reserved. Contd... Avoid distraction that encroaches a lot time Wear different colored apparels A beverage may help refresh yourself Read some other materials not relating to your writing Meet the deadlines, but do not be harsh on yourself Oxford University Press 2011. All rights reserved. Contd Try to inject humor in to difficult situations Concentrate while working Avoid excessive stress
Oxford University Press 2011. All rights reserved. Adding Emphasis in writing Accentuating the Positives Prioritizing for Effective Writing Avoiding Plagiarism