Download as pptx, pdf, or txt
Download as pptx, pdf, or txt
You are on page 1of 154

Introduction to paper

and report writing


Martin Renilson
martin@renilson-marine.com

23 November 2022
Summary
• Academic paper/technical report
Summary
• Academic paper/technical report
• Where to start
Summary
• Academic paper/technical report
• Where to start
• Layout:
– Executive Summary/Abstract
– Introduction
– Aim
– Body of report
– Recommendations
– Further work
– Concluding comments - Conclusions
– References/bibliography
– Appendices
– Title
Summary
• Academic paper/technical report • Presentation of
• Where to start data/comparison of data
• Layout:
– Executive Summary/Abstract
– Introduction
– Aim
– Body of report
– Recommendations
– Further work
– Concluding comments - Conclusions
– References/bibliography
– Appendices
– Title
Summary
• Academic paper/technical report • Presentation of
• Where to start data/comparison of data
• Layout: • Concluding comments
– Executive Summary/Abstract
– Introduction
– Aim
– Body of report
– Recommendations
– Further work
– Concluding comments - Conclusions
– References/bibliography
– Appendices
– Title
Summary
• Academic paper/technical report • Presentation of
• Where to start data/comparison of data
• Layout: • Concluding comments
– Executive Summary/Abstract • Appendix
– Introduction
– Aim
– Body of report
– Recommendations
– Further work
– Concluding comments - Conclusions
– References/bibliography
– Appendices
– Title
We won’t be covering
• Page layout
• Figure/table numbering approach
• Referencing techniques
• Grammar
• Spelling
• Use of apostrophes
• Symbols and abbreviations
IN APPENDIX!
Academic paper/Technical report
• Academic paper
– Output of academic work
– Usually quite short and focused

• Technical report
– Usually output from commercial work
– Often very lengthy

• Most of this presentation will focus on academic paper


Academic paper
• Conference paper

• Peer reviewed journal paper


Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!

• Peer reviewed journal paper


Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world

• Peer reviewed journal paper


Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world
– Not normally given much credit with respect to research ranking etc
• Peer reviewed journal paper
Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world
– Not normally given much credit with respect to research ranking etc
• Peer reviewed journal paper
– Generally accepted as being a good measure of research ranking
• Number of papers, and quality of journals (ranking)
Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world
– Not normally given much credit with respect to research ranking etc
• Peer reviewed journal paper
– Generally accepted as being a good measure of research ranking
• Number of papers, and quality of journals (ranking)
– Level will depend on the quality of the journal
Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world
– Not normally given much credit with respect to research ranking etc
• Peer reviewed journal paper
– Generally accepted as being a good measure of research ranking
• Number of papers, and quality of journals (ranking)
– Level will depend on the quality of the journal
– Consider “Least Publishable Unit (LPU)” – cynical!
Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world
– Not normally given much credit with respect to research ranking etc
• Peer reviewed journal paper
– Generally accepted as being a good measure of research ranking
• Number of papers, and quality of journals (ranking)
– Level will depend on the quality of the journal
– Consider “Least Publishable Unit (LPU)” – cynical!
• It may be possible to divide the work into a number of smaller papers
Academic paper
• Conference paper
– Useful for getting interim results published quickly
• Take care to avoid spoiling the chance of a journal paper later!
– Good way to meet with others in the field from around the world
– Not normally given much credit with respect to research ranking etc
• Peer reviewed journal paper
– Generally accepted as being a good measure of research ranking
• Number of papers, and quality of journals (ranking)
– Level will depend on the quality of the journal
– Consider “Least Publishable Unit (LPU)” – cynical!
• It may be possible to divide the work into a number of smaller papers
• Citations important
– Self citations often excluded!
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
– Title and abstract will be used to select the paper – so must be good
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
– Title and abstract will be used to select the paper – so must be good
– Abstract may “promise” results which don’t exist yet, but try to imply
that they do!
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
– Title and abstract will be used to select the paper – so must be good
– Abstract may “promise” results which don’t exist yet, but try to imply
that they do!
– Authors and author affiliations may also be used to select abstracts
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
– Title and abstract will be used to select the paper – so must be good
– Abstract may “promise” results which don’t exist yet, but try to imply
that they do!
– Authors and author affiliations may also be used to select abstracts
– Some conferences require “extended abstracts” with examples of
results – but this is not so common
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
– Title and abstract will be used to select the paper – so must be good
– Abstract may “promise” results which don’t exist yet, but try to imply
that they do!
– Authors and author affiliations may also be used to select abstracts
– Some conferences require “extended abstracts” with examples of
results – but this is not so common
– May not be a long time between being accepted and having to submit
the final paper
Academic paper
• Conference paper
– Often starts with a “call for papers” from the conference
– Potential authors are required to submit an “abstract”
– Must meet deadline and length/format etc
– Title and abstract will be used to select the paper – so must be good
– Abstract may “promise” results which don’t exist yet, but try to imply
that they do!
– Authors and author affiliations may also be used to select abstracts
– Some conferences require “extended abstracts” with examples of
results – but this is not so common
– May not be a long time between being accepted and having to submit
the final paper
– Paper may be reviewed, but review is likely to be a lot less thorough
than for a journal
Academic paper
• Peer reviewed journal paper
– Select journal carefully
• Consider SCOPUS ranking: https://www.scopus.com/sources
Academic paper
• Peer reviewed journal paper
– Select journal carefully
• Consider SCOPUS ranking: https://www.scopus.com/sources

Title Rating Comment


Marine Structures 6.7
Ocean Engineering 6,5
Journal of Ocean Engineering and Science 5.4 Open
International Journal of Naval Architecture and Ocean Engineering 5.1 Open
Journal of Marine Science and Technology 3.5
Journal of Ship Research 2.0
International Journal of Maritime Engineering 1.2
Academic paper
• Peer reviewed journal paper
– Select journal carefully
• Consider SCOPUS ranking: https://www.scopus.com/sources

Title Rating Comment


Marine Structures 6.7
Ocean Engineering 6,5
Journal of Ocean Engineering and Science 5.4 Open
International Journal of Naval Architecture and Ocean Engineering 5.1 Open
Journal of Marine Science and Technology 3.5
Journal of Ship Research 2.0
International Journal of Maritime Engineering 1.2

• The rating is influenced by the number of citations


• The higher the rating the more difficult it will be to get accepted
Academic paper
• Peer reviewed journal paper
– Select journal carefully
• Consider SCOPUS ranking: https://www.scopus.com/sources

Title Rating Comment


Marine Structures 6.7
Ocean Engineering 6,5
Journal of Ocean Engineering and Science 5.4 Open
International Journal of Naval Architecture and Ocean Engineering 5.1 Open
Journal of Marine Science and Technology 3.5
Journal of Ship Research 2.0
International Journal of Maritime Engineering 1.2

• The rating is influenced by the number of citations


• The higher the rating the more difficult it will be to get accepted
• There are a number of different ratings: impact factors; journal impact factor …
Academic paper
• Peer reviewed journal paper
– Select journal carefully
• Consider SCOPUS ranking: https://www.scopus.com/sources

Title Rating Comment


Marine Structures 6.7
Ocean Engineering 6,5
Journal of Ocean Engineering and Science 5.4 Open
International Journal of Naval Architecture and Ocean Engineering 5.1 Open
Journal of Marine Science and Technology 3.5
Journal of Ship Research 2.0
International Journal of Maritime Engineering 1.2

• The rating is influenced by the number of citations


• The higher the rating the more difficult it will be to get accepted
• There are a number of different ratings: impact factors; journal impact factor …
• Our field is somewhat specialized, so there are not so many high rated journals
Academic paper
• Peer reviewed journal paper
– Select journal carefully
• Consider SCOPUS ranking: https://www.scopus.com/sources

Title Rating Comment


Marine Structures 6.7
Ocean Engineering 6,5
Journal of Ocean Engineering and Science 5.4 Open
International Journal of Naval Architecture and Ocean Engineering 5.1 Open
Journal of Marine Science and Technology 3.5
Journal of Ship Research 2.0
International Journal of Maritime Engineering 1.2

• The rating is influenced by the number of citations


• The higher the rating the more difficult it will be to get accepted
• There are a number of different ratings: impact factors; journal impact factor …
• Our field is somewhat specialized, so there are not so many high rated journals
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
– Likely to receive review comments, and opportunity to take them into
account
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
– Likely to receive review comments, and opportunity to take them into
account
– Supposed to include sufficient information for reader to repeat the
work – but often not the case
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
– Likely to receive review comments, and opportunity to take them into
account
– Supposed to include sufficient information for reader to repeat the
work – but often not the case
– Can take a long time to be published
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
– Likely to receive review comments, and opportunity to take them into
account
– Supposed to include sufficient information for reader to repeat the
work – but often not the case
– Can take a long time to be published
– “Conventional” publication or “open access”
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
– Likely to receive review comments, and opportunity to take them into
account
– Supposed to include sufficient information for reader to repeat the
work – but often not the case
– Can take a long time to be published
– “Conventional” publication or “open access”
– Material should not have been published already
Academic paper
• Peer reviewed journal paper
– Select journal carefully
– Submit draft in correct format to make it easier for editors
– This will be reviewed by experts in the field
• make sure to reference work by anybody who may be a reviewer!
– Likely to receive review comments, and opportunity to take them into
account
– Supposed to include sufficient information for reader to repeat the
work – but often not the case
– Can take a long time to be published
– “Conventional” publication or “open access”
– Material should not have been published already
• thus, if you want to get a conference paper as well out of this make sure that the
journal paper is first! Don’t waste the opportunity for a journal paper by publishing
in a conference first.
Where to start?
Where to start?

• Don’t feel that you need to start at the beginning and write
chapter 1, then chapter 2, …
Where to start?

• Don’t feel that you need to start at the beginning and write
chapter 1, then chapter 2, …

• It is often easiest to start with one of the technical chapters


first, which is okay, provided you have the overall plan sorted
out first.
Where to start?
• Title
– Perhaps useful to have “working title”
Where to start?
• Title
– Perhaps useful to have “working title”
– Good idea not to fix actual title until finished the report
Where to start?
• Title
– Perhaps useful to have “working title”
– Good idea not to fix actual title until finished the report
– For a consulting report this may be prescribed by the client?
Where to start?
• Title
– Perhaps useful to have “working title”
– Good idea not to fix actual title until finished the report
– For a consulting report this may be prescribed by the client?
– Title may have been accepted by conference?
• But it may be possible to slightly change this, if necessary
Where to start?
• Title
– Perhaps useful to have “working title”
– Good idea not to fix actual title until finished the report
– For a consulting report this may be prescribed by the client?
– Title may have been accepted by conference?
• But it may be possible to slightly change this, if necessary
– For a conference it must be relevant to the theme of the conference!
Where to start?
• Title
– Perhaps useful to have “working title”
– Good idea not to fix actual title until finished the report
– For a consulting report this may be prescribed by the client?
– Title may have been accepted by conference?
• But it may be possible to slightly change this, if necessary
– For a conference it must be relevant to the theme of the conference!
• Remember that you’re trying to “sell” this to the conference organisers
Where to start?
• Title
• Summary/Abstract
– This is often a starting point for a conference paper
Where to start?
• Title
• Summary/Abstract
– This is often a starting point for a conference paper
– The summary or abstract is used to “advertise” the potential paper to
get the conference organisers to agree to accept it
Where to start?
• Title
• Summary/Abstract
– This is often a starting point for a conference paper
– The summary or abstract is used to “advertise” the potential paper to
get the conference organisers to agree to accept it
• May even be written before the work is done!
Where to start?
• Title
• Summary/Abstract
– This is often a starting point for a conference paper
– The summary or abstract is used to “advertise” the potential paper to
get the conference organisers to agree to accept it
• May even be written before the work is done!
– Not the usual starting point for a technical report/peer reviewed
journal paper
Where to start?
• Title
• Summary/Abstract
– This is often a starting point for a conference paper
– The summary or abstract is used to “advertise” the potential paper to
get the conference organisers to agree to accept it
• May even be written before the work is done!
– Not the usual starting point for a technical report/peer reviewed
journal paper
– Regardless, should be reviewed again carefully before submitting
Where to start?
• Title
• Summary/Abstract
• Aim
– The aim, or the “exam question” is often the starting point when
writing a consultancy report
Where to start?
• Title
• Summary/Abstract
• Aim
– The aim, or the “exam question” is often the starting point when
writing a consultancy report
– During a consultancy project this should always be kept in mind
Where to start?
• Title
• Summary/Abstract
• Aim
– The aim, or the “exam question” is often the starting point when
writing a consultancy report
– During a consultancy project this should always be kept in mind
– Thus, it is sometimes good to start by writing it down when preparing
the report
Where to start?
• Title
• Summary/Abstract
• Aim
– The aim, or the “exam question” is often the starting point when
writing a consultancy report
– During a consultancy project this should always be kept in mind
– Thus, it is sometimes good to start by writing it down when preparing
the report
– Not necessarily applicable for an academic research project which
might be open ended, and not be sticking to a predetermined exam
question
Where to start?
• Title
• Summary/Abstract
• Aim
– The aim, or the “exam question” is often the starting point when
writing a consultancy report
– During a consultancy project this should always be kept in mind
– Thus, it is sometimes good to start by writing it down when preparing
the report
– Not necessarily applicable for an academic research project which
might be open ended, and not be sticking to a predetermined exam
question
• but, even so there needs to be a “point” to the paper!
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
– Can be a useful way to focus the mind when putting together a report
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
– Can be a useful way to focus the mind when putting together a report
– However, may be best on a separate piece of paper, and then check that
this has been covered at the end
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
– Can be a useful way to focus the mind when putting together a report
– However, may be best on a separate piece of paper, and then check that
this has been covered at the end
– Conclusions should be very focused – just that: Conclusions not waffle!
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
– Can be a useful way to focus the mind when putting together a report
– However, may be best on a separate piece of paper, and then check that
this has been covered at the end
– Conclusions should be very focused – just that: Conclusions not waffle!
– “Concluding remarks” may be more appropriate than “conclusions” if
there are no concrete conclusions and/or if you want to include a
summary of what has been done in this section
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
• Contents page
– My favourite way of starting
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
• Contents page
– My favourite way of starting
– Good to get the chapter headings down, then have dot points under
each covering what is going to go in them.
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
• Contents page
– My favourite way of starting
– Good to get the chapter headings down, then have dot points under
each covering what is going to go in them.
– Useful when there are multiple authors, and/or for a very long report
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
• Contents page
– My favourite way of starting
– Good to get the chapter headings down, then have dot points under
each covering what is going to go in them.
– Useful when there are multiple authors, and/or for a very long report
– Be prepared to modify contents page as you go along (with agreement!)
Where to start?
• Title
• Summary/Abstract
• Aim
• Conclusions/recommendations
• Contents page
– My favourite way of starting
– Good to get the chapter headings down, then have dot points under
each covering what is going to go in them.
– Useful when there are multiple authors, and/or for a very long report
– Be prepared to modify contents page as you go along (with agreement!)
– Good to get nomenclature etc agreed at this point – helps with
consistency
Layout
• Executive summary/Abstract
This is only an example,
• Introduction does not have to be
• Aim (exam question … ) followed rigidly!

}
• Relevant chapters
Body of the report
• Relevant chapters
• Recommendations
• Future work
• Concluding remarks
• References
• Acknowledgements
• Appendices etc
Layout
• Executive summary/Abstract
• Introduction
• Aim (exam question … )
• Relevant chapters Do not assume that the
• Relevant chapters reader will start at the
• Recommendations beginning and read this
through to the end, like a
• Future work
novel.
• Concluding remarks
• References
• Acknowledgements
• Appendices etc
Abstract/Executive summary
• The abstract for a journal paper is quite different to an
executive summary for a technical report
Abstract/Executive summary
• Abstract
– Often an abstract is an “advert” for a technical paper, or a very short
summary
Abstract/Executive summary
• Abstract
– Often an abstract is an “advert” for a technical paper, or a very short
summary
– For a conference a proposed abstract may have been written before
the work is even completed!
Abstract/Executive summary
• Abstract
– Often an abstract is an “advert” for a technical paper, or a very short
summary
– For a conference a proposed abstract may have been written before
the work is even completed!
– Will be short (may be constrained by conference organisers)
Abstract/Executive summary
• Abstract
– Often an abstract is an “advert” for a technical paper, or a very short
summary
– For a conference a proposed abstract may have been written before
the work is even completed!
– Will be short (may be constrained by conference organisers)

• Executive Summary should tell whole story to busy person.


– Introduction
– Brief summary of main part of the report
– Summary of conclusions/recommendations
Abstract/Executive summary
• Abstract
– Often an abstract is an “advert” for a technical paper, or a very short
summary
– For a conference a proposed abstract may have been written before
the work is even completed!
– Will be short (may be constrained by conference organisers)

• Executive Summary should tell whole story to busy person.


– Introduction
– Brief summary of main part of the report
– Summary of conclusions/recommendations
– Length will depend on length of report
• For 20 – 30 page report it could be one to one and a half pages.
Introduction
• A general chapter setting the scene.

• Could also include “background” either internally as a sub-


section, or as a separate chapter.

• Could include the “aim”.


Aim
• For commercial projects this should be as near as possible to
the contract/brief.

• Good to check that the work actually meets the desired aim!

• For academic work this may have changed after the project
started – but for commercial work this should not have
happened without the express permission of the client!
Body of report
• There will be a number of chapters in the body of the report.
• Important to spend a bit of time working out how to break the
report down into different chapters, and what order to have them
in.
Body of report
• There will be a number of chapters in the body of the report.
• Important to spend a bit of time working out how to break the
report down into different chapters, and what order to have them
in.
• Often: theory first, followed by validation/verification, then
results.
Body of report
• There will be a number of chapters in the body of the report.
• Important to spend a bit of time working out how to break the
report down into different chapters, and what order to have them
in.
• Often: theory first, followed by validation/verification, then
results.
• All statements must be fully justified:
– Reference to results of this work (not just anecdotal evidence)
– Reference to others (important to reference any potential peer reviewers)!
– Refer to appendices if necessary
Body of report
• Possible layout:

1. A chapter setting the scene:


1. Could include a literature review
2. Should assume the reader is not specialist in the topic
2. Set up/preparation etc.
3. Results.
4. Analysis of results.
5. Discussion of analysis.
Body of report
• Possible layout:

1. A chapter setting the scene:


1. Could include a literature review
2. Should assume the reader is not specialist in the topic
2.
3.
Set up/preparation etc
Results } Could be combined?

4. Analysis of results
5. Discussion of analysis } Could be combined?
Body of report
• Possible layout:

1. A chapter setting the scene:


1. Could include a literature review
2. Should assume the reader is not specialist in the topic
2. Set up/preparation etc

}
3. Results
4. Analysis of results Could be combined?

5. Discussion of analysis
Recommendations
• Not always necessary.

• Should not have any recommendations that are not already


discussed/justified in the body of the report.

• Ideally should refer to where these are discussed in the body


of the report.
Further work
• Not always necessary.

• Is important in academic/thesis etc.

• Often used by consultants as a “hook” to get a further


project/funding in this field (perhaps more subtly than
“further work” ).
Concluding comments
Conclusions

• Must be nothing new here – should all have been covered in


the body of the text.
Concluding comments
Conclusions

• Must be nothing new here – should all have been covered in


the body of the text.

• Conclusions are firm conclusions, not just a convenient


“ending”. Often dot points for emphasis.
Concluding comments
Conclusions

• Must be nothing new here – should all have been covered in


the body of the text.

• Conclusions are firm conclusions, not just a convenient


“ending”. Often dot points for emphasis.

• Concluding comments could be more general, perhaps


making a nice “ending” to the report.
References/bibliography
• What is the difference between References and Bibliography?
References/bibliography
• References are specifically referred to in the text.

• Bibliography covers material which is not specifically referred


to.

• Must be consistent with the way in which these are presented


– if being submitted to a journal use the style specified by that journal

• Need to be complete – sufficient for a library to obtain the


work.
Appendices
• Use if there is material which would not sit well in the body of
the text.

• Particularly large quantity of figures/graphs/diagrams/photos


etc.

• Can also be used for reproduction of external material, but do


acknowledge and check copyright.

• Less common in academic paper than technical report


Title
• Title may be prescribed.
Title
• Title may be prescribed.
• May want to have a nice ‘catchy’ title.
• Or may prefer a fairly dry title.
Title
• Title may be prescribed.
• May want to have a nice ‘catchy’ title.
• Or may prefer a fairly dry title.
• This is not a novel, so don’t get too fancy with it, but the title
may encourage people to read the report or paper.
Title
• Title may be prescribed.
• May want to have a nice ‘catchy’ title.
• Or may prefer a fairly dry title.
• This is not a novel, so don’t get too fancy with it, but the title
may encourage people to read the report or paper.
• Think who the audience is going to be. Would they be excited
by a fancy title, or not?
Title
• Title may be prescribed.
• May want to have a nice ‘catchy’ title.
• Or may prefer a fairly dry title.
• This is not a novel, so don’t get too fancy with it, but the title
may encourage people to read the report or paper.
• Think who the audience is going to be. Would they be excited
by a fancy title, or not?
• For a conference paper the title may either excite the
organisers to consider accepting the paper, or not!
Title
• Title may be prescribed.
• May want to have a nice ‘catchy’ title.
• Or may prefer a fairly dry title.
• This is not a novel, so don’t get too fancy with it, but the title
may encourage people to read the report or paper.
• Think who the audience is going to be. Would they be excited
by a fancy title, or not?
• For a conference paper the title may either excite the
organisers to consider accepting the paper, or not!
• For a journal paper the title may influence who the editor
chooses to be the peer reviewers.
Presenting data
• Before discussing every figure/graph/table make sure that
there is an adequate “introduction” to it.
Presenting data
• Before discussing every figure/graph/table make sure that
there is an adequate “introduction” to it.
• Don’t say: something is plotted “against” something!
• The correct terminology is: something is plotted “as a
function” of something:
“In figure xx drag is plotted as a function of speed ….”
Presenting data
• Before discussing every figure/graph/table make sure that
there is an adequate “introduction” to it.
• Don’t say: something is plotted “against” something!
• The correct terminology is: something is plotted “as a
function” of something:
“In figure xx drag is plotted as a function of speed ….”
• Take great care with expressions like:
“lift increases with increasing speed”
Presenting data
• Before discussing every figure/graph/table make sure that
there is an adequate “introduction” to it.
• Don’t say: something is plotted “against” something!
• The correct terminology is: something is plotted “as a
function” of something:
“In figure xx drag is plotted as a function of speed ….”
• Take great care with expressions like:
“lift increases with increasing speed”

Is it the “increasing speed” which does this, or higher speeds


which do it?
Presenting data

• All experimental measurements must have uncertainty bars.


Presenting data

• All experimental measurements must have uncertainty bars.


• Convention is to use points (with uncertainty bars) for
experimental results, and lines for “theory”.
Presenting data

• All experimental measurements must have uncertainty bars.


• Convention is to use points (with uncertainty bars) for
experimental results, and lines for “theory”.
• Issue with CFD results, which are “points”.
Presenting data

• All experimental measurements must have uncertainty bars.


• Convention is to use points (with uncertainty bars) for
experimental results, and lines for “theory”.
• Issue with CFD results, which are “points”.
• Recommend taking great care to ensure figures can be
understood in B&W, if possible.
• Line styles/symbols, should be different even in B&W.
Presenting data
• Take great care with scales:
– Ideally scales should be the same for different figures where the same
quantities are compared
– This may not always be possible, but try not to make them all different
– Be prepared to use “false zeros” if appropriate
Presenting data
• Take great care with scales:
– Ideally scales should be the same for different figures where the same
quantities are compared
– This may not always be possible, but try not to make them all different
– Be prepared to use “false zeros” if appropriate

• Try to use the same line types/point types for the same
quantities and configurations on different figures.
Presenting data
• Take great care with scales:
– Ideally scales should be the same for different figures where the same
quantities are compared
– This may not always be possible, but try not to make them all different
– Be prepared to use “false zeros” if appropriate

• Try to use the same line types/point types for the same
quantities and configurations on different figures.
• Consistency is really important to the reader.
Presenting data
• Take great care with scales:
– Ideally scales should be the same for different figures where the same
quantities are compared
– This may not always be possible, but try not to make them all different
– Be prepared to use “false zeros” if appropriate

• Try to use the same line types/point types for the same
quantities and configurations on different figures.
• Consistency is really important to the reader.
• Beware putting too much data on one figure.
Presenting data
• Take great care with scales:
– Ideally scales should be the same for different figures where the same
quantities are compared
– This may not always be possible, but try not to make them all different
– Be prepared to use “false zeros” if appropriate

• Try to use the same line types/point types for the same
quantities and configurations on different figures.
• Consistency is really important to the reader.
• Beware putting too much data on one figure.
• Give a lot of consideration to non-dimensionalisation.
Presenting data

• Drag as a function of speed

• Agreement looks quite good

• WHAT IS WRONG WITH THIS PRESENTATION?


Presenting data

• Drag as a function of speed

• Agreement looks quite good

• Should be non-dimensional
80
Presenting data
75

70
CT

65

60

55 Experimental Measurements

Theoretical Prediction
50
0 0.2 0.4 0.6 0.8 1

Froude Number

• Non-dimensionalise drag using velocity squared …


• Difference between measurements and theory more obvious now.
• Note false zero.
Comparing data

• Above is dimensional – how should we non-dimensionalise this?


Comparing data
• Could non-dimensionalise as follows:

• Speed:
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿

• Drag:
𝑅
Resistance Coefficient = 𝐶𝑇 =
1 2
2 𝜌𝑉 𝑆
Comparing data
90

80

70
CT

60

50

Experimental Measurements (Vessel A)


40 Experimental Measurements (Vessel B)
A and B equal (Fr = 0.75)
30
0 0.2 0.4 0.6 0.8 1

Froude Number

Vessel B has a greater value of T above a Fr of about 0.75 than vessel A

But this is misleading, because the non-dimensionalisation was different!


Comparing data
• Speed (uses L):
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
• Drag (uses S):
𝑅
Resistance Coefficient = 𝐶𝑇 =
1 2
𝜌𝑉 𝑆
2
Comparing data
• Speed (uses L):
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
• Drag (uses S): Inconsistent
𝑅
Resistance Coefficient = 𝐶𝑇 =
1 2
2 𝜌𝑉 𝑆
Comparing data
• Speed (uses L):
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
• Drag (uses S):
𝑅
Resistance Coefficient = 𝐶𝑇 =
1 2
𝜌𝑉 𝑆
2

Vessel A Vessel B
Length 10 10
Wetted area 30 35
Comparing data
• Speed (uses L):
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
• Drag (uses S):
𝑅
Resistance Coefficient = 𝐶𝑇 =
1 2
𝜌𝑉 𝑆
2

Vessel A Vessel B
Length 10 10
Wetted area 30 35

• So, what happens if both are non-dimensionalised using L?


