Date post: | 04-Apr-2018 |
Category: |
Documents |
Upload: | m-m-hossain |
View: | 217 times |
Download: | 0 times |
of 29
7/31/2019 week4_Lecture 2 - 2012_13
1/29
7/31/2019 week4_Lecture 2 - 2012_13
2/29
School of Engineering
a brief background to the project, what is it about;
clear aim and objectives of the project, as proposed by you.
project deliverables (What the output / achievables of the project
will be)
identification of resources requirements, such as materials,
equipment and technician support
a list of any references you have identified to date which may
support your work
your project plan (A detailed Gantt chart) that identifies the work
required and timescales involved in completing your project on
time. (1500 word limit)
Project Proposal
What should you cover?
7/31/2019 week4_Lecture 2 - 2012_13
3/29
School of Engineering
Do you know, and can express in yourown words, what your project isabout
You know what the aim is and can
define the objectives
You have a reasonable idea of what isrequired (Resources, timescales,
effort etc) to complete the project
Project Proposal
7/31/2019 week4_Lecture 2 - 2012_13
4/29
School of Engineering
An outline or detail of any solution
WHAT IT IS NOT!"
At this stage you are considering what is to be done and how
you are going to go about it.
You should not propose or even suggest a solution
Project Proposal
7/31/2019 week4_Lecture 2 - 2012_13
5/29
School of Engineering
In producing the Specification you areensuring that you fully understand whatthe project is about and what needs tobe done.
Any discrepancies / misunderstandingswill come to light and be dealt with at
this early stage before you havecommitted much time to the work.
7/31/2019 week4_Lecture 2 - 2012_13
6/29
School of Engineering
I keep six honest serving-men
(They taught me all I knew);
Their names are What and Why and WhenAnd How and Where and Who.from "The Elephant's Child
by Rudyard Kipling
7/31/2019 week4_Lecture 2 - 2012_13
7/29
School of Engineering
WHAT is the purpose of the project ?(Think wider than just the Aim)
WHAT are the main aspects I need to research/design/ analyse _ _ _ _ ?
WHAT are the key things that will come out of thework? (Objectives)
WHAT am I going to do to complete it?What tasks, in what order, by when ?(Project plan, Gantt chart)
7/31/2019 week4_Lecture 2 - 2012_13
8/29
7/31/2019 week4_Lecture 2 - 2012_13
9/29
School of Engineering
When should you start writing yourreport?
7/31/2019 week4_Lecture 2 - 2012_13
10/29
School of Engineering
Typical Report Structure
Title Page Summary
(sometimes called abstract or executive summary) Acknowledgements
(if you have received help from anyone)
Table of contentsand possibly:- List of Tables
Table of Figures List of symbols, abbreviations, acronyms,
definitions Introduction
MAIN BODY OF REPORT Conclusions
Recommendations (if any) References and/or Bibliography
Appendices
7/31/2019 week4_Lecture 2 - 2012_13
11/29
School of Engineering
Report Structure
Title - Concise but complete as possible
Author - You
- Your Programme
Date - of submission (April 2012)
TITLE PAGE
7/31/2019 week4_Lecture 2 - 2012_13
12/29
7/31/2019 week4_Lecture 2 - 2012_13
13/29
School of Engineering
Report Writing
CONTENTS
Section Numbers:-Suggest using decimal numbering system.
Section Titles:-
Short but consistent with reader being able tofind information efficiently.
E.g. 3 Results3.1 Laboratory tests
3.1.1 Engine emissions3.1.2 Noise levels3.2 Field tests
7/31/2019 week4_Lecture 2 - 2012_13
14/29
School of Engineering
Report Writing
PAGE No.1. Introduction 1
2. Testing Programme 3
3. Results 10
4. Discussion 16
5. Conclusions 17
Appendices 18
Uninformative contents page
CONTENTS PAGE
7/31/2019 week4_Lecture 2 - 2012_13
15/29
School of Engineering
Report Writing
1. Introduction2. Testing Programme
3. Results of Laboratory Tests3.1 Engine emissions
3.2 Noise levels
4. Results of Field Tests4.1 Barometric pressures
4.2 Atmospheric pollution
4.2.1 Nitrates
4.3 Wind speeds
5. Discussion6. Conclusions
Appendices
Informative contentspage
CONTENTS PAGE
7/31/2019 week4_Lecture 2 - 2012_13
16/29
School of Engineering
Report Writing
1. Introduction
2. Testing Programme
3. Results of Laboratory Tests3.1 Engine emissions
3.2 Noise levels
4. Results of Field Tests
4.1 Barometric pressures
4.2 Atmospheric pollution
4.2.1 Nitrates
4.3 Wind speeds
5. Discussion
6. Conclusions
Appendices
1. Introduction
2. Testing Programme
3. Results of Laboratory Tests
3.1 Engine emissions
3.2 Noise levels
4. Results of Field Tests
4.1 Barometric pressures
4.2 Atmospheric pollution
4.2.1 Nitrates
4.3 Wind speeds
5. Discussion
6. Conclusions
Appendices
(Good practice) (Bad practice)CONTENTS PAGE
7/31/2019 week4_Lecture 2 - 2012_13
17/29
School of Engineering
1. Introduction
Objectives; Background; What the tests are for; What tests
are to be carried out; What you are expecting; etc
2. Testing ProgrammeList of tests; Description of each test; Details of equipment;
Detail of test conditions; Pictures and figures; etc
3. Results of Laboratory Tests3.1 Engine emissions
Details of results for each engine emission test; Tables ofresults; Graphs of results; Figures as appropriate; etc
3.2 Noise levels
Details of results for each noise level test; Tables of results;
Graphs of results; Figures as appropriate; etc
Use the Contents Page to start your reportwhich you can use as your Task List
Note what you are going to include in each section, in red
Example:-
7/31/2019 week4_Lecture 2 - 2012_13
18/29
School of Engineering
Report Writing
May also include such information as:-
Background, context and significance Historical information Why the work was done Scope and Limitations Treatment of subject Outline of work done What results are expected
INTRODUCTION
Must clearly set out aims and objectives for thework or project covered by the report.
7/31/2019 week4_Lecture 2 - 2012_13
19/29
School of Engineering
Report Writing
CONCLUSIONS
No New information should be introduced
Summarise what has been concluded from thework done. (As drawn out in the discussion)
Ensure that you cover all aspects of the workoutlined in the introduction.(Consider Introduction and Conclusions as bookends)
Refer back to sections that support theconclusions
7/31/2019 week4_Lecture 2 - 2012_13
20/29
School of Engineering
Report Writing
Main Body will consist of several chapters.
Examples:- Background, context and significance
Historical information, details of previouswork, literature survey Why the work is needed Work done, experimental methods Results Discussion of results (See next slide)
MAIN BODY
7/31/2019 week4_Lecture 2 - 2012_13
21/29
School of Engineering
Report Writing
Must deal with:- What is implied by the data Inferences
o Talk about the results, dont just repeat them
o Trends and changeso Comparisons and contrastso Differenceso Causes and effectso Implications for the future
o Draw conclusions
DISCUSSION
7/31/2019 week4_Lecture 2 - 2012_13
22/29
School of Engineering
Report Writing
REFERENCES
Are works specifically referred to in the text of thereport
You must list ALL your references
Always quote a reference if you include in your report
any information from another source Use of references allow you to quote, legitimately, from
other peoples work, without laying yourself open toaccusations of plagarism.
Avoid general statements such as Research has shownthat or it has previously been established.
7/31/2019 week4_Lecture 2 - 2012_13
23/29
7/31/2019 week4_Lecture 2 - 2012_13
24/29
School of Engineering
Report Writing
CITING REFERENCES
Name and Year (Harvard) System
Publication identified by names of authorsfollowed by year of publication
Examples:- Brown (1999) conducted experiments on
Brown and Smith (2000) established that
Brown et al (2001) concluded that
Many previous researchers have studied theproperties of the material (Brown, 1997; Smith,1998; Jones 2002)
7/31/2019 week4_Lecture 2 - 2012_13
25/29
School of Engineering
Report Writing
SummaryOrder of Writing!
Contents rough draft with notes Main body References and/or Bibliography Introduction and Conclusions
Recommendations Final copy of contents page including page
numbers List of figures and Tables
Summary /Abstract Title page
7/31/2019 week4_Lecture 2 - 2012_13
26/29
School of Engineering
Report Writing
Lastly - APPENDICES
Appendices, like our own appendix, we can livewithout.
Appendices are used to provide informationwhich you think the reader may like to see but is
not essential to the report. It is backgroundinformation.
Any information which is essential to the reportshould be in to body of the report.
7/31/2019 week4_Lecture 2 - 2012_13
27/29
School of Engineering
AmbiguityThe processor interfaced directly with the 64015RAM chip. It runs at 6 MHz.
Clear-The processor interfaced directly with the 64015RAM chip. The 64015 runs at 6 MHz.
VaguenessDesign of the gearbox is several weeks behindschedule.
Clear-Design of the gearbox is 6 weeks behind schedule.
Things to avoid in your report
7/31/2019 week4_Lecture 2 - 2012_13
28/29
School of Engineering
Superfluous qualification of words -absolutely perfect - perfect.in actual fact - in factdefinitely correct - correct
Tautology postponed to a later date - postponed.each individual person - each personequally as good - equally good or as good
Things to avoid in your report
7/31/2019 week4_Lecture 2 - 2012_13
29/29
School of Engineering
END