SlideShare a Scribd company logo
1 of 44
TECHNICAL WRITING
COURSE CODE: 301
EL-Batch 15 Section-I
B.E Electrical
English Language Development
Centre
ELDC
Dr. Habibullah Pathan
M.A, M.Ed, ELT (Glasgow, UK), Ph.D. (UK)
Post. Doc. (MIT, USA)
Humphrey Alumni (Boston University, USA)
Mr. Abdul Aziz Magsi
M.A (English), PGD. Teaching of English as Foreign
Language, M.S (English Linguistics)
COURSE INSTRUCTORS & FACILITATORS
Contact Hours:
Fridays
11:00 to 12:00 (Be in touch before meeting)
For further Correspondence Officially
magsiabdulaziz@hotmail.com
Contact through FB is not mandatory to be
entertained.
ELDC, MUET Jamshoro
Course Details
Contact Hours: 28
Credit Hours: 2
Marks Distribution :
10% Attendance
10% Assignments & Presentations
20% Mid-Semester Exam
40% Final Semester Exam
Planning &
Procedure
• 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
• 1- Establish a Basic Criteria of 5 Characteristics
of ETR (Effective Technical Writing) ACCCA
• i- Accuracy
• ii- Clarity
• iii- Conciseness
• iv- Coherence
• v- Appropriate
• 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.
• 3- Define your Audience
i- Users (readers)
ii- Level of Expertise
iii- Purpose of reading the document
iv- Attitude
(Towards You and Documents Subject Matter)
• So far, you must have done with defining
i- Purpose
ii- Problem
iii- Audience
Now go for
4- Collecting, Creating and Assembling Information
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.
Feature of
Document Expert Managerial Layperson
Introductions 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
8- Revise your document in stages
i- Organization
ii- The Content for
Accuracy & Appropriateness
9- Edit the Paragraphs & Sentences
To improve
Clarity
Conciseness
Coherence
To fix the problems of
Grammar, spelling, punctuation, mechanics, or usage
10- One or More Reviews
Legal Reviews
Technical Reviews
Peer Reviews
Collaborative Writing
Document Planning & Management
Drafting
Revision
Characteristics
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
ACCURACY
It is the careful conforming to truth or fact.
3 Aspects of Accuracy
1-Document Accuracy
2-Stylistic Accuracy
3-Technical Accuracy
DOCUMENT ACCURACY
The 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)
STYLISTIC ACCURACY
the careful use of language to express meaning
Careful use of
• Paragraph, Sentences structures, & Word choice
• Using words Precisely
Technical ACCURACY
To 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
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
ACCURATE IN TWO WAYS
• Stylistically- Precise use of Language
• Technically- Use of Specialized Terms
(Technical Terms, electromigration, charge, electric field)
CLARITY
Ease of Understanding
Specialized languages, mathematically detailed analyses,
and complex conceptual schemes
3 ways to develop calrity
1- Structural clarity
2- Stylistic Clarity
3-Contextual Clarity
STRUCTURAL CLARITY
making it easy for the reader to get the large picture
Focus on
• Structure
• Design
• Organization
STYLISTIC CLARITY
Use of simple and Direct Language
• Simple sentence structure, avoiding wordy sentences
(Increase Readability)
• Excessive Nominalization
• Word Choices
CONTEXTUAL CLARITY
Availability of Importance, authorization, implications
• Reason of your document production
• What? Why?, who/ what proceeds?
• Introduction
• Problem statement
• Citations, references
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
CLARITY
• Simple & Direct Sentences
• Word order in the sentences
• Clarity is achieved by using rhetorical devices of
defining a term.
CONCISENESS
Conveys only the needed material not all the relevant
2 Strategies
1- Prepare a clear introduction
2- Develop a detailed outline
• Use Appendix to be referred to the information not necessary
• Eliminate Useless information
• Use Graphics
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
CONCISENESS
• Using minimum words
• It does not digress from the point.
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)
Paragraph
The most powerful instrument of coherence
• Organizing material in
TS (Topic Sentences) & SS (Supporting Sentences)
• Strategies to develop paragraphs
Exemplification, Analysis, Comparison and contrast,
Definition, Enumeration, Description
• Using Referents & Transitional Devices
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
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)
APPROPRIATENESS
the specific institutional contexts in which it is written and read
2 Aspects
Appropriate for Goal
Appropriate for Audience’s Purpose
See Document Density
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
APPROPRIATE
• To Purpose
(of presenting the process of eletromigration)
• To the Audience (readers of Science)
Types of Technical
Communication Documents
• Memoranda
• Meeting Documents
Agenda
Minutes of Meeting
• Literature Reviews
• Reports (Formal & Informal)
Long & Short
Lab Reports
Research Reports
Project Reports
Field Visit/ trip Reports
Consulting Reports
Progress reports
Design & Feasibility Report
• Letters
Job Application Letters
Acceptance Letters
Transmittal Letters
Letters of Inquiry
Technical Information Letters
References & Letters of Recommendations
Obtaining & Providing
• Proposals
• Press Release
• Task Oriented Documents
Mannuals (Technical & User Documentation)
Instructional Procedures
• Theses & Dissertations
• Oral Presentations
Formal & Informal
• Electronic Documentation
• Résumé & CV
• Covering Letters
THANKS!

More Related Content

What's hot

Introduction to technical writing
Introduction to technical writingIntroduction to technical writing
Introduction to technical writingAdam Tablante
 
Technical and business writing slides
Technical and business writing slidesTechnical and business writing slides
Technical and business writing slidesSelf-employed
 
10. technical communication
10. technical communication10. technical communication
10. technical communicationTatenda Chityori
 
All About Technical Writing
All About  Technical  WritingAll About  Technical  Writing
All About Technical Writingshravanpalvai
 
Introduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti GaikwadIntroduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti GaikwadPriti Gaikwad
 
Lecture 1. an introduction to technical report writing
Lecture 1.   an introduction to technical report writingLecture 1.   an introduction to technical report writing
Lecture 1. an introduction to technical report writingAzamBaloch6
 
REPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCE
REPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCEREPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCE
REPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCETulika Paul
 
Introduction to Technical Writing
Introduction to Technical WritingIntroduction to Technical Writing
Introduction to Technical WritingVince
 
Types of Letters
Types of LettersTypes of Letters
Types of Letterstruelyme
 
Letter and its types (letter writing)
Letter and its types (letter writing)Letter and its types (letter writing)
Letter and its types (letter writing)SuhailAhmed95
 
What Is Technical Writing And Documentation
What Is Technical Writing And DocumentationWhat Is Technical Writing And Documentation
What Is Technical Writing And Documentationanjaliarv
 
Academic Writing
Academic WritingAcademic Writing
Academic WritingUGPTI
 
Technical report writing
Technical report writingTechnical report writing
Technical report writingzara_Ali
 
Clarity, Style and Tone
Clarity, Style and ToneClarity, Style and Tone
Clarity, Style and TonetheLecturette
 
ESSAY WRITING: PLANNING TECHNIQUES
ESSAY WRITING: PLANNING TECHNIQUESESSAY WRITING: PLANNING TECHNIQUES
ESSAY WRITING: PLANNING TECHNIQUESGeorge Dumitrache
 

What's hot (20)

Introduction to technical writing
Introduction to technical writingIntroduction to technical writing
Introduction to technical writing
 
Technical and business writing slides
Technical and business writing slidesTechnical and business writing slides
Technical and business writing slides
 
10. technical communication
10. technical communication10. technical communication
10. technical communication
 
All About Technical Writing
All About  Technical  WritingAll About  Technical  Writing
All About Technical Writing
 
Introduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti GaikwadIntroduction to Technical Writing - Priti Gaikwad
Introduction to Technical Writing - Priti Gaikwad
 
Lecture 1. an introduction to technical report writing
Lecture 1.   an introduction to technical report writingLecture 1.   an introduction to technical report writing
Lecture 1. an introduction to technical report writing
 
REPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCE
REPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCEREPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCE
REPORT WRITING:TYPES, FORMAT, STRUCTURE AND RELEVANCE
 
Introduction to Technical Writing
Introduction to Technical WritingIntroduction to Technical Writing
Introduction to Technical Writing
 
technical writing styles
technical writing stylestechnical writing styles
technical writing styles
 
Academic Writing
Academic WritingAcademic Writing
Academic Writing
 
