basics of technical writing

44
TECHNICAL WRITING COURSE CODE: 301 EL-Batch 15 Section-I B.E Electrical English Language Development Centre ELDC

Upload: abdul-wahab-malik

Post on 16-Apr-2017

75 views

Category:

Education


0 download

TRANSCRIPT

Page 1: Basics of Technical Writing

TECHNICAL WRITINGCOURSE CODE: 301

EL-Batch 15 Section-IB.E Electrical

English Language Development Centre

ELDC

Page 2: Basics of Technical Writing

Dr. Habibullah PathanM.A, M.Ed, ELT (Glasgow, UK), Ph.D. (UK)

Post. Doc. (MIT, USA)Humphrey Alumni (Boston University, USA)

Mr. Abdul Aziz MagsiM.A (English), PGD. Teaching of English as Foreign

Language, M.S (English Linguistics)

COURSE INSTRUCTORS & FACILITATORS

Page 3: Basics of Technical Writing

Contact Hours: Fridays11:00 to 12:00 (Be in touch before meeting)For further Correspondence [email protected] through FB is not mandatory to be entertained.

Page 4: Basics of Technical Writing

ELDC, MUET Jamshoro

Course DetailsContact Hours: 28Credit Hours: 2Marks Distribution :10% Attendance10% Assignments & Presentations20% Mid-Semester Exam40% Final Semester Exam

Page 5: Basics of Technical Writing

Planning & Procedure

Page 6: Basics of Technical Writing

• It is the result of a deliberate and

comprehensive Design and

Production process.• Variation in the process occurs• Most of the Technical & Scientific Writing

Follows the same process

Page 7: Basics of Technical Writing

• 1- Establish a Basic Criteria of 5 Characteristics of ETR (Effective Technical Writing) ACCCA

• i- Accuracy• ii- Clarity• iii- Conciseness• iv- Coherence• v- Appropriate

Page 8: Basics of Technical Writing

• 2- Identify the specific purpose of the document by clarifying

i- The reasons ii- Specific objectives.

Answers to a specific problem (in a problem statement)

It will help you determine the document's general type.

Page 9: Basics of Technical Writing

• 3- Define your Audiencei- Users (readers) ii- Level of Expertiseiii- Purpose of reading the documentiv- Attitude (Towards You and Documents Subject Matter)

Page 10: Basics of Technical Writing

• So far, you must have done with definingi- Purposeii- Problemiii- Audience

Now go for 4- Collecting, Creating and Assembling

Information

Page 11: Basics of Technical Writing

5- Sketch out and outline & Organize the information

6- Sketch out Graphics and table to Present Data (keeping in Mind the Audience)

Using these sketches (Preliminary outline and Graphic/Data presentation outline)

7- Write a first Draft NOTE: (At this point) Do not be overly concerned about grammar, style, or usage.

Page 12: Basics of Technical Writing

Feature of Document Expert Managerial LaypersonIntroductions Technical Problem/solution Relevance

Math models OK Avoid Avoid

Equations OK Keep simple or avoid Avoid

Graphics Detailed, analytical Simple, presentational

General illustrative

Detail level Accurate, numerical

General, accurate

Simple, narrative

Technical terms Expert, technical Administrative General,

illustrative

Emphasis Analysis Operations, costs

Informational, interest

GUIDELINES FOR DOCUMENT DENSITY

Page 13: Basics of Technical Writing

8- Revise your document in stages

i- Organization

ii- The Content for

Accuracy & Appropriateness

Page 14: Basics of Technical Writing

9- Edit the Paragraphs & SentencesTo improve ClarityConciseness CoherenceTo fix the problems of

Grammar, spelling, punctuation, mechanics, or usage

10- One or More ReviewsLegal ReviewsTechnical ReviewsPeer Reviews

Page 15: Basics of Technical Writing

Collaborative WritingDocument Planning & ManagementDrafting Revision

Page 16: Basics of Technical Writing

Characteristics

Page 17: Basics of Technical Writing

The flow of electrical current can induce the migration of impurities or other defects through the bulk of a solid. This process is called electromigration. In simple electromigration, the force on the defect is thought to have two components. The first component is the force created by direct interaction between the effective charge of the defect and the electric field that drives the current. The second component, called the "wind force," is the force caused by the scattering of electrons at the defect.--J.A. Stroscio and D.M. Eigler, "Atomic and Molecular Manipulation with the Scanning Tunneling Microscope," Science

Page 18: Basics of Technical Writing

ACCURACYIt is the careful conforming to truth or fact.

3 Aspects of Accuracy1-Document Accuracy2-Stylistic Accuracy3-Technical Accuracy

Page 19: Basics of Technical Writing

DOCUMENT ACCURACYThe proper coverage of your topics in appropriate detail

• Focus clearly on a problem(Theoretical & Practical Problem)

• Problem statement & Preliminary Outline(Tools to develop Document Accuracy)

Page 20: Basics of Technical Writing

STYLISTIC ACCURACY the careful use of language to express meaning

Careful use of • Paragraph, Sentences structures, & Word

choice• Using words Precisely

Page 21: Basics of Technical Writing

Technical ACCURACYTo be grounded in a technically accurate understanding

and representation of the subject

• Requires Stylistic Accuracy• Depends on writers’

• Conceptual mastery of the subject• Its vocabulary• Skills of presenting data to avoid

distortion  

Page 22: Basics of Technical Writing

The flow of electrical current can induce the migration of impurities or other defects through the bulk of a solid. This process is called electromigration. In simple electromigration, the force on the defect is thought to have two components. The first component is the force created by direct interaction between the effective charge of the defect and the electric field that drives the current. The second component, called the "wind force," is the force caused by the scattering of electrons at the defect.--J.A. Stroscio and D.M. Eigler, "Atomic and Molecular Manipulation with the Scanning Tunneling Microscope," Science

Page 23: Basics of Technical Writing

ACCURATE IN TWO WAYS• Stylistically- Precise use of Language • Technically- Use of Specialized Terms (Technical Terms, electromigration, charge, electric

field)

Page 24: Basics of Technical Writing

CLARITYEase of Understanding

Specialized languages, mathematically detailed analyses, and complex conceptual schemes

3 ways to develop calrity1- Structural clarity2- Stylistic Clarity3-Contextual Clarity

Page 25: Basics of Technical Writing

STRUCTURAL CLARITYmaking it easy for the reader to get the large picture

Focus on• Structure• Design• Organization

Page 26: Basics of Technical Writing

STYLISTIC CLARITYUse of simple and Direct Language

• Simple sentence structure, avoiding wordy sentences

(Increase Readability)• Excessive Nominalization• Word Choices

Page 27: Basics of Technical Writing

CONTEXTUAL CLARITYAvailability of Importance, authorization, implications

• Reason of your document production• What? Why?, who/ what proceeds?

•Introduction• Problem statement•Citations, references

 

Page 28: Basics of Technical Writing

The flow of electrical current can induce the migration of impurities or other defects through the bulk of a solid. This process is called electromigration. In simple electromigration, the force on the defect is thought to have two components. The first component is the force created by direct interaction between the effective charge of the defect and the electric field that drives the current. The second component, called the "wind force," is the force caused by the scattering of electrons at the defect.--J.A. Stroscio and D.M. Eigler, "Atomic and Molecular Manipulation with the Scanning Tunneling Microscope," Science

Page 29: Basics of Technical Writing

CLARITY• Simple & Direct Sentences• Word order in the sentences• Clarity is achieved by using rhetorical

devices of defining a term.

Page 30: Basics of Technical Writing

CONCISENESSConveys only the needed material not all the relevant

2 Strategies1- Prepare a clear introduction2- Develop a detailed outline

• Use Appendix to be referred to the information not necessary

• Eliminate Useless information• Use Graphics

Page 31: Basics of Technical Writing

The flow of electrical current can induce the migration of impurities or other defects through the bulk of a solid. This process is called electromigration. In simple electromigration, the force on the defect is thought to have two components. The first component is the force created by direct interaction between the effective charge of the defect and the electric field that drives the current. The second component, called the "wind force," is the force caused by the scattering of electrons at the defect.--J.A. Stroscio and D.M. Eigler, "Atomic and Molecular Manipulation with the Scanning Tunneling Microscope," Science

Page 32: Basics of Technical Writing

CONCISENESS• Using minimum words• It does not digress from the point.

Page 33: Basics of Technical Writing

COHERENCE the quality of hanging together, of providing the reader an easily

followed path

• Logically & stylistically consistent information• Organization and Expression of Ideas in a specific

pattern• Linking various components of text/documents

(Sentences, Word-phrases, Paragraphs)

Page 34: Basics of Technical Writing

ParagraphThe most powerful instrument of coherence

• Organizing material in TS (Topic Sentences) & SS (Supporting Sentences)

• Strategies to develop paragraphsExemplification, Analysis, Comparison and

contrast, Definition, Enumeration, Description

• Using Referents & Transitional Devices

Page 35: Basics of Technical Writing

The flow of electrical current can induce the migration of impurities or other defects through the bulk of a solid. This process is called electromigration. In simple electromigration, the force on the defect is thought to have two components. The first component is the force created by direct interaction between the effective charge of the defect and the electric field that drives the current. The second component, called the "wind force," is the force caused by the scattering of electrons at the defect.--J.A. Stroscio and D.M. Eigler, "Atomic and Molecular Manipulation with the Scanning Tunneling Microscope," Science

Page 36: Basics of Technical Writing

COHERENT• Develops its subject matter in easy-to-

follow line of thinking• Use of Referents, Transitional devices

(the first component, this process, the second component)

Page 37: Basics of Technical Writing

APPROPRIATENESSthe specific institutional contexts in which it is written

and read

2 AspectsAppropriate for GoalAppropriate for Audience’s PurposeSee Document Density

Page 38: Basics of Technical Writing

The flow of electrical current can induce the migration of impurities or other defects through the bulk of a solid. This process is called electromigration. In simple electromigration, the force on the defect is thought to have two components. The first component is the force created by direct interaction between the effective charge of the defect and the electric field that drives the current. The second component, called the "wind force," is the force caused by the scattering of electrons at the defect.--J.A. Stroscio and D.M. Eigler, "Atomic and Molecular Manipulation with the Scanning Tunneling Microscope," Science

Page 39: Basics of Technical Writing

APPROPRIATE • To Purpose(of presenting the process of eletromigration)

• To the Audience (readers of Science)

Page 40: Basics of Technical Writing

Types of Technical Communication Documents

Page 41: Basics of Technical Writing

• Memoranda• Meeting Documents

AgendaMinutes of Meeting

• Literature Reviews• Reports (Formal & Informal)

Long & ShortLab ReportsResearch ReportsProject ReportsField Visit/ trip ReportsConsulting ReportsProgress reportsDesign & Feasibility Report

Page 42: Basics of Technical Writing

• LettersJob Application LettersAcceptance LettersTransmittal LettersLetters of InquiryTechnical Information LettersReferences & Letters of RecommendationsObtaining & Providing

• Proposals• Press Release• Task Oriented Documents

Mannuals (Technical & User Documentation)Instructional Procedures

• Theses & Dissertations

Page 43: Basics of Technical Writing

• Oral PresentationsFormal & Informal

• Electronic Documentation• Résumé & CV• Covering Letters

Page 44: Basics of Technical Writing

THANKS!