SlideShare a Scribd company logo
FOURTEEN STEPS TO A CLEARLY WRITTEN TECHNICAL PAPER
Aftab Alam
Department of Computer Engineering, Kyung Hee University
Fourteen steps to a clearly written technical paper
Contents
Sections of Technical Paper
-- Conclusion & Introduction
-- Abstract Words, Polishing
Fourteen Steps for Clarity
-- Avoid Passive Verbs, Verb Nouns
7
6
5
2
1
4
3 -- Complete First Draft, Order, Transitions
-- Paragraph, Simple Sentences
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
Sections of Technical Paper
• A technical paper will usually have four sections.
1. Introduction
2. Problem Formulation
3. Results
4. Conclusion
• This is the common format for an engineering paper.
• The names of the sections can be different.
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
Sections of Technical Paper
• A technical paper will usually have four sections.
1. Introduction
2. Problem Formulation
3. Results
4. Conclusion
• Open up the subject
– Background.
• Survey past related work
– What other have done?
• Addressed the problem
– show how this work relates to previous work.
• Describe the assumptions & state the obtained results.
– Initial overview of the problem & achievements.
• Overview the contents of the paper.
– Section I contains etc.
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
Sections of Technical Paper
• A technical paper will usually have four sections.
1. Introduction
2. Problem Formulation
3. Results
4. Conclusion
• This section should do three things:
– Define the problem to be considered in detail.
– Define all terminology and notation used.
– Develop the equations on which your results will be based
o describe any experimental systems.
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
Sections of Technical Paper
• A technical paper will usually have four sections.
1. Introduction
2. Problem Formulation
3. Results
4. Conclusion
• Theoretical or experimental result.
– Provide the interpretation of results
– why they behave as they do.
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
Sections of Technical Paper
• A technical paper will usually have four sections.
1. Introduction
2. Problem Formulation
3. Results
4. Conclusion
• Conclusion summarize that what has been accomplished?
• Introduction and Conclusion are important
– Many reader focus Intro and conclusion
– Understandability
o without reading the whole paper
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
14 Steps to a Clearly Written Technical Paper
1. Complete first draft - except for the Introduction and Conclusion.
I. Big picture first and then work towards the details.
II. Do not worry if the wording - Polishing the document comes later.
2. Ideas in the right order
I. Can the reader understand every passage strictly from the material up to that point?”
II. If not, add material or move ideas around.
3. Transitions between ideas
I. At each stage the reader has a roadmap of where (s)he is going?
II. Purpose of that section?
III. Reader must know where you are going and why?
4. Paragraph unity
I. Each paragraph should have one main point (! mix different ideas).
II. Central point of each paragraph is stated in a topical sentence at the beginning of the paragraph,
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
14 Steps to a Clearly Written Technical Paper (Cont’d)
4. Sentence Structure
– Work on the sentences to reduce the fog index F = 0.4(L + P).
o L = (Avg # of words)/sentence
o P = (Avg # of Polysyllables)/(100 words of text)
 Polysyllables - A word with 3 or more syllables (Cat, Alphabet)
o F = 10 – 15 is recommended.
– Example:
o Fog Index = 35:
 In order to eliminate the possibility of errors occurring in the time charges relating to engineering jobs
through transposition of numbers or typing errors, each of the Division Planning Offices should set up
a file of time cards showing all authorized project numbers and make a daily check of the charges on
all time sheets forwarded to the Accounting Department to be sure that only authorized numbers are
used.
 1 sentence, 69 words, 13 polysyllables
o Fog Index = 11:
 It is easy to transpose digits and make typing errors when entering project numbers. We suggest each
Division Planning Office set up a file of time cards showing all authorized project numbers. Then all
charges should be checked each day before sending time sheets to the Accounting Department.”
 3 sentences. 48 words, 5 polysyllables
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
14 Steps to a Clearly Written Technical Paper (Cont’d)
6. Get rid of as many passive verbs as possible
– The data were measured and the results were correlated.
– We measured the data and correlated the results.
7. Use verbs more than nouns
– Example 1:
o “The annual report produced a disappointed reaction from the sponsor.”
o Revision: “The annual report disappointed the sponsor.
– Example 2:
o “It is our expectation that we will see radiation pattern improvement when the antenna is elevated.”
o Revision: “We expect to improve the radiation pattern by elevating the antenna.”
8. Avoid abstract words
– Better if you use specific words instead of abstract words.
– Example:
o We determined the conditions for performance improvement.
o We measured the noise variance necessary to increase the bit error probability by 5 percent.
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
14 Steps to a Clearly Written Technical Paper (Cont’d)
9. Verb Tenses (Present, Fast, & Future)
– Check for consistent use of verb tense.
– Example:
o We shall present our results in Section III.
o We present our results in Section III.
10. Correct use of pronoun
– Do not use “this” as a pronoun
– Avoid sentences such as “This is...” and “This gives
– Example:
o By increasing the impedance, the radiation level is increased and the electric field becomes
stronger. This means that...”
o What specifically does “this” refer to? (Moreover, who did the “increasing”?)
o The solution to this problem is to change “this” to an adjective by inserting a suitable noun.
o “This result is...” “This difficulty is due to...” and so forth
Data & Knowledge Engineering Laboratory
Department of Computer Engineering, Kyung Hee
14 Steps to a Clearly Written Technical Paper (Cont’d)
11. Check for grammatical mistakes
12. Polish and Polish
– Reducing the Fog Index by shortening sentences and eliminating big words (Step 5).
– Checking each paragraph to make sure it has one main point (Step 4).
13. Write the Conclusion
– Summarize for the reader what has been presented in the paper.
14. Write the Introduction
Your Logo
THANK YOU
?

More Related Content

What's hot

How to write papers - A note on Technical Writing
How to write papers - A note on Technical WritingHow to write papers - A note on Technical Writing
How to write papers - A note on Technical Writing
Prof. Mohandas K P
 
MELJUN CORTES research lectures_apa_format_terminal_reports
MELJUN CORTES research lectures_apa_format_terminal_reportsMELJUN CORTES research lectures_apa_format_terminal_reports
MELJUN CORTES research lectures_apa_format_terminal_reports
MELJUN CORTES
 
How toreadsciarticle
How toreadsciarticleHow toreadsciarticle
How toreadsciarticle
Dr. Mahfoudh Hussein Mgammal
 
MELJUN CORTES research final_apa_format_terminalreports_part_ii
MELJUN CORTES research final_apa_format_terminalreports_part_iiMELJUN CORTES research final_apa_format_terminalreports_part_ii
MELJUN CORTES research final_apa_format_terminalreports_part_ii
MELJUN CORTES
 
Scientific writing formats
Scientific writing formatsScientific writing formats
Scientific writing formats
Bahauddin Zakariya University lahore
 
Report writing - Research Protocol
Report writing - Research ProtocolReport writing - Research Protocol
Report writing - Research Protocol
Sarang Narayanan
 
Research project guidelines by nmims
Research project guidelines by nmimsResearch project guidelines by nmims
Research project guidelines by nmimsHarshita Wankhedkar
 
New microsoft office word 97 2003 document
New microsoft office word 97   2003 documentNew microsoft office word 97   2003 document
New microsoft office word 97 2003 document
Rajib Paul
 
Writing Technical Report: Detailed Guide
Writing Technical Report: Detailed GuideWriting Technical Report: Detailed Guide
Writing Technical Report: Detailed Guide
Technical Report
 
how to write a good technical report -hmftj
how to write a good technical report -hmftjhow to write a good technical report -hmftj
how to write a good technical report -hmftj
LGS, GBHS&IC, University Of South-Asia, TARA-Technologies
 
Technical Report Writing (Format of Final year project's thesis)
Technical Report Writing (Format of Final year project's thesis)Technical Report Writing (Format of Final year project's thesis)
Technical Report Writing (Format of Final year project's thesis)
Bilal Nasir
 
01 writing the-paper
01  writing the-paper01  writing the-paper
01 writing the-paper
Dr. Vinayak Bharadi
 
Syllabus final
Syllabus finalSyllabus final
Syllabus final
Dr. Shankar Subramaniam
 
Researchpaper
ResearchpaperResearchpaper
Researchpaper
Luckily Lakshaya
 
Report Writing
Report Writing Report Writing
Report Writing
Dr Sudhir Narayan Singh
 
2012 report writing
2012 report writing2012 report writing
2012 report writingcherylyap61
 
How to write an abstract
How to write an abstractHow to write an abstract
How to write an abstract
danix_cata
 

What's hot (19)

How to write papers - A note on Technical Writing
How to write papers - A note on Technical WritingHow to write papers - A note on Technical Writing
How to write papers - A note on Technical Writing
 
MELJUN CORTES research lectures_apa_format_terminal_reports
MELJUN CORTES research lectures_apa_format_terminal_reportsMELJUN CORTES research lectures_apa_format_terminal_reports
MELJUN CORTES research lectures_apa_format_terminal_reports
 
How toreadsciarticle
How toreadsciarticleHow toreadsciarticle
How toreadsciarticle
 
MELJUN CORTES research final_apa_format_terminalreports_part_ii
MELJUN CORTES research final_apa_format_terminalreports_part_iiMELJUN CORTES research final_apa_format_terminalreports_part_ii
MELJUN CORTES research final_apa_format_terminalreports_part_ii
 
Scientific writing formats
Scientific writing formatsScientific writing formats
Scientific writing formats
 
Report writing - Research Protocol
Report writing - Research ProtocolReport writing - Research Protocol
Report writing - Research Protocol
 
Research project guidelines by nmims
Research project guidelines by nmimsResearch project guidelines by nmims
Research project guidelines by nmims
 
New microsoft office word 97 2003 document
New microsoft office word 97   2003 documentNew microsoft office word 97   2003 document
New microsoft office word 97 2003 document
 
Writing Technical Report: Detailed Guide
Writing Technical Report: Detailed GuideWriting Technical Report: Detailed Guide
Writing Technical Report: Detailed Guide
 
how to write a good technical report -hmftj
how to write a good technical report -hmftjhow to write a good technical report -hmftj
how to write a good technical report -hmftj
 
Technical Report Writing (Format of Final year project's thesis)
Technical Report Writing (Format of Final year project's thesis)Technical Report Writing (Format of Final year project's thesis)
Technical Report Writing (Format of Final year project's thesis)
 
01 writing the-paper
01  writing the-paper01  writing the-paper
01 writing the-paper
 
Syllabus final
Syllabus finalSyllabus final
Syllabus final
 
Project
ProjectProject
Project
 
Researchpaper
ResearchpaperResearchpaper
Researchpaper
 
Report Writing
Report Writing Report Writing
Report Writing
 
Writing an abstract
Writing an abstractWriting an abstract
Writing an abstract
 
2012 report writing
2012 report writing2012 report writing
2012 report writing
 
How to write an abstract
How to write an abstractHow to write an abstract
How to write an abstract
 

Similar to Writing for computer science: Fourteen steps to a clearly written technical paper

Fourteen steps to a clearly written technical paper
Fourteen steps to a clearly written technical paperFourteen steps to a clearly written technical paper
Fourteen steps to a clearly written technical paper
Waqas Nawaz
 
ECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.pptECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.ppt
MdeeqAbdullahi
 
The Art and Science of Technical Writing
The Art and Science of Technical WritingThe Art and Science of Technical Writing
The Art and Science of Technical Writing
jehovah
 
Technical Writing.ppt
Technical Writing.pptTechnical Writing.ppt
Technical Writing.ppt
jehovah
 
Guideline for project writing
Guideline for project writingGuideline for project writing
Guideline for project writingsuryakantbhonge
 
Case Study Research paper- report Spring 20201) Total points.docx
Case Study Research paper- report Spring 20201) Total points.docxCase Study Research paper- report Spring 20201) Total points.docx
Case Study Research paper- report Spring 20201) Total points.docx
zebadiahsummers
 
Python week 6 2019 2020 for grade 10
Python week 6 2019 2020 for grade 10 Python week 6 2019 2020 for grade 10
Python week 6 2019 2020 for grade 10
Osama Ghandour Geris
 
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
ENG101 LECTURE 13 TECHNICAL  REPORT.pptxENG101 LECTURE 13 TECHNICAL  REPORT.pptx
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
Bismark Budu
 
Lec 01 introduction
Lec 01   introductionLec 01   introduction
Lec 01 introduction
UmairMuzaffar9
 
Lec 2
Lec 2Lec 2
Running head Project Type Unit 5 Individual Project3Ty.docx
Running head  Project Type Unit 5 Individual Project3Ty.docxRunning head  Project Type Unit 5 Individual Project3Ty.docx
Running head Project Type Unit 5 Individual Project3Ty.docx
healdkathaleen
 
MBA Project VIVA Questions and Guidelines
MBA Project VIVA Questions and GuidelinesMBA Project VIVA Questions and Guidelines
MBA Project VIVA Questions and Guidelines
dowlath ahmed
 
9th Comp Ch 1 LQ.pdf
9th Comp Ch 1 LQ.pdf9th Comp Ch 1 LQ.pdf
9th Comp Ch 1 LQ.pdf
Naeem Mughal
 
Introduction.pptx
Introduction.pptxIntroduction.pptx
Introduction.pptx
Samar954063
 
ECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.pptECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.ppt
KamalPandey247641
 
TC LAB Technical Writing PPT.ppt
TC LAB Technical Writing PPT.pptTC LAB Technical Writing PPT.ppt
TC LAB Technical Writing PPT.ppt
KamalPandey247641
 
Proposal Presentation.pptx
Proposal Presentation.pptxProposal Presentation.pptx
Proposal Presentation.pptx
keytonallamon
 
Protocol analysis of Knowledge Base System
Protocol analysis of Knowledge Base SystemProtocol analysis of Knowledge Base System
Protocol analysis of Knowledge Base System
Pitambar Jha
 
Forced Convection Full-Technical Lab Report
Forced Convection Full-Technical Lab ReportForced Convection Full-Technical Lab Report
Forced Convection Full-Technical Lab Report
Alfonso Figueroa
 
Design and Analysis of Algorithms.pptx
Design and Analysis of Algorithms.pptxDesign and Analysis of Algorithms.pptx
Design and Analysis of Algorithms.pptx
DeepikaV81
 

Similar to Writing for computer science: Fourteen steps to a clearly written technical paper (20)

Fourteen steps to a clearly written technical paper
Fourteen steps to a clearly written technical paperFourteen steps to a clearly written technical paper
Fourteen steps to a clearly written technical paper
 
ECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.pptECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.ppt
 
The Art and Science of Technical Writing
The Art and Science of Technical WritingThe Art and Science of Technical Writing
The Art and Science of Technical Writing
 
Technical Writing.ppt
Technical Writing.pptTechnical Writing.ppt
Technical Writing.ppt
 
Guideline for project writing
Guideline for project writingGuideline for project writing
Guideline for project writing
 
Case Study Research paper- report Spring 20201) Total points.docx
Case Study Research paper- report Spring 20201) Total points.docxCase Study Research paper- report Spring 20201) Total points.docx
Case Study Research paper- report Spring 20201) Total points.docx
 