Technical report-writing-1
Technical report-writing-1Technical report-writing-1
Technical report-writing-1
 
Technical Report writing
Technical Report writingTechnical Report writing
Technical Report writing
 
Types of Letters
Types of LettersTypes of Letters
Types of Letters
 
Letter and its types (letter writing)
Letter and its types (letter writing)Letter and its types (letter writing)
Letter and its types (letter writing)
 
What Is Technical Writing And Documentation
What Is Technical Writing And DocumentationWhat Is Technical Writing And Documentation
What Is Technical Writing And Documentation
 
Academic Writing
Academic WritingAcademic Writing
Academic Writing
 
Technical report writing
Technical report writingTechnical report writing
Technical report writing
 
Clarity, Style and Tone
Clarity, Style and ToneClarity, Style and Tone
Clarity, Style and Tone
 
ESSAY WRITING: PLANNING TECHNIQUES
ESSAY WRITING: PLANNING TECHNIQUESESSAY WRITING: PLANNING TECHNIQUES
ESSAY WRITING: PLANNING TECHNIQUES
 
technical report ppt
technical report ppttechnical report ppt
technical report ppt
 

Similar to Basics of Technical Writing

Earthing systems - Basic constructional aspects
Earthing systems - Basic constructional aspectsEarthing systems - Basic constructional aspects
Earthing systems - Basic constructional aspectsBruno De Wachter
 
Alternator (AC Generator) Synchronizing Panel
Alternator (AC Generator) Synchronizing PanelAlternator (AC Generator) Synchronizing Panel
Alternator (AC Generator) Synchronizing PanelAswin KP
 
Effect of Combined Antenna Electromagnetic Power to Human
Effect of Combined Antenna Electromagnetic Power to HumanEffect of Combined Antenna Electromagnetic Power to Human
Effect of Combined Antenna Electromagnetic Power to Humandrboon
 
Investigation of the Piezoelectric Effect as a Means to Generate X-Rays
Investigation of the Piezoelectric Effect as a Means to Generate X-RaysInvestigation of the Piezoelectric Effect as a Means to Generate X-Rays
Investigation of the Piezoelectric Effect as a Means to Generate X-RaysCarlos Bella
 
Different Types of Power Problems
Different Types of Power ProblemsDifferent Types of Power Problems
Different Types of Power ProblemsChintan Patel
 
Power Quality Parameters Measurement Techniques
Power Quality Parameters Measurement TechniquesPower Quality Parameters Measurement Techniques
Power Quality Parameters Measurement Techniquesidescitation
 
Amplitude Modulation Circuit Implementation for use in a Communication Course...
Amplitude Modulation Circuit Implementation for use in a Communication Course...Amplitude Modulation Circuit Implementation for use in a Communication Course...
Amplitude Modulation Circuit Implementation for use in a Communication Course...Huynh MVT
 
A Review Of The Skin Effect As Applied To Thin Film Interconnections
A Review Of The Skin Effect As Applied To Thin Film InterconnectionsA Review Of The Skin Effect As Applied To Thin Film Interconnections
A Review Of The Skin Effect As Applied To Thin Film InterconnectionsSabrina Ball
 
Power transmission lines electromagnetic pollution with consideration of soil...
Power transmission lines electromagnetic pollution with consideration of soil...Power transmission lines electromagnetic pollution with consideration of soil...
Power transmission lines electromagnetic pollution with consideration of soil...TELKOMNIKA JOURNAL
 
03 partial discharge theory cutler-hammer
03 partial discharge theory cutler-hammer03 partial discharge theory cutler-hammer
03 partial discharge theory cutler-hammerprasadkappala
 
International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...
International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...
International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...CSCJournals
 
Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024
Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024
Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024Clevstudy
 
30167812 short-circuit-ppt
30167812 short-circuit-ppt30167812 short-circuit-ppt
30167812 short-circuit-pptAnto Damanik
 
MRR Improvement in Electrical Discharge Machining
MRR Improvement in Electrical Discharge MachiningMRR Improvement in Electrical Discharge Machining
MRR Improvement in Electrical Discharge MachiningPraveen Kumar Kushwah
 
The Effects of Heat on Electronic Components
The Effects of Heat on Electronic ComponentsThe Effects of Heat on Electronic Components
The Effects of Heat on Electronic ComponentsIJERA Editor
 
Current Advanced Research Development of Electric Discharge Machining (EDM): ...
Current Advanced Research Development of Electric Discharge Machining (EDM): ...Current Advanced Research Development of Electric Discharge Machining (EDM): ...
Current Advanced Research Development of Electric Discharge Machining (EDM): ...sushil Choudhary
 
H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...
H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...
H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...EMERSON EDUARDO RODRIGUES
 

Similar to Basics of Technical Writing (20)

Earthing systems - Basic constructional aspects
Earthing systems - Basic constructional aspectsEarthing systems - Basic constructional aspects
Earthing systems - Basic constructional aspects
 
105733223 ee2-12
105733223 ee2-12105733223 ee2-12
105733223 ee2-12
 
Alternator (AC Generator) Synchronizing Panel
Alternator (AC Generator) Synchronizing PanelAlternator (AC Generator) Synchronizing Panel
Alternator (AC Generator) Synchronizing Panel
 
Effect of Combined Antenna Electromagnetic Power to Human
Effect of Combined Antenna Electromagnetic Power to HumanEffect of Combined Antenna Electromagnetic Power to Human
Effect of Combined Antenna Electromagnetic Power to Human
 
Investigation of the Piezoelectric Effect as a Means to Generate X-Rays
Investigation of the Piezoelectric Effect as a Means to Generate X-RaysInvestigation of the Piezoelectric Effect as a Means to Generate X-Rays
Investigation of the Piezoelectric Effect as a Means to Generate X-Rays
 
Different Types of Power Problems
Different Types of Power ProblemsDifferent Types of Power Problems
Different Types of Power Problems
 
Power Quality Parameters Measurement Techniques
Power Quality Parameters Measurement TechniquesPower Quality Parameters Measurement Techniques
Power Quality Parameters Measurement Techniques
 
Amplitude Modulation Circuit Implementation for use in a Communication Course...
Amplitude Modulation Circuit Implementation for use in a Communication Course...Amplitude Modulation Circuit Implementation for use in a Communication Course...
Amplitude Modulation Circuit Implementation for use in a Communication Course...
 
A Review Of The Skin Effect As Applied To Thin Film Interconnections
A Review Of The Skin Effect As Applied To Thin Film InterconnectionsA Review Of The Skin Effect As Applied To Thin Film Interconnections
A Review Of The Skin Effect As Applied To Thin Film Interconnections
 
Power transmission lines electromagnetic pollution with consideration of soil...
Power transmission lines electromagnetic pollution with consideration of soil...Power transmission lines electromagnetic pollution with consideration of soil...
Power transmission lines electromagnetic pollution with consideration of soil...
 
03 partial discharge theory cutler-hammer
03 partial discharge theory cutler-hammer03 partial discharge theory cutler-hammer
03 partial discharge theory cutler-hammer
 
International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...
International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...
International Journal of Biometrics and Bioinformatics(IJBB) Volume (3) Issue...
 
Tony
TonyTony
Tony
 
Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024
Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024
Electromagnetism Concept : Theory to Applications | Superb Explanation ! | 2024
 
30167812 short-circuit-ppt
30167812 short-circuit-ppt30167812 short-circuit-ppt
30167812 short-circuit-ppt
 
MRR Improvement in Electrical Discharge Machining
MRR Improvement in Electrical Discharge MachiningMRR Improvement in Electrical Discharge Machining
MRR Improvement in Electrical Discharge Machining
 
The Effects of Heat on Electronic Components
The Effects of Heat on Electronic ComponentsThe Effects of Heat on Electronic Components
The Effects of Heat on Electronic Components
 
Lecture 1 bee
Lecture 1 beeLecture 1 bee
Lecture 1 bee
 
Current Advanced Research Development of Electric Discharge Machining (EDM): ...
Current Advanced Research Development of Electric Discharge Machining (EDM): ...Current Advanced Research Development of Electric Discharge Machining (EDM): ...
Current Advanced Research Development of Electric Discharge Machining (EDM): ...
 
H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...
H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...
H6 Handbook of Electrical Power System Dynamics Modeling, Stability and Contr...
 

Recently uploaded

