Professional Documents
Culture Documents
Presentation On Report Writing For ITS
Presentation On Report Writing For ITS
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
• 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, …
}
• 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)
• 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:
4. Analysis of results
5. Discussion of analysis } Could be combined?
Body of report
• Possible layout:
}
3. Results
4. Analysis of results Could be combined?
5. Discussion of analysis
Recommendations
• Not always necessary.
• 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
• 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
• Speed:
𝑉
Froude Number = 𝐹𝑟 =
ඥ𝑔𝐿
• Drag:
𝑅
Resistance Coefficient = 𝐶𝑇 =
1 2
2 𝜌𝑉 𝑆
Comparing data
90
80
70
CT
60
50
Froude Number
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
Vessel A Vessel B
Length 10 10
Wetted area 30 35
Who won?
Consistency
The following is a report of a football match: