ENS 2159 6139 - 2020 - 2 - Structuring Your Report

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

Edith Cowan University

Centre for Learning and Teaching

Structuring your report


ENS 6139
A1 Report
Edith Cowan University
Centre for Learning and Teaching

School of Engineering
Learning Support
Senior Learning Adviser: Shalini Watson
Email: [email protected]
Edith Cowan University 3
Centre for Learning and Teaching

In this session, we will :

• examine the key features of technical report: Why


write one? What it is? Who is your audience?
• examine the elements of a formal report
• unpack the marking criteria for the A1 draft
Edith Cowan University 4
Centre for Learning and Teaching

Why engineers need strong technical


communication skills
• Engineers are responsible for solving problems
• However, they do not usually implement their solutions
• So, an engineer’s solution must be communicated to decision
makers about which solution to implement and by whom
• As an engineer, you will likely work in a large organisation
• As one moves up in the organisation, there will be less time to
read reports, as well as the understanding of technical details
• Thus, engineers need to communicate effectively

• On average, how much of your time as an Engineer will be


spent in communication?
Edith Cowan University 5
Centre for Learning and Teaching

Why write reports?


Why write? Examples
To convince • a government department about the outcome of an action
• a client to accept your solution
• The public of the benefits of your proposed project
To persuade • a council to adopt a course of action
• a client to choose one design over another
• an organisation to collaborate with you on a project
To inform • a government department with information they will base policy
on
• other engineers who will work from your plans (instructions)
• present the outcome of a project to stakeholders
https://www.monash.edu/rlo/assignment-samples/engineering/eng-writing-technical-reports
Edith Cowan University 6
Centre for Learning and Teaching

What are the key attributes of reports?


Reports are designed for: So they use:
selective reading sections with numbered
headings and
subheadings
quick and easy communication figures and tables
of information bullet-point lists

https://www.monash.edu/rlo/assignment-samples/engineering/eng-writing-technical-reports
Edith Cowan University 7
Centre for Learning and Teaching

Report structure
A report usually has a:
• Title page
• Executive Summary / abstract (not required for the draft report)
• Table of Contents
• Introduction
• Middle sections with numbered headings
• Conclusions
• References
• Appendices
Edith Cowan University
Centre for Learning and Teaching

Title page
The title page gives:
• the course name and number
• the department and university
• the title of the report
• the authors' names, and ID numbers
• the date of submission
• the version number (in industry)
Edith Cowan University 9
Centre for Learning and Teaching

Titles: What’s wrong, and how can you improve it?


Use prepositions (of) Use adjectives to
elaborate on detail

Weak titles Strong titles


Bridge analysis Analysis of a prestressed concrete bridge
Internet based An evaluation of Internet based Automated
ATIS Traveller Information Systems

Explain what this report does Expand the acronym


Edith Cowan University 10
Centre for Learning and Teaching

Introductions
• Answers the question “what is this report about?”
• The introduction has comprehensive coverage of all
of the following elements:

1. Background and Introduction to the topic content


2. Explanation of the focus of the report
addressing question requirements
3. Summary of the structure
of the report.
Edith Cowan University
Centre for Learning and Teaching
Topic motivation context

Introductions Broad
In recent times, desalination has been found to be a means of acquiring
potable water, which has been difficult in the more arid regions of Australia. topic
Under the current climatic conditions, the water stores of Australian cities Problem
have decreased significantly. As a result, droughts are likely to occur more
frequently, leading to regular water shortages.
One method of ensuring a supply of potable water is through solar Narrowing
desalination. Early solar desalination principles worked on the principle of the topic
distillation, while other modes have included membrane filtration, and
electrolysis, ion exchange, freezing and reverse osmosis (RO). problem
RO is capable of producing the purest output and will be the focus of this Specific
project. It is a natural process in which…………………………. topic and
theory
The aim of this project is to establish whether solar water desalination
using RO is feasible in the Australian urban environment, in particular in Aim and
Perth, Western Australia. scope
Thus, the purpose of this report is to provide an assessment of the Purpose
sustainability of the RO process based on availability, economic factors, and and
its impact on the environment. The current technologies for desalination are structure
investigated and the role of engineers in in developing these are further
investigated.
Edith Cowan University 12
Centre for Learning and Teaching

1.0
1.0Introduction
1.0
1.0 Introduction
Introduction
Introduction Introductions: Example
The
Thedepletion
The
The depletionof
depletion
depletion ofnon-renewable
of
of non-renewableenergy
non-renewable
non-renewable energysources
energy
energy sourcessuch
sources
sources suchas
such
such aspetroleum,
as
as petroleum,natural
petroleum,
petroleum, naturalgas
natural
natural gasand
gas
gas andcoal
and
and coalis
coal
coal isis
is
unavoidable.
unavoidable.While
unavoidable.
unavoidable. Whilethere
While
While thereis
there
there isisdebate
is debateas
debate
debate asto
as
as towhether
to
to whethersuch
whether
whether suchsources
such
such sourcesof
sources
sources ofenergy
of
of energywill
energy
energy willever
will
will everbe
ever
ever be
be
be
completely
completelyexhausted,
completely
completely exhausted,itit
exhausted,
exhausted, ititis
isiscertain
is certainthat
certain
certain thateventually,
that
that eventually,their
eventually,
eventually, theirextraction
their
their extractionwill
extraction
extraction willno
will
will nolonger
no
no longerbe
longer
longer be
be
be
economically
economicallyviable.
economically
economically viable.Further,
viable.
viable. Further,the
Further,
Further, theimpact
the
the impactof
impact
impact ofnon-renewables
of
of non-renewableson
non-renewables
non-renewables on
ononthe
theenvironment
the
the environmentwill
environment
environment willsoon
will
will soonbe
soon
soon be
be
be
regarded
regardedas
regarded
regarded asunsustainable.
as
as unsustainable.These
unsustainable.
unsustainable. Thesefactors
These
These factorswill
factors
factors willrequire
will
will requirethe
require
require theadoption
the
the adoptionof
adoption
adoption of
ofofalternative
alternativerenewable
alternative
alternative renewable
renewable
renewable
energy
energysources.
energy
energy sources.
sources.
sources.
This
Thisreport
This
This reportexamines
report
report examinesthe
examines
examines theimpact
the
the impactof
impact
impact ofthe
of
of theuse
the
the useof
use
use ofalternative
of
of alternativeenergy
alternative
alternative energysources
energy
energy sourceson
sources
sources onthe
on
on theenvironment,
the
the environment,
environment,
environment,
evaluates
evaluatestheir
evaluates
evaluates theirsustainability,
their
their sustainability,and
sustainability,
sustainability, anddiscusses
and
and discussesthe
discusses
discusses theengineer’s
the
the engineer’srole
engineer’s
engineer’s rolein
role
role inachieving
in
in achievingthis.
achieving
achieving this.
this.
this.
First,
First,the
First,
First, theimpact
the
the impactof
impact
impact ofsolar,
of
of solar,wind,
solar,
solar, wind,biomass,
wind,
wind, biomass,hydro
biomass,
biomass, hydropower
hydro
hydro powergeothermal
power
power geothermaland
geothermal
geothermal andbiofuels
and
and biofuelson
biofuels
biofuels onthe
on
on the
the
the
environment
environmentare
environment
environment areexamined.
are
are examined.Next
examined.
examined. Nextthe
Next
Next thesustainability
the
the sustainabilityof
sustainability
sustainability ofeach
of
of eachsource
each
each sourceis
source
source isisevaluated
is evaluatedbased
evaluated
evaluated basedon
based
based on
on
on
availability,
availability,economic
availability,
availability, economicfactors
economic
economic factorsand
factors
factors andenvironmental
and
and environmentalimpact.
environmental
environmental impact. Finally,
impact.
impact. Finally,the
Finally,
Finally, therole
the
the roleof
role
role ofengineers
of
of engineersin
engineers
engineers in
in
in
further
furtherdeveloping
further
further developingthese,
developing
developing these,and
these,
these, andother
and
and otheremerging
other
other emergingtechnologies
emerging
emerging technologiesis
technologies
technologies isisdiscussed.
is discussed.
discussed.
discussed.
Background Purpose Structure
Edith Cowan University 13
Centre for Learning and Teaching
Introductions: Example
1.0 Introduction
The depletion of non-renewable energy sources such as petroleum, natural gas and coal is unavoidable. While
there is debate as to whether such sources of energy will ever be completely exhausted, it is certain that
eventually, their extraction will no longer be economically viable. Further, the impact of non-renewables on the
environment will soon be regarded as unsustainable. These factors will require the adoption of alternative
renewable energy sources.
This report examines the impact of the use of alternative energy sources on the environment, evaluates their
sustainability, and discusses the engineer’s role in achieving this.
First, the impact of solar, wind, biomass, hydro power geothermal and biofuels on the environment are
examined. Next the sustainability of each source is evaluated based on availability, economic factors and
environmental impact. Finally, the role of engineers in further developing these, and other emerging
technologies is discussed.
Section 2.0 Examination of the Impact of Alternative Energy Sources on the Environment

Section 3.0 Evaluation of the Sustainability of Each Alternative Energy Source

Section 4.0 Role of Engineers in Further Developing Emerging Technologies