Comparing data
• Speed (uses L):
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
• Drag (uses L): Consistent
𝑅
Resistance Coefficient = 𝐶𝐷 =
1 2 2
𝜌𝑉 𝐿
2

Vessel A Vessel B
Length 10 10
Wetted area 30 35

• So, what happens if both are non-dimensionalised using L?


Comparing data

Vessel B has a greater value of above a Fr of about 0.5 than vessel A.


This is consistent, because both are non-dimensionalised by the same value
Comparing data

Vessel B has a greater value of above a Fr of about 0.5 than vessel A.


This is consistent, because both are non-dimensionalised by the same value
From before:
Vessel B has a greater value of T above a Fr of about 0.75 than vessel A
Comparing data

Vessel B has a greater value of above a Fr of about 0.5 than vessel A.


This is consistent, because both are non-dimensionalised by the same value
In addition, as both vessels have the same length, this will mean the same
speed – but not always. Take care with this too!
Comparing data
In addition, as both vessels have the same length, this will mean
the same speed – but not always. Take care with this too!
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
Comparing data
In addition, as both vessels have the same length, this will mean
the same speed – but not always. Take care with this too!
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿

If they have different lengths then at the same Froude Number


they will be travelling at different speeds.
Comparing data
In addition, as both vessels have the same length, this will mean
the same speed – but not always. Take care with this too!
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿

If they have different lengths then at the same Froude Number


they will be travelling at different speeds.
May be useful to non-dimensionalise speed by a different
parameter, such as volume. Depends on what the comparison
should be.
Comparing data
In addition, as both vessels have the same length, this will mean
the same speed – but not always. Take care with this too!
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿

If they have different lengths then at the same Froude Number


they will be travelling at different speeds.
May be useful to non-dimensionalise speed by a different
parameter, such as volume. Depends on what the comparison
should be.
Give thought to this for any particular figure.
Consistency
The following is a report of a football match:

“Yesterday Arsenal played Manchester United at Old Trafford.


The home team scored a goal after ten minutes, but the
bombers equalized 15 minutes later, scoring the winning goal
five minutes into the second half.”

What is wrong with the above phrase?


Consistency
The following is a report of a football match:

“Yesterday Arsenal played Manchester United at Old Trafford.


The home team scored a goal after ten minutes, but the
bombers equalized 15 minutes later, scoring the winning goal
five minutes into the second half.”

When was the game played?


Consistency
The following is a report of a football match:

“Yesterday Arsenal played Manchester United at Old Trafford.


The home team scored a goal after ten minutes, but the
bombers equalized 15 minutes later, scoring the winning goal
five minutes into the second half.”

When was the game played?

Who won?
Consistency
The following is a report of a football match:

“Yesterday Arsenal played Manchester United at Old Trafford.


The home team scored a goal after ten minutes, but the
bombers equalized 15 minutes later, scoring the winning goal
five minutes into the second half.”
A better phrase, for a technical paper, would be:
“On Saturday the 5th of November 2020 Arsenal (A) played a
football match against Manchester United (MU) at Old Trafford.
MU scored a goal after ten minutes, but A equalized 15 minutes
later, scoring the winning goal five minutes into the second half.”
Concluding comments
• The difference between somebody just “playing” with
different ideas and somebody recognized as a serious
researcher is in his/her publications.
Concluding comments
• The difference between somebody just “playing” with
different ideas and somebody recognized as a serious
researcher is in his/her publications.
• Conference papers are useful.
Concluding comments
• The difference between somebody just “playing” with
different ideas and somebody recognized as a serious
researcher is in his/her publications.
• Conference papers are useful.
• Top quality journal papers are what an academic is measured
by.
Concluding comments
• The difference between somebody just “playing” with
different ideas and somebody recognized as a serious
researcher is in his/her publications.
• Conference papers are useful.
• Top quality journal papers are what an academic is measured
by.
• Important to academic progression to publish a large number
of GOOD papers in quality journals.
Concluding comments
• The difference between somebody just “playing” with
different ideas and somebody recognized as a serious
researcher is in his/her publications.
• Conference papers are useful.
• Top quality journal papers are what an academic is measured
by.
• Important to academic progression to publish a large number
of GOOD papers in quality journals.
• Citations important!
We didn’t cover
• Page layout
– Different publishers have their own requirements
– Ideal reading width is less than the width of an A4 piece of paper
• ≈ 12 words per line?
• Two columns
• Increase margin, particularly on left hand side and include figures/call-outs
– Justified or ragged right edge?
We didn’t cover
• Page layout
• Figure/table numbering approach
– Again, most publishers have their own standards
– Handy to number figures and tables consecutively within each section
• 2.1, 2.2, …. Rather than 1, 2, 3 throughout the whole report
• Easier to renumber if an additional figure /table is added later
• Easier for the reader to find a figure/table which is referred to
– Must be consistent within the report
• (Figure, figure, Fig, fig., etc)
We didn’t cover
• Page layout
• Figure/table numbering approach
• Referencing techniques
– Most publishers will have their own standard
– Basically two approaches to references:
• Consecutively numbering throughout the report in the order that they are used
• Referring to reference by author and date (I prefer)
– Ie: Renilson (2014), or Renilson et al (2013)