Python week 6 2019 2020 for grade 10
Python week 6 2019 2020 for grade 10 Python week 6 2019 2020 for grade 10
Python week 6 2019 2020 for grade 10
 
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
ENG101 LECTURE 13 TECHNICAL  REPORT.pptxENG101 LECTURE 13 TECHNICAL  REPORT.pptx
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
 
Lec 01 introduction
Lec 01   introductionLec 01   introduction
Lec 01 introduction
 
Lec 2
Lec 2Lec 2
Lec 2
 
Running head Project Type Unit 5 Individual Project3Ty.docx
Running head  Project Type Unit 5 Individual Project3Ty.docxRunning head  Project Type Unit 5 Individual Project3Ty.docx
Running head Project Type Unit 5 Individual Project3Ty.docx
 
MBA Project VIVA Questions and Guidelines
MBA Project VIVA Questions and GuidelinesMBA Project VIVA Questions and Guidelines
MBA Project VIVA Questions and Guidelines
 
9th Comp Ch 1 LQ.pdf
9th Comp Ch 1 LQ.pdf9th Comp Ch 1 LQ.pdf
9th Comp Ch 1 LQ.pdf
 
Introduction.pptx
Introduction.pptxIntroduction.pptx
Introduction.pptx
 
ECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.pptECE 4901 Technical Writing 2013.ppt
ECE 4901 Technical Writing 2013.ppt
 
TC LAB Technical Writing PPT.ppt
TC LAB Technical Writing PPT.pptTC LAB Technical Writing PPT.ppt
TC LAB Technical Writing PPT.ppt
 
Proposal Presentation.pptx
Proposal Presentation.pptxProposal Presentation.pptx
Proposal Presentation.pptx
 
Protocol analysis of Knowledge Base System
Protocol analysis of Knowledge Base SystemProtocol analysis of Knowledge Base System
Protocol analysis of Knowledge Base System
 
Forced Convection Full-Technical Lab Report
Forced Convection Full-Technical Lab ReportForced Convection Full-Technical Lab Report
Forced Convection Full-Technical Lab Report
 
Design and Analysis of Algorithms.pptx
Design and Analysis of Algorithms.pptxDesign and Analysis of Algorithms.pptx
Design and Analysis of Algorithms.pptx
 

More from aftab alam

Locally densest subgraph discovery
Locally densest subgraph discoveryLocally densest subgraph discovery
Locally densest subgraph discovery
aftab alam
 
Carved visual hulls for image based modeling
Carved visual hulls for image based modelingCarved visual hulls for image based modeling
Carved visual hulls for image based modeling
aftab alam
 
Apache Spark sql
Apache Spark sqlApache Spark sql
Apache Spark sql
aftab alam
 
Distributed graph summarization
Distributed graph summarizationDistributed graph summarization
Distributed graph summarization
aftab alam
 
A Graph Summarization: A Survey | Summarizing and understanding large graphs
A Graph Summarization: A Survey | Summarizing and understanding large graphsA Graph Summarization: A Survey | Summarizing and understanding large graphs
A Graph Summarization: A Survey | Summarizing and understanding large graphs
aftab alam
 
Compressing Graphs and Indexes with Recursive Graph Bisection
Compressing Graphs and Indexes with Recursive Graph Bisection Compressing Graphs and Indexes with Recursive Graph Bisection
Compressing Graphs and Indexes with Recursive Graph Bisection
aftab alam
 
SCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATION
SCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATIONSCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATION
SCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATION
aftab alam
 
Efficient aggregation for graph summarization
Efficient aggregation for graph summarizationEfficient aggregation for graph summarization
Efficient aggregation for graph summarization
aftab alam
 

More from aftab alam (8)

Locally densest subgraph discovery
Locally densest subgraph discoveryLocally densest subgraph discovery
Locally densest subgraph discovery
 
Carved visual hulls for image based modeling
Carved visual hulls for image based modelingCarved visual hulls for image based modeling
Carved visual hulls for image based modeling
 
Apache Spark sql
Apache Spark sqlApache Spark sql
Apache Spark sql
 
Distributed graph summarization
Distributed graph summarizationDistributed graph summarization
Distributed graph summarization
 
A Graph Summarization: A Survey | Summarizing and understanding large graphs
A Graph Summarization: A Survey | Summarizing and understanding large graphsA Graph Summarization: A Survey | Summarizing and understanding large graphs
A Graph Summarization: A Survey | Summarizing and understanding large graphs
 
Compressing Graphs and Indexes with Recursive Graph Bisection
Compressing Graphs and Indexes with Recursive Graph Bisection Compressing Graphs and Indexes with Recursive Graph Bisection
Compressing Graphs and Indexes with Recursive Graph Bisection
 
SCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATION
SCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATIONSCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATION
SCALABLE PATTERN MATCHING OVER COMPRESSED GRAPHS VIA DE-DENSIFICATION
 
Efficient aggregation for graph summarization
Efficient aggregation for graph summarizationEfficient aggregation for graph summarization
Efficient aggregation for graph summarization
 

Recently uploaded

Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
National Information Standards Organization (NISO)
 
What is the purpose of studying mathematics.pptx
What is the purpose of studying mathematics.pptxWhat is the purpose of studying mathematics.pptx
What is the purpose of studying mathematics.pptx
christianmathematics
 
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...
Levi Shapiro
 
Your Skill Boost Masterclass: Strategies for Effective Upskilling
Your Skill Boost Masterclass: Strategies for Effective UpskillingYour Skill Boost Masterclass: Strategies for Effective Upskilling
Your Skill Boost Masterclass: Strategies for Effective Upskilling
Excellence Foundation for South Sudan
 
The simplified electron and muon model, Oscillating Spacetime: The Foundation...
The simplified electron and muon model, Oscillating Spacetime: The Foundation...The simplified electron and muon model, Oscillating Spacetime: The Foundation...
The simplified electron and muon model, Oscillating Spacetime: The Foundation...
RitikBhardwaj56
 
The basics of sentences session 5pptx.pptx
The basics of sentences session 5pptx.pptxThe basics of sentences session 5pptx.pptx
The basics of sentences session 5pptx.pptx
heathfieldcps1
 
