Professional Documents
Culture Documents
IE761
2
Dr. Sameer Al-Dahidi
How to write a Technical Paper?[1]
1. Think about the topic you want to present, for some days or weeks.
2. Make Figures and Tables.
3. Then write as quickly as possible, as if thinking out loud. Get everything down,
ignoring spelling, grammar, style and troublesome words.
4. Correct and rewrite only when the whole text is on paper.
Do not split the manuscript among the co-authors. It is better to write a first
complete draft, and then the co-authors can amend and add new text. In this way, the
internal coherence of the paper is ensured. Ask each reviewer to track their changes.
3
Dr. Sameer Al-Dahidi
General structure of a research article[2]
• Title
• Abstract
• Keywords
• Introduction/Literature Review
• Methodology/Methods
• Results and Discussion
4
Dr. Sameer Al-Dahidi
General structure of a research article[2]
5
Dr. Sameer Al-Dahidi
What is a typical paper? [2]
• Not the same for all journals, even in the same field:
6
Dr. Sameer Al-Dahidi
Effective manuscript titles[2]
7
Dr. Sameer Al-Dahidi
Title – Some examples[2]
8
Dr. Sameer Al-Dahidi
Special attention: Authorship[2]
✓ First Author:
➢ Conducts and/or supervises the data generation and analysis and the proper
presentation and interpretation of the results.
➢ Puts paper together and submits the paper to journal.
9
Dr. Sameer Al-Dahidi
Special attention: Authorship[2]
✓ Avoid
1. Ghost Authorship: leaving out authors who should be included
2. Gift Authorship: including authors who did not contribute significantly
10
Dr. Sameer Al-Dahidi
Keywords[2]
11
Dr. Sameer Al-Dahidi
Abstract[2]
• A clear abstract will strongly influence whether or not your work is further
considered...
• Make it accurate and specific, say what has been done and what were the main
findings;
12
Dr. Sameer Al-Dahidi
Introduction[2]
• Provide context to convince readers that you clearly know why your work
is useful:
13
Dr. Sameer Al-Dahidi
Introduction[2]
• Some tips:
14
Dr. Sameer Al-Dahidi
Methods[2]
15
Dr. Sameer Al-Dahidi
Methods[2]
16
Dr. Sameer Al-Dahidi
Results[2]
17
Dr. Sameer Al-Dahidi
Graphs[2]
• Use colour ONLY when necessary e.g. if different line styles can clarify the
meaning, use this instead of colour.
• Figure should be visible and distinguishable when printed out in black & white.
18
Dr. Sameer Al-Dahidi
Photographs[2]
19
Dr. Sameer Al-Dahidi
Tables[2]
20
Dr. Sameer Al-Dahidi
Tables[2]
21
Dr. Sameer Al-Dahidi
Tables[2]
22
Dr. Sameer Al-Dahidi
Tables[2]
23
Dr. Sameer Al-Dahidi
Discussion[2]
• Interpretation of results;
24
Dr. Sameer Al-Dahidi
Discussion[2]
25
Dr. Sameer Al-Dahidi
Conclusions[2]
• Be clear;
26
Dr. Sameer Al-Dahidi
Acknowledgments[2]
• Advisors
27
Dr. Sameer Al-Dahidi
References[2]
It is important that you give precise details of all the work by other authors which
has been referred to within the article. Details should include:
28
Dr. Sameer Al-Dahidi
References[2]
• Always ensure you have fully absorbed the material you are referencing
29
Dr. Sameer Al-Dahidi
References Styles: Citations Guidelines (APA and IEEE)[3]
• In-text citations: How you cite sources when you refer to them in the
text.
• Reference list entries: How you order and format publication information
for each source in the list at the end of your paper.
30
Dr. Sameer Al-Dahidi
References Styles: Citations Guidelines (APA and IEEE) [3]
• There are many different citation styles, and the preferred style often depends
on your discipline.
• However, some universities require the use of a single citation style across all
departments. The chart below gives an overview of how often different styles
are used.
31
Dr. Sameer Al-Dahidi
References Styles: Citations Guidelines (APA and IEEE) [3]
32
Dr. Sameer Al-Dahidi
References Styles: Citations Guidelines (APA and IEEE) [3]
• APA style was created by the American Psychological Association and was
originally used in psychology and social sciences. Today many other
disciplines also use it. APA citation style uses an author-date system of
parenthetical citation.
34
Dr. Sameer Al-Dahidi
IEEE Citation Style[5]
35
Dr. Sameer Al-Dahidi
Appendices[2]
An appendix contains additional information related to the article but which is not
essential to the main findings.
This can be consulted if the reader wishes but the article should not depend on
this.
36
Dr. Sameer Al-Dahidi
Submission[2]
• Final check
37
Dr. Sameer Al-Dahidi
Cover Letter[2]
• Albeit that most editors will not reject a manuscript only because the cover
letter is bad, a good cover letter may accelerate the editorial process of your
paper.
38
Dr. Sameer Al-Dahidi
Cover Letter[2]
39
Dr. Sameer Al-Dahidi
Suggested potential reviewers - Opposed reviewers[2]
• Your suggestions will help the Editor to pass your manuscript to the review
stage more efficiently.
• You can easily find potential reviewers and their contact details by mentioning
authors from articles in your specific subject area (e.g., your references).
• The reviewers should represent at least two regions of the world. And they
should not be your supervisor or close friends.
40
Dr. Sameer Al-Dahidi
41
Dr. Sameer Al-Dahidi
References
42
Dr. Sameer Al-Dahidi
Acknowledgment
43
Dr. Sameer Al-Dahidi
Technical Writing[1]
• General tips:
1. Active or passive?
→ The active voice reads as follows: “I recommend …”
→ The passive voice reads: “It is recommended that …”
→ The active voice allows you to write short, punchy sentences.
→ The passive appears more formal and considered.
→ Be aware of these differences and avoid mixing the two voices.
2. Simplicity
→ Most written articles should avoid using overly complicated language. If a
report is to persuade, brief or justify, it's message must be clear. Furthermore,
the factual presentation of data should not be swamped with sophisticated,
lengthy sentences.
→ Avoid using unnecessary jargon. This confuses even the most informed reader.
→ Ensure that your abbreviations are standardised. All too often authors invent
their own jargon to ease the pressure on writing things in full. Be cautious of
confusing your reader.
44
Dr. Sameer Al-Dahidi
Technical Writing[1]
• General tips:
3. Use of language
→ Most reports should avoid the use of subjective language. For example, to
report on a change in colouration from a “amazing green to a beautiful blue" is
to project your own values onto a measurable outcome. What does the term
"beautiful" mean to you? What will it mean to your reader? Such subjective, or
personal language commonly has no place in the more objective field of report
writing.
45
Dr. Sameer Al-Dahidi
Technical Writing
46
Dr. Sameer Al-Dahidi
Literature Review[3,4]
• Literature review is often used to describe the process of finding out about
previous work from a range of sources.
• A literature review provides the readers with a picture of the state of knowledge
and the main questions in the subject area being investigated. (Bell, 1999, p.
93)
• A literature review is “an extensive critical review of the extant literature on the
research topic”. (Clare & Hamilton, 2003, p. 8)
• A literature review “contains a critical analysis and the integration of
information from a number sources, as well as a consideration of any gaps in
the literature and possibilities of future research”. (Manalo & Trafford, 2004, p.
45)
47
Dr. Sameer Al-Dahidi
Why literature review? [3,4]
• A literature review ensures that you are at least familiar with the body of
research in your field before starting your own investigations. Writing a
literature review also provides practice in critical thinking. Once you have
applied critical thinking skills to the findings of past researchers, you are in a
better position to apply theses same skills to your own work.
• The BIG PICTURE of the phenomenon:
1. To thoroughly understand and describe work done on the specific area
of research you are about to embark on;
2. To evaluate this work, either in terms of content knowledge or the
methodology:
o What was already done?
o Were the studies sufficient to explain the subject matter?
o What more is needed to be done?
48
Dr. Sameer Al-Dahidi
Benefits of literature review[3,4]
• We will get to know (see examples of previous research works –the instructor):
1. the content variables and the connections among them;
2. the context of study
3. the methodologies and research techniques previously used
4. What is left to be done/gap
5. the popular figures of the subject matter
49
Dr. Sameer Al-Dahidi
Literature Review[3,4]
• Any good research includes two distinct types of literature review, they are:
50
Dr. Sameer Al-Dahidi
Sources of Information[3,4]
1. Textbooks;
2. Articles in scientific journals;
3. Conference proceedings;
4. Theses and dissertations;
5. Company reports;
6. People;
7. Magazines and newspapers; and
8. Internet.
51
Dr. Sameer Al-Dahidi
Sources of Information[3,4]
• The first four items on the list are the most reliable sources of
information, and are the most commonly referenced in scientific reporting.
1. Textbooks
• Textbooks should be the starting place for finding out about a new
field.
• Textbooks do have an inherent disadvantage, though, in that they
often contain out-of-date information, particularly in fast-
developing fields.
52
Dr. Sameer Al-Dahidi
Sources of Information[3,4]
• The first four items on the list are the most reliable sources of
information, and are the most commonly referenced in scientific reporting.
• The first four items on the list are the most reliable sources of
information, and are the most commonly referenced in scientific reporting.
3. Conference Proceedings
• Conferences are gatherings of researchers in a particular field
where scientific results are presented as papers.
• Many conferences publish proceedings, which are collections of
the (major) papers presented at the conference.
54
Dr. Sameer Al-Dahidi
Sources of Information[3,4]
• The first four items on the list are the most reliable sources of
information, and are the most commonly referenced in scientific reporting.
55
Dr. Sameer Al-Dahidi
Sources of Information[3,4]
5. Company Reports
• Many companies commission scientific research into practical
problems.
• Prepared by the researcher(s) for the company.
6. People
7. Magazines and Newspapers
• Some magazines (e.g. National Geographic) have strong track
records of reliable reporting, while others (which we leave the
reader to name) are less reliable.
8. Internet
• The Internet is an excellent way to try to track down information,
but since one cannot always be sure of the correctness of the data
on a site, it should not by itself be a large-scale source of
information.
56
Dr. Sameer Al-Dahidi
Accessing Information[3,4]
• There are three steps to obtaining information: finding out which reports
(books, articles, etc.) are useful, obtaining copies of them, and then reading
them. The usefulness of the material can be determined from:
57
Dr. Sameer Al-Dahidi
Accessing Information[3,4]
58
Dr. Sameer Al-Dahidi
Make a Record[3,4]
• The use of phrases like 'Someone I read said something like…' in your reports
will not endear you to your fellow researchers.
• Your records should also include the information you need to reference each
source, i.e., the title, the author(s), the year of publication, and:
o For books: the publisher and place of publication;
o For journals: the journal name, volume and number; and
o for proceedings: the conference name and the place where it was held.
59
Dr. Sameer Al-Dahidi
Practical Strategies for Literature Review[5]
60
Dr. Sameer Al-Dahidi
Literature Review Organization[5]
1. Topical
2. Distant to close
3. Debate
4. Chronological
5. Seminal Study
61
Dr. Sameer Al-Dahidi
Literature Review Organization[5]
1. Topical
62
Dr. Sameer Al-Dahidi
Literature Review Organization[5]
2. Distant to Close
63
Dr. Sameer Al-Dahidi
Literature Review Organization[5]
3. Debate
▪ There have been two (three, four, etc.) distinct approaches this problem.
▪ The first model posits…
▪ The second model argues that the first model is wrong for three reasons.
Instead, the second model claims…
64
Dr. Sameer Al-Dahidi
Literature Review Organization[5]
4. Chronological
65
Dr. Sameer Al-Dahidi
Literature Review Organization[5]
5. Seminal Study
▪ The most important research on this topic was the study by X in (date).
▪ Following X’s study, research fell into two camps (extended X’s work,
etc.)
66
Dr. Sameer Al-Dahidi
Strategies for Literature Review[5]
67
Dr. Sameer Al-Dahidi
Strategies for Literature Review[5]
Remember:
• To seek to understand the whole theories and models → textbooks
• To explore what has been studied. The recent 10 years. The whole world, also
in your population of study → review papers (a smart short-cut)
68
Dr. Sameer Al-Dahidi
Strategies for Literature Review[5]
69
Dr. Sameer Al-Dahidi
How to Present a Technical Paper? [6]
• Tips to be covered:
o Outlines
o Slide Structure
o Fonts
o Colour
o Background
o Graphs
o Spelling and Grammar
o Conclusions
o Questions
70
Dr. Sameer Al-Dahidi
Outline [6]
• Make your 1st or 2nd slide an outline of your presentation (for example: the
previous slide)
• Follow the order of your outline for the rest of the presentation
• Only place main points on the outline slide (for example: use the titles of each
slide as main points)
71
Dr. Sameer Al-Dahidi
Slide Structure - GOOD [6]
72
Dr. Sameer Al-Dahidi
Slide Structure - BAD [6]
• This page contains too many words for a presentation slide. It is not written in
point form, making it difficult both for your audience to read and for you to
present each point. Although there are exactly the same number of points on
this slide as the previous slide, it looks much more complicated. In short, your
audience will spend too much time trying to read this paragraph instead of
listening to you.
73
Dr. Sameer Al-Dahidi
Slide Structure - GOOD [6]
74
Dr. Sameer Al-Dahidi
Slide Structure - BAD [6]
75
Dr. Sameer Al-Dahidi
Fonts - GOOD [6]
76
Dr. Sameer Al-Dahidi
Fonts - BAD [6]
If you use a small font, your audience will not be able to read what you have written
77
Dr. Sameer Al-Dahidi
Colour - GOOD [6]
78
Dr. Sameer Al-Dahidi
Colour - BAD [6]
• Using a font colour that does not contrast with the background colour is hard to
read
79
Dr. Sameer Al-Dahidi
Background - GOOD [6]
• Use backgrounds such as this one that are attractive but simple
80
Dr. Sameer Al-Dahidi
Background - BAD [6]
81
Dr. Sameer Al-Dahidi
Graphs - GOOD [6]
82
Dr. Sameer Al-Dahidi
Graphs - BAD [6]
83
Dr. Sameer Al-Dahidi
Graphs - GOOD [6]
100
90
80
70
60
Blue Balls
50
Red Balls
40
30
20
10
0
January February March April
84
Dr. Sameer Al-Dahidi
Graphs - BAD [6]
100
90
90
80
70
60
Blue Balls
50
Red Balls
38.6
40
34.6
30.6 31.6
30 27.4
20.4 20.4
20
10
0
January February March April
85
Dr. Sameer Al-Dahidi
Graphs - BAD [6]
86
Dr. Sameer Al-Dahidi
Spelling and Grammar [6]
• If English is not your first language, please have someone else check your
presentation!
87
Dr. Sameer Al-Dahidi
Conclusion [6]
88
Dr. Sameer Al-Dahidi
Questions [6]
89
Dr. Sameer Al-Dahidi
Presentation Evaluation [6]
90
Dr. Sameer Al-Dahidi
References
[1] https://eclass.aueb.gr/modules/document/file.php/ME342/Report%20Drafting.pdf
[2] B. Qawasmeh, Research Methodologies Course: Technical Writing: Definitions, Goals,
and Writing Process. M.Sc. Program, University of Jordan, 2019.
[3] B. Qawasmeh, Research Methodologies Course: What is Literature Review?. M.Sc.
Program, University of Jordan, 2019.
[4] B. Qawasmeh, Research Methodologies Course: Strategies for Writing Literature
Reviews. M.Sc. Program, University of Jordan, 2019.
[5] M. S. Ishak, N. Fauzan, Writing Effective Literature Review: Some practical Strategies
for Beginners, November 2015, University Malaysia.
[6] B. Qawasmeh, Research Methodologies Course: Making PowerPoint Slides - Avoiding
the Pitfalls of Bad Slides. M.Sc. Program, University of Jordan, 2019.
91
Dr. Sameer Al-Dahidi
Acknowledgment
92
Dr. Sameer Al-Dahidi
Thank You
Dr. Sameer Al-Dahidi
Associate Professor, Exchange Coordinator
Mechanical and Maintenance Engineering Department
GJU
sameer.aldahidi@gju.edu.jo