– But can also use footnotes


– Must acknowledge/reference any external information
We didn’t cover
• Page layout
• Figure/table numbering approach
• Referencing techniques
• Grammar
– Is important, and must be correct!
– Use third person (“the thing was measured” not “I measured the thing”)
– Take particular care with tenses – stick to the same tense
– Be consistent with terms – don’t refer to the same thing in different
ways throughout the report
– Be consistent with capitalisation
We didn’t cover
• Page layout
• Figure/table numbering approach
• Referencing techniques
• Grammar
• Spelling
– Important: use spell checker
– Beware of English words with similar/same pronunciation but slightly
different spellings to mean completely different things! For example:
• Affect – Effect (verb – noun)
• Principal – Principle (adjective – noun)
• Complement – Compliment (matching/balancing – praise)
– Use “synonyms” in WORD if in doubt (or a dictionary!)
– Decide on which type of English to use, and stick to it (UK, US, Australian
…..)
We didn’t cover
• Page layout
• Figure/table numbering approach
• Referencing techniques
• Grammar
• Spelling
• Use of apostrophes
– Two uses:
• For missing letters (hasn’t, doesn’t, won’t, …..)
• For ownership (Martin’s, children’s, …..) but with plural, apostrophe comes after “s”
(engineers’, referring to something belonging to more than one engineer)
• Beware of it’s/its! In this case it’s is short for “it is” not ownership. “its” is used for
ownership (no apostrophe). Common mistake!
We didn’t cover
• Page layout
• Figure/table numbering approach
• Referencing techniques
• Grammar
• Spelling
• Use of apostrophes
• Symbols and abbreviations
– Make use of a notation/nomenclature/abbreviations section
– Always spell out abbreviations first time that they are used
– Don’t assume that the reader will know all the jargon/abbreviations
– When using symbols make sure that they are consistent (italics,
capitals, …..)
We didn’t cover
• Page layout
• Figure/table numbering approach
• Referencing techniques
• Grammar
• Spelling
• Use of apostrophes
• Symbols and abbreviations
• Consistency throughout document
Layout
• Executive summary The busy person will only read this
• Introduction
• Aim (exam question … )
• Relevant chapters
• Relevant chapters
• Recommendations
• Future work
• Concluding remarks
• References
• Acknowledgements
• Appendices etc
Layout
• Executive summary
• Introduction Somebody who
• Aim (exam question … ) has a bit more
• Relevant chapters time may read
• Relevant chapters these
• Recommendations
• Future work
• Concluding remarks
• References
• Acknowledgements
• Appendices etc
Layout
• Executive summary
• Introduction
• Aim (exam question … )
• Relevant chapters
• Relevant chapters
• Recommendations Only somebody who
• Future work is very interested will
• Concluding remarks read these
• References
• Acknowledgements
• Appendices etc
Executive summary
• Writing a good executive summary is a real art.
– Make sure that all the main points are covered (even if only briefly)
– May need to skip some of the justification for some statements –
reader can always refer to the body of the report if he has to
– If long, can have subheadings
Executive summary
• Writing a good executive summary is a real art.
– Make sure that all the main points are covered (even if only briefly)
– May need to skip some of the justification for some statements –
reader can always refer to the body of the report if he has to
– If long, can have subheadings

• It is very important as it can make or break the interest that a


senior person (who may be funding the work) will have in it .
Executive summary
• Writing a good executive summary is a real art.
– Make sure that all the main points are covered (even if only briefly)
– May need to skip some of the justification for some statements –
reader can always refer to the body of the report if he has to
– If long, can have subheadings

• It is very important as it can make or break the interest that a


senior person (who may be funding the work) will have in it .

• Often this is written in a rush at the end. Take time to do it


properly!
Timeline
• Plan the timeline for the report carefully :
– A rushed report looks bad, and reflects badly on you and your organisation

• Finish the work in plenty of time to write the report :


– Work backwards from the due date of the report
– Allow for the unexpected
– Allow for review

• Allow time for review:


– By yourself
– Independent reviewer

• Special care is required if more than one author!

You might also like