S1-Introduction-Biopesticides in ICM.pptx
S1-Introduction-Biopesticides in ICM.pptxS1-Introduction-Biopesticides in ICM.pptx
S1-Introduction-Biopesticides in ICM.pptx
tarandeep35
 
PCOS corelations and management through Ayurveda.
PCOS corelations and management through Ayurveda.PCOS corelations and management through Ayurveda.
PCOS corelations and management through Ayurveda.
Dr. Shivangi Singh Parihar
 
ANATOMY AND BIOMECHANICS OF HIP JOINT.pdf
ANATOMY AND BIOMECHANICS OF HIP JOINT.pdfANATOMY AND BIOMECHANICS OF HIP JOINT.pdf
ANATOMY AND BIOMECHANICS OF HIP JOINT.pdf
Priyankaranawat4
 
Thesis Statement for students diagnonsed withADHD.ppt
Thesis Statement for students diagnonsed withADHD.pptThesis Statement for students diagnonsed withADHD.ppt
Thesis Statement for students diagnonsed withADHD.ppt
EverAndrsGuerraGuerr
 
Best Digital Marketing Institute In NOIDA
Best Digital Marketing Institute In NOIDABest Digital Marketing Institute In NOIDA
Best Digital Marketing Institute In NOIDA
deeptiverma2406
 
Aficamten in HCM (SEQUOIA HCM TRIAL 2024)
Aficamten in HCM (SEQUOIA HCM TRIAL 2024)Aficamten in HCM (SEQUOIA HCM TRIAL 2024)
Aficamten in HCM (SEQUOIA HCM TRIAL 2024)
Ashish Kohli
 
A Strategic Approach: GenAI in Education
A Strategic Approach: GenAI in EducationA Strategic Approach: GenAI in Education
A Strategic Approach: GenAI in Education
Peter Windle
 
Advantages and Disadvantages of CMS from an SEO Perspective
Advantages and Disadvantages of CMS from an SEO PerspectiveAdvantages and Disadvantages of CMS from an SEO Perspective
Advantages and Disadvantages of CMS from an SEO Perspective
Krisztián Száraz
 
kitab khulasah nurul yaqin jilid 1 - 2.pptx
kitab khulasah nurul yaqin jilid 1 - 2.pptxkitab khulasah nurul yaqin jilid 1 - 2.pptx
kitab khulasah nurul yaqin jilid 1 - 2.pptx
datarid22
 
Digital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental DesignDigital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental Design
amberjdewit93
 
How to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP ModuleHow to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP Module
Celine George
 
Pride Month Slides 2024 David Douglas School District
Pride Month Slides 2024 David Douglas School DistrictPride Month Slides 2024 David Douglas School District
Pride Month Slides 2024 David Douglas School District
David Douglas School District
 
Biological Screening of Herbal Drugs in detailed.
Biological Screening of Herbal Drugs in detailed.Biological Screening of Herbal Drugs in detailed.
Biological Screening of Herbal Drugs in detailed.
Ashokrao Mane college of Pharmacy Peth-Vadgaon
 
PIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf IslamabadPIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf Islamabad
AyyanKhan40
 

Recently uploaded (20)

Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
Pollock and Snow "DEIA in the Scholarly Landscape, Session One: Setting Expec...
 
What is the purpose of studying mathematics.pptx
What is the purpose of studying mathematics.pptxWhat is the purpose of studying mathematics.pptx
What is the purpose of studying mathematics.pptx
 
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...
June 3, 2024 Anti-Semitism Letter Sent to MIT President Kornbluth and MIT Cor...
 
Your Skill Boost Masterclass: Strategies for Effective Upskilling
Your Skill Boost Masterclass: Strategies for Effective UpskillingYour Skill Boost Masterclass: Strategies for Effective Upskilling
Your Skill Boost Masterclass: Strategies for Effective Upskilling
 
The simplified electron and muon model, Oscillating Spacetime: The Foundation...
The simplified electron and muon model, Oscillating Spacetime: The Foundation...The simplified electron and muon model, Oscillating Spacetime: The Foundation...
The simplified electron and muon model, Oscillating Spacetime: The Foundation...
 
The basics of sentences session 5pptx.pptx
The basics of sentences session 5pptx.pptxThe basics of sentences session 5pptx.pptx
The basics of sentences session 5pptx.pptx
 
S1-Introduction-Biopesticides in ICM.pptx
S1-Introduction-Biopesticides in ICM.pptxS1-Introduction-Biopesticides in ICM.pptx
S1-Introduction-Biopesticides in ICM.pptx
 
PCOS corelations and management through Ayurveda.
PCOS corelations and management through Ayurveda.PCOS corelations and management through Ayurveda.
PCOS corelations and management through Ayurveda.
 
ANATOMY AND BIOMECHANICS OF HIP JOINT.pdf
ANATOMY AND BIOMECHANICS OF HIP JOINT.pdfANATOMY AND BIOMECHANICS OF HIP JOINT.pdf
ANATOMY AND BIOMECHANICS OF HIP JOINT.pdf
 
Thesis Statement for students diagnonsed withADHD.ppt
Thesis Statement for students diagnonsed withADHD.pptThesis Statement for students diagnonsed withADHD.ppt
Thesis Statement for students diagnonsed withADHD.ppt
 
Best Digital Marketing Institute In NOIDA
Best Digital Marketing Institute In NOIDABest Digital Marketing Institute In NOIDA
Best Digital Marketing Institute In NOIDA
 
Aficamten in HCM (SEQUOIA HCM TRIAL 2024)
Aficamten in HCM (SEQUOIA HCM TRIAL 2024)Aficamten in HCM (SEQUOIA HCM TRIAL 2024)
Aficamten in HCM (SEQUOIA HCM TRIAL 2024)
 
A Strategic Approach: GenAI in Education
A Strategic Approach: GenAI in EducationA Strategic Approach: GenAI in Education
A Strategic Approach: GenAI in Education
 
Advantages and Disadvantages of CMS from an SEO Perspective
Advantages and Disadvantages of CMS from an SEO PerspectiveAdvantages and Disadvantages of CMS from an SEO Perspective
Advantages and Disadvantages of CMS from an SEO Perspective
 
kitab khulasah nurul yaqin jilid 1 - 2.pptx
kitab khulasah nurul yaqin jilid 1 - 2.pptxkitab khulasah nurul yaqin jilid 1 - 2.pptx
kitab khulasah nurul yaqin jilid 1 - 2.pptx
 
Digital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental DesignDigital Artefact 1 - Tiny Home Environmental Design
Digital Artefact 1 - Tiny Home Environmental Design
 
How to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP ModuleHow to Add Chatter in the odoo 17 ERP Module
How to Add Chatter in the odoo 17 ERP Module
 
Pride Month Slides 2024 David Douglas School District
Pride Month Slides 2024 David Douglas School DistrictPride Month Slides 2024 David Douglas School District
Pride Month Slides 2024 David Douglas School District
 
Biological Screening of Herbal Drugs in detailed.
Biological Screening of Herbal Drugs in detailed.Biological Screening of Herbal Drugs in detailed.
Biological Screening of Herbal Drugs in detailed.
 
PIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf IslamabadPIMS Job Advertisement 2024.pdf Islamabad
PIMS Job Advertisement 2024.pdf Islamabad
 

Writing for computer science: Fourteen steps to a clearly written technical paper

  • 1. FOURTEEN STEPS TO A CLEARLY WRITTEN TECHNICAL PAPER Aftab Alam Department of Computer Engineering, Kyung Hee University
  • 2. Fourteen steps to a clearly written technical paper Contents Sections of Technical Paper -- Conclusion & Introduction -- Abstract Words, Polishing Fourteen Steps for Clarity -- Avoid Passive Verbs, Verb Nouns 7 6 5 2 1 4 3 -- Complete First Draft, Order, Transitions -- Paragraph, Simple Sentences
  • 3. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee Sections of Technical Paper • A technical paper will usually have four sections. 1. Introduction 2. Problem Formulation 3. Results 4. Conclusion • This is the common format for an engineering paper. • The names of the sections can be different.
  • 4. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee Sections of Technical Paper • A technical paper will usually have four sections. 1. Introduction 2. Problem Formulation 3. Results 4. Conclusion • Open up the subject – Background. • Survey past related work – What other have done? • Addressed the problem – show how this work relates to previous work. • Describe the assumptions & state the obtained results. – Initial overview of the problem & achievements. • Overview the contents of the paper. – Section I contains etc.
  • 5. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee Sections of Technical Paper • A technical paper will usually have four sections. 1. Introduction 2. Problem Formulation 3. Results 4. Conclusion • This section should do three things: – Define the problem to be considered in detail. – Define all terminology and notation used. – Develop the equations on which your results will be based o describe any experimental systems.
  • 6. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee Sections of Technical Paper • A technical paper will usually have four sections. 1. Introduction 2. Problem Formulation 3. Results 4. Conclusion • Theoretical or experimental result. – Provide the interpretation of results – why they behave as they do.
  • 7. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee Sections of Technical Paper • A technical paper will usually have four sections. 1. Introduction 2. Problem Formulation 3. Results 4. Conclusion • Conclusion summarize that what has been accomplished? • Introduction and Conclusion are important – Many reader focus Intro and conclusion – Understandability o without reading the whole paper
  • 8. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee 14 Steps to a Clearly Written Technical Paper 1. Complete first draft - except for the Introduction and Conclusion. I. Big picture first and then work towards the details. II. Do not worry if the wording - Polishing the document comes later. 2. Ideas in the right order I. Can the reader understand every passage strictly from the material up to that point?” II. If not, add material or move ideas around. 3. Transitions between ideas I. At each stage the reader has a roadmap of where (s)he is going? II. Purpose of that section? III. Reader must know where you are going and why? 4. Paragraph unity I. Each paragraph should have one main point (! mix different ideas). II. Central point of each paragraph is stated in a topical sentence at the beginning of the paragraph,
  • 9. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee 14 Steps to a Clearly Written Technical Paper (Cont’d) 4. Sentence Structure – Work on the sentences to reduce the fog index F = 0.4(L + P). o L = (Avg # of words)/sentence o P = (Avg # of Polysyllables)/(100 words of text)  Polysyllables - A word with 3 or more syllables (Cat, Alphabet) o F = 10 – 15 is recommended. – Example: o Fog Index = 35:  In order to eliminate the possibility of errors occurring in the time charges relating to engineering jobs through transposition of numbers or typing errors, each of the Division Planning Offices should set up a file of time cards showing all authorized project numbers and make a daily check of the charges on all time sheets forwarded to the Accounting Department to be sure that only authorized numbers are used.  1 sentence, 69 words, 13 polysyllables o Fog Index = 11:  It is easy to transpose digits and make typing errors when entering project numbers. We suggest each Division Planning Office set up a file of time cards showing all authorized project numbers. Then all charges should be checked each day before sending time sheets to the Accounting Department.”  3 sentences. 48 words, 5 polysyllables
  • 10. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee 14 Steps to a Clearly Written Technical Paper (Cont’d) 6. Get rid of as many passive verbs as possible – The data were measured and the results were correlated. – We measured the data and correlated the results. 7. Use verbs more than nouns – Example 1: o “The annual report produced a disappointed reaction from the sponsor.” o Revision: “The annual report disappointed the sponsor. – Example 2: o “It is our expectation that we will see radiation pattern improvement when the antenna is elevated.” o Revision: “We expect to improve the radiation pattern by elevating the antenna.” 8. Avoid abstract words – Better if you use specific words instead of abstract words. – Example: o We determined the conditions for performance improvement. o We measured the noise variance necessary to increase the bit error probability by 5 percent.
  • 11. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee 14 Steps to a Clearly Written Technical Paper (Cont’d) 9. Verb Tenses (Present, Fast, & Future) – Check for consistent use of verb tense. – Example: o We shall present our results in Section III. o We present our results in Section III. 10. Correct use of pronoun – Do not use “this” as a pronoun – Avoid sentences such as “This is...” and “This gives – Example: o By increasing the impedance, the radiation level is increased and the electric field becomes stronger. This means that...” o What specifically does “this” refer to? (Moreover, who did the “increasing”?) o The solution to this problem is to change “this” to an adjective by inserting a suitable noun. o “This result is...” “This difficulty is due to...” and so forth
  • 12. Data & Knowledge Engineering Laboratory Department of Computer Engineering, Kyung Hee 14 Steps to a Clearly Written Technical Paper (Cont’d) 11. Check for grammatical mistakes 12. Polish and Polish – Reducing the Fog Index by shortening sentences and eliminating big words (Step 5). – Checking each paragraph to make sure it has one main point (Step 4). 13. Write the Conclusion – Summarize for the reader what has been presented in the paper. 14. Write the Introduction