microwave assisted reaction. General introduction
microwave assisted reaction. General introductionmicrowave assisted reaction. General introduction
microwave assisted reaction. General introductionMaksud Ahmed
 
Alper Gobel In Media Res Media Component
Alper Gobel In Media Res Media ComponentAlper Gobel In Media Res Media Component
Alper Gobel In Media Res Media ComponentInMediaRes1
 
Presiding Officer Training module 2024 lok sabha elections
Presiding Officer Training module 2024 lok sabha electionsPresiding Officer Training module 2024 lok sabha elections
Presiding Officer Training module 2024 lok sabha electionsanshu789521
 
Mastering the Unannounced Regulatory Inspection
Mastering the Unannounced Regulatory InspectionMastering the Unannounced Regulatory Inspection
Mastering the Unannounced Regulatory InspectionSafetyChain Software
 
KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...
KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...
KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...M56BOOKSTORE PRODUCT/SERVICE
 
Employee wellbeing at the workplace.pptx
Employee wellbeing at the workplace.pptxEmployee wellbeing at the workplace.pptx
Employee wellbeing at the workplace.pptxNirmalaLoungPoorunde1
 
Enzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdf
Enzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdfEnzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdf
Enzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdfSumit Tiwari
 
Accessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impactAccessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impactdawncurless
 
URLs and Routing in the Odoo 17 Website App
URLs and Routing in the Odoo 17 Website AppURLs and Routing in the Odoo 17 Website App
URLs and Routing in the Odoo 17 Website AppCeline George
 
How to Configure Email Server in Odoo 17
How to Configure Email Server in Odoo 17How to Configure Email Server in Odoo 17
How to Configure Email Server in Odoo 17Celine George
 
Hybridoma Technology ( Production , Purification , and Application )
Hybridoma Technology  ( Production , Purification , and Application  ) Hybridoma Technology  ( Production , Purification , and Application  )
Hybridoma Technology ( Production , Purification , and Application ) Sakshi Ghasle
 
MENTAL STATUS EXAMINATION format.docx
MENTAL     STATUS EXAMINATION format.docxMENTAL     STATUS EXAMINATION format.docx
MENTAL STATUS EXAMINATION format.docxPoojaSen20
 
A Critique of the Proposed National Education Policy Reform
A Critique of the Proposed National Education Policy ReformA Critique of the Proposed National Education Policy Reform
A Critique of the Proposed National Education Policy ReformChameera Dedduwage
 
Introduction to AI in Higher Education_draft.pptx
Introduction to AI in Higher Education_draft.pptxIntroduction to AI in Higher Education_draft.pptx
Introduction to AI in Higher Education_draft.pptxpboyjonauth
 
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptxSOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptxiammrhaywood
 
mini mental status format.docx
mini    mental       status     format.docxmini    mental       status     format.docx
mini mental status format.docxPoojaSen20
 
Incoming and Outgoing Shipments in 1 STEP Using Odoo 17
Incoming and Outgoing Shipments in 1 STEP Using Odoo 17Incoming and Outgoing Shipments in 1 STEP Using Odoo 17
Incoming and Outgoing Shipments in 1 STEP Using Odoo 17Celine George
 

Recently uploaded (20)

microwave assisted reaction. General introduction
microwave assisted reaction. General introductionmicrowave assisted reaction. General introduction
microwave assisted reaction. General introduction
 
TataKelola dan KamSiber Kecerdasan Buatan v022.pdf
TataKelola dan KamSiber Kecerdasan Buatan v022.pdfTataKelola dan KamSiber Kecerdasan Buatan v022.pdf
TataKelola dan KamSiber Kecerdasan Buatan v022.pdf
 
Alper Gobel In Media Res Media Component
Alper Gobel In Media Res Media ComponentAlper Gobel In Media Res Media Component
Alper Gobel In Media Res Media Component
 
Presiding Officer Training module 2024 lok sabha elections
Presiding Officer Training module 2024 lok sabha electionsPresiding Officer Training module 2024 lok sabha elections
Presiding Officer Training module 2024 lok sabha elections
 
Mastering the Unannounced Regulatory Inspection
Mastering the Unannounced Regulatory InspectionMastering the Unannounced Regulatory Inspection
Mastering the Unannounced Regulatory Inspection
 
KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...
KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...
KSHARA STURA .pptx---KSHARA KARMA THERAPY (CAUSTIC THERAPY)————IMP.OF KSHARA ...
 
Model Call Girl in Bikash Puri Delhi reach out to us at 🔝9953056974🔝
Model Call Girl in Bikash Puri  Delhi reach out to us at 🔝9953056974🔝Model Call Girl in Bikash Puri  Delhi reach out to us at 🔝9953056974🔝
Model Call Girl in Bikash Puri Delhi reach out to us at 🔝9953056974🔝
 
Employee wellbeing at the workplace.pptx
Employee wellbeing at the workplace.pptxEmployee wellbeing at the workplace.pptx
Employee wellbeing at the workplace.pptx
 
Código Creativo y Arte de Software | Unidad 1
Código Creativo y Arte de Software | Unidad 1Código Creativo y Arte de Software | Unidad 1
Código Creativo y Arte de Software | Unidad 1
 
Enzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdf
Enzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdfEnzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdf
Enzyme, Pharmaceutical Aids, Miscellaneous Last Part of Chapter no 5th.pdf
 
Accessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impactAccessible design: Minimum effort, maximum impact
Accessible design: Minimum effort, maximum impact
 
URLs and Routing in the Odoo 17 Website App
URLs and Routing in the Odoo 17 Website AppURLs and Routing in the Odoo 17 Website App
URLs and Routing in the Odoo 17 Website App
 
How to Configure Email Server in Odoo 17
How to Configure Email Server in Odoo 17How to Configure Email Server in Odoo 17
How to Configure Email Server in Odoo 17
 
Hybridoma Technology ( Production , Purification , and Application )
Hybridoma Technology  ( Production , Purification , and Application  ) Hybridoma Technology  ( Production , Purification , and Application  )
Hybridoma Technology ( Production , Purification , and Application )
 
MENTAL STATUS EXAMINATION format.docx
MENTAL     STATUS EXAMINATION format.docxMENTAL     STATUS EXAMINATION format.docx
MENTAL STATUS EXAMINATION format.docx
 
A Critique of the Proposed National Education Policy Reform
A Critique of the Proposed National Education Policy ReformA Critique of the Proposed National Education Policy Reform
A Critique of the Proposed National Education Policy Reform
 
Introduction to AI in Higher Education_draft.pptx
Introduction to AI in Higher Education_draft.pptxIntroduction to AI in Higher Education_draft.pptx
Introduction to AI in Higher Education_draft.pptx
 
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptxSOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
SOCIAL AND HISTORICAL CONTEXT - LFTVD.pptx
 
mini mental status format.docx
mini    mental       status     format.docxmini    mental       status     format.docx
mini mental status format.docx
 
Incoming and Outgoing Shipments in 1 STEP Using Odoo 17
Incoming and Outgoing Shipments in 1 STEP Using Odoo 17Incoming and Outgoing Shipments in 1 STEP Using Odoo 17
Incoming and Outgoing Shipments in 1 STEP Using Odoo 17
 

Basics of Technical Writing

  • 1. TECHNICAL WRITING COURSE CODE: 301 EL-Batch 15 Section-I B.E Electrical English Language Development Centre ELDC
  • 2. Dr. Habibullah Pathan M.A, M.Ed, ELT (Glasgow, UK), Ph.D. (UK) Post. Doc. (MIT, USA) Humphrey Alumni (Boston University, USA) Mr. Abdul Aziz Magsi M.A (English), PGD. Teaching of English as Foreign Language, M.S (English Linguistics) COURSE INSTRUCTORS & FACILITATORS
  • 3. Contact Hours: Fridays 11:00 to 12:00 (Be in touch before meeting) For further Correspondence Officially magsiabdulaziz@hotmail.com Contact through FB is not mandatory to be entertained.
  • 4. ELDC, MUET Jamshoro Course Details Contact Hours: 28 Credit Hours: 2 Marks Distribution : 10% Attendance 10% Assignments & Presentations 20% Mid-Semester Exam 40% Final Semester Exam
  • 6. • 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
  • 7. • 1- Establish a Basic Criteria of 5 Characteristics of ETR (Effective Technical Writing) ACCCA • i- Accuracy • ii- Clarity • iii- Conciseness • iv- Coherence • v- Appropriate
  • 8. • 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.
  • 9. • 3- Define your Audience i- Users (readers) ii- Level of Expertise iii- Purpose of reading the document iv- Attitude (Towards You and Documents Subject Matter)
  • 10. • So far, you must have done with defining i- Purpose ii- Problem iii- Audience Now go for 4- Collecting, Creating and Assembling Information
  • 11. 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.
  • 12. Feature of Document Expert Managerial Layperson Introductions 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
  • 13. 8- Revise your document in stages i- Organization ii- The Content for Accuracy & Appropriateness
  • 14. 9- Edit the Paragraphs & Sentences To improve Clarity Conciseness Coherence To fix the problems of Grammar, spelling, punctuation, mechanics, or usage 10- One or More Reviews Legal Reviews Technical Reviews Peer Reviews
  • 15. Collaborative Writing Document Planning & Management Drafting Revision
  • 17. 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
  • 18. ACCURACY It is the careful conforming to truth or fact. 3 Aspects of Accuracy 1-Document Accuracy 2-Stylistic Accuracy 3-Technical Accuracy
  • 19. DOCUMENT ACCURACY The 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)
  • 20. STYLISTIC ACCURACY the careful use of language to express meaning Careful use of • Paragraph, Sentences structures, & Word choice • Using words Precisely
  • 21. Technical ACCURACY To 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
  • 22. 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
  • 23. ACCURATE IN TWO WAYS • Stylistically- Precise use of Language • Technically- Use of Specialized Terms (Technical Terms, electromigration, charge, electric field)
  • 24. CLARITY Ease of Understanding Specialized languages, mathematically detailed analyses, and complex conceptual schemes 3 ways to develop calrity 1- Structural clarity 2- Stylistic Clarity 3-Contextual Clarity
  • 25. STRUCTURAL CLARITY making it easy for the reader to get the large picture Focus on • Structure • Design • Organization
  • 26. STYLISTIC CLARITY Use of simple and Direct Language • Simple sentence structure, avoiding wordy sentences (Increase Readability) • Excessive Nominalization • Word Choices
  • 27. CONTEXTUAL CLARITY Availability of Importance, authorization, implications • Reason of your document production • What? Why?, who/ what proceeds? • Introduction • Problem statement • Citations, references
  • 28. 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
  • 29. CLARITY • Simple & Direct Sentences • Word order in the sentences • Clarity is achieved by using rhetorical devices of defining a term.
  • 30. CONCISENESS Conveys only the needed material not all the relevant 2 Strategies 1- Prepare a clear introduction 2- Develop a detailed outline • Use Appendix to be referred to the information not necessary • Eliminate Useless information • Use Graphics
  • 31. 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
  • 32. CONCISENESS • Using minimum words • It does not digress from the point.
  • 33. 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)
  • 34. Paragraph The most powerful instrument of coherence • Organizing material in TS (Topic Sentences) & SS (Supporting Sentences) • Strategies to develop paragraphs Exemplification, Analysis, Comparison and contrast, Definition, Enumeration, Description • Using Referents & Transitional Devices
  • 35. 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
  • 36. 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)
  • 37. APPROPRIATENESS the specific institutional contexts in which it is written and read 2 Aspects Appropriate for Goal Appropriate for Audience’s Purpose See Document Density
  • 38. 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
  • 39. APPROPRIATE • To Purpose (of presenting the process of eletromigration) • To the Audience (readers of Science)
  • 41. • Memoranda • Meeting Documents Agenda Minutes of Meeting • Literature Reviews • Reports (Formal & Informal) Long & Short Lab Reports Research Reports Project Reports Field Visit/ trip Reports Consulting Reports Progress reports Design & Feasibility Report
  • 42. • Letters Job Application Letters Acceptance Letters Transmittal Letters Letters of Inquiry Technical Information Letters References & Letters of Recommendations Obtaining & Providing • Proposals • Press Release • Task Oriented Documents Mannuals (Technical & User Documentation) Instructional Procedures • Theses & Dissertations
  • 43. • Oral Presentations Formal & Informal • Electronic Documentation • Résumé & CV • Covering Letters