Edith Cowan University 14
Centre for Learning and Teaching

Headings: Consistency
How can you ensure that the following headings are grammatically
consistent?

Inconsistent headings Grammatical Consistent headings


form
The company structure Noun phrase The company structure
What is our management style? Question Management style

How we communicate Noun clause Communication methods

Working in teams Gerund phrase Teamwork


Edith Cowan University 15
Centre for Learning and Teaching

Headings: Be informative
How can you make the following headings more informative?

Uninformative headings More informative headings


Consumption patterns Changes in water consumption patterns

Survey results Turning movement survey results

Overview Overview of the organisation

Management Management style and method


Edith Cowan University 16
Centre for Learning and Teaching

Bulleted Points: Parallelism

Writing parallel bullet points, ensure that each item in the list has
the same structure. So, each item might:
• start with the same part of speech (e.g., noun, verb)
• use the same verb tense (e.g., present, past, future)
• use the same voice (e.g., active or passive)
• use the same sentence type (e.g., statement, question)
Edith Cowan University
Centre for Learning and Teaching

Bulleted Points: Parallelism


How would you convert these into a parallel form?

The following are the results of toxic chemicals being


released into the factory:

• Human life is lost • Loss of human life

• Toxic chemicals caused lung • Lung disease caused by


disease toxic chemicals
• Workers suffer • Psychological distress
psychological distress suffered by workers
Edith Cowan University 18
Centre for Learning and Teaching

Conclusions
The Conclusion (~1-2 paragraphs) relates directly back to the aims
of the investigation.
The Conclusions section provides an effective ending to your
report.
This section
• states whether you have achieved the aims of your investigation
• gives a brief summary of the key information in your report (and
sometimes includes recommendations)
• restates the major findings of your investigation.
Edith Cowan University
Centre for Learning and Teaching

Assessment 1 Task Instructions


This assessment represents 30% of your mark for this unit and
comprises:
• draft report (5%) - you will receive feedback

• final written report (20%) - including application of feedback


• reflective activity (5%) - The importance of Ethics for an emerging
engineer
Edith Cowan University
Centre for Learning and Teaching

Although you are required to write the draft report first, you must read
and understand the requirements of the final report in order to
structure the draft report properly
Providing more details in the draft report will enable the marker to give
you more meaningful feedback on your work
Edith Cowan University
Centre for Learning and Teaching
Assignment 1 question
• Review the Engineering Australia Code of Ethics
https://www.engineersaustralia.org.au/ethics
• Look at the case that has been assigned to you
What are the task words?
What are the content words?
What are the limiting words?

Hint: Look up the Starting Assignments Tip Sheet:


https://ecu.au.libguides.com/academic-skills-essentials/starting-assignments
Edith Cowan University
Centre for Learning and Teaching

Draft Report Requirements


For the requirements of the draft report, you will need to provide:
• a draft introduction (properly structured with full sentences)
• an outline of the rest of the report – include:
• headings
• sub-headings
• bullet points of content to be discussed under each
Edith Cowan University
Centre for Learning and Teaching

How might we structure this report? What


headings might you use?
1.0 Introduction
2.0
3.0
4.0
4.0 Conclusion
5.0 Recommendations
6.0 References
Assignment
Edith 1: Individual
Cowan University Draft Report Marking Rubric (5%)
Centre for Learning and Teaching
Assignment
Edith 1: Individual
Cowan University Final Report Marking Rubric (20%)
Centre for Learning and Teaching
Edith Cowan University
Centre for Learning and Teaching
Reflective activity 5%

To be completed after you have completed your report.


The activity will be completed in your gradCAP Workbook on
PebblePad on the Engineering Australia Professional Competency
3.1 page.

Reflect upon the application of ethics to your practice as an


emerging engineer. (approx. 300 words)
Edith Cowan University

Dropping in
Centre for Learning and Teaching
Centre for Learning and Teaching

Do you need assignment guidance?


• Drop in to an Assignment Drop in Session
• These run everyday, but Engineering focussed ones
are only on Mondays and Wednesdays
Edith Cowanfor
Centre University
Learning and Teaching
Centre for Learning and Teaching

Do you need extra support?


• Lock it in by making a 30 minute appointment
with your senior learning adviser, or learning
advisers (numeracy, academic skills)
• Appointments can be face to face or online
(phone or video conferencing)
• Book an appointment using the Ask Us
Webpage
https://askus2.ecu.edu.au/s/article/000001642
Edith Cowan University
Centre for Learning and Teaching

References
Monash University Engineering (2018) Guidelines for writing reports in engineering.
Retrieved from http://www.eng.monash.edu.au/current-
students/download/guidelines-writing-reports.pdf

You might also like