You are on page 1of 24

University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

A GUIDE TO REPORT WRITING IN ENGINEERING

J. O. Aweda and O. A. Lasode


Mechanical Engineering Department,
University of Ilorin, Ilorin, Nigeria
1.0 INTRODUCTION

Report writing is one of the primary professional responsibilities of the practicing

engineer. The presentation of final report of any project is not just a formality but also a

primary product of the effort of the reporter's professional abilities. Report is often the

basis for the evaluation of the work done by the engineer. Report also serves a secondary

function of giving information to those in need of such information. The format required of

a report depends on the type of report being presented. Oni [1] in his work presented an

overview of how agricultural engineering research project report should be presented.

There are different types of engineering reports. These include project report, commission

project report etc. Whichever type of report being presented, it must speak on its own.

Report should be subjected to review by a number of readers before the final submission is

made. During review, it is subject to critical analysis. Before starting to write a

report, make sure that the goal and scope are well defined. This is to make sure that the

report adequately addresses the main points of the report. The report should be as short,

concise and straight to the point as possible. The value of a report does not depend on its

length but on its accuracy and clarity of its content. Each section of the report has a

specific function and the writer must meet minimum requirements. If each section is

written so that it performs its intended function, the final report will be a clearly and

efficiently written report.

2.0 CONTENT OF PROJECT REPORT


A typical report format should follow the pattern below:

1
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

1. Title page

2. Approval page

3. Dedication

4. Acknowledgement

5. Abstract

6. Table of Contents

7. List of Tables

8. List of Figures

9. Nomenclature

10. Main body of the Report

11. References

12. Appendices (optional, depending on the nature of the project)

3.0 GUIDELINES FOR WRITING THE COMPONENTS OF THE REPORT

3.1 Title Page

The name of the institution is written first followed by the title of the report, name of the

author and the purpose for which the report is submitted. The title of the report should be

brief (not more than 20 words) and it should accurately reflect the content of the report.

Example of title page is shown in figure 3.1.

3.2 Approval Page

The name of the Institution, the Department and a statement by the writer is written. A

statement by the writer stating his name and the topic is required here. The names of the

project supervisor, the Head of Department and possibly the External Examiner to sign the

report with dates also appear here. An example of approval page is shown in figure 3.2.

2
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

3.3 Dedication

The project report may be dedicated to anyone who has endeared himself or herself to the

writer. This could be to a friend, family member, or loved one whether living or deceased

who possibly has made an impact to the person in the process of writing the report.

Dedication can also be towards bringing awareness to certain events or situations around

the world. Dedication is however optional. An example of dedication is shown in figure

3.3.

3.4 Acknowledgements

This is the page in which the writer expresses appreciation for the assistance and

encouragement received from various individuals and organizations while working on the

project. They include those who made technical and financial contributions or helped to

influence the work positively. Acknowledgement of institutions and individuals who made

facilities available at any stage of the project gives the report some credibility. An example

of acknowledgements is shown in figure 3.4.

3.5 Abstract

The abstract is as an overview, synopsis or summary of the report. This is often written last

after the main body of the report is completed, as its purpose is to provide a summary of

the report’s essential information.

Abstract, as presented by Olorunmaiye [2] should contain the following elements:

* A statement of the engineering problem attempted to solve,

* An explanation of the approach or methodology to solving the problem,

* The main finding i.e. Results,

* The main conclusion,

* Applications of the findings, and

* The abstract should not exceed 200 words in a single paragraph.


3
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

Abstract is used to decide whether or not the content of the report is relevant and for

academic purposes. It allows researchers to quickly review literature and significant

findings on a particular topic. An example of abstract is shown in figure 3.5.

UNIVERSITY OF ILORIN

SAND CASTING OF AN IMPELLER BLADE

BY

BABA, KOLAWOLE ALIYU

A PROJECT REPORT SUBMITTED TO THE DEPARTMENT OF


MECHANICAL ENGINEERING IN PARTIAL FULFILLMENT OF THE
REQUIREMENTS FOR THE AWARD OF BACHELOR OF ENGINEERING
DEGREE IN MECHANICAL ENGINEERING

ILORIN, NIGERIA

OCTOBER 2008

Figure 3.1 Example of title page

4
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

UNIVERSITY OF ILORIN

DEPARTMENT OF MECHANICAL ENGINEERING

The undersigned certify that this project report prepared by BABA,

KOLAWOLE ALIYU (MATRIC. No---) Titled: SAND CASTING OF AN

IMPELLER BLADE meets the requirements of the Department of Mechanical

Engineering for the Award of Bachelor of Engineering (B.ENG) Degree in

Mechanical Engineering.

------------------------ --------------------
Dr. J. O. AWEDA DATE

(Supervisor)

------------------------- --------------------
Dr. I. K. ADEGUN DATE

(Ag. Head of Department)

----------------------------- --------------------
EXTERNAL EXAMINER DATE

Figure 3.2 Example of approval page

5
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

DEDICATION

This project is dedicated to the memory of Pa JJ, who taught me how to be obedient
and hardworking.

Figure 3.3 Example of dedication

6
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

3.6 Table of Contents

In the Table of Contents, the main headings and sub-headings and the page numbers in

which they begin are listed. Note that each chapter, section and subsection must have a

heading and such a heading must be written in the Table of Contents exactly as it appears

in the main body of the report. An example of table of content is shown in figure 3.6.

3.7 List of Tables

The use of tables enables the writer to present the data in a logical and concise manner.

Tables according to Olorunmaiye [2] must be according to the following points:

1. The table number and table title should be written bold at the top of the table. The

title must reflect the content of the table,

2. A table should be self-explanatory so that it can be read and understood without

referring to the text of the report,

3. Table should be on a separate page and it must be referred to in the text,

4. Table should be arranged to come close to where it is being referred to in the text,

5. If a table is too big and the title has to be typed along the length of the page, be sure

to arrange the page in such a way that the top of the table is near the bound end of

the page (landscape orientation),

6. Tables may be numbered according to the chapter and sequence in which they

appear, i.e. Table 2.1, Table 3.3 etc. (Table 2.1 means Chapter 2 Table 1). An

example of list of tables is shown in figure 3.7.

7
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

ACKNOWLEDGMENTS

I am highly appreciative of the effort of my supervisor Dr. J.O. Aweda for taking

time to read through this report and his positive criticism of the project. Sincere

acknowledgement is given to my father for his effort and concern while this course

lasts.

My deep appreciation to the Mr KJ the University Technologist for the assistance

rendered towards the successful implementation of this project.

Figure 3.4 Example of acknowledgements

8
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

ABSTRACT

Commercially pure aluminium metal was used to sand cast impeller blade used in

water pumps. The pattern was made of hard wood. The molten aluminium metal was

poured at superheat temperature of between 60 and 800C. The time of pouring of

molten metal into the sand cavity was also varied and was within 5 to 10 seconds.

The results show that increase in superheat temperature increases the quality of cast

impeller blade. The time of pouring has no significant influence on the quality of cast

metal.

Please note that if there is any comparison with the experimental, numerical and/or with the literature,
it is worth mentioning in the abstract.

Figure 3.5 Example of abstract

9
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

TABLE OF CONTENTS

Title page i

Approval/Certification page ii

Dedication iii

Acknowledgement iv

Abstract v

Table of Contents vi

List of Tables vii

List of Figures viii

Nomenclature ix

CHAPTER ONE: INTRODUCTION 1

Sub-Topics

CHAPTER TWO: LITERATURE REVIEW

CHAPTER THREE: METHODOLOGY

CHAPTER FOUR: MATHEMATICAL FORMULATIONS

CHAPTER FIVE: MATERIALS AND EQUIPMENT

CHAPTER SIX: RESULTS AND DISCUSSION

CHAPTER SEVEN: CONCLUSION AND RECOMMENDATION

REFERENCES

APPENDIX I: CORNER EFFECTS

Figure 3.6 Example of table of contents


10
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

LIST OF TABLES

TABLES TITLES OF TABLES PAGE

3.1 Maximum temperatures obtained with corresponding

delay times while applying pressure on the solidifying metal

with die heating (P = 85.86MPa, TM=3000C) 8

Figure 3.7 Example of list of tables


11
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

3.8 List of Figures

The figures in the report may include charts, graphs, drawings, photographs and schematic

diagrams. The use of figures makes the write-up clearer. Graphs should be neatly and

carefully drawn on graph paper or plotted with a computer, and axes must be properly

labelled and scaled.

Take note of the following points on figures:

1. The title of a figure and figure number should be written at the bottom of the

figure. The title must reflect accurately what is presented in the figure.

2. More than one figure could be on a page, but the figure should not be clumsy,

3. Each figure should appear as soon as possible after it is referred to in the text.

4. The figure could be drawn clearly and neatly using a pen. Avoid handwritten

labels.

5. Placing photocopy of diagram is not allowed. However, the diagram may be traced

and the source acknowledged where the title is written.

6. If the figure is a graph, make sure that the axes are well labelled.

7. Figures are to be numbered using Arabic numerals. Number the figures according

to the chapter in which they appear and the sequence in each chapter i.e. figure 2.1,

figure 3.2 etc. Example of a figure is shown in figure 3.5. (figure 2.1 means chapter

2 figure 1).

12
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

LIST OF FIGURES

FIGURES TITLES OF FIGURES PAGE

3.1 Example of title page 4


3.2 Example of approval page 5
3.3 Example of dedication 6
3.4 Example of acknowledgements 8
3.5 Example of abstract 9
3.6 Example of table of contents 10
3.7 Example of list of tables 11
3.8 Example of list of figures 13
3.9 Calibration graphs for digital voltmeter and chart
recorder using thermocouple (Type K) as sensor 14

3.10 Example of nomenclature 15

Figure 3.8 Example of list of figures

13
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

Table 3.1 Maximum temperatures obtained with corresponding delay times while
applying pressure on the solidifying metal with die heating (P = 85.86MPa,
TM=3000C)

Delay time, Solidifying Maximum Time of Temperature


temperature on solidifying reaching rise
(sec.) pressure temperature maximum
( C)
0
application attained, after temperature
retention time
( C)
0
of 55sec. (0C) (sec.)
1 709.54 738.27 56.85 28.73
5 700.01 733.26 57.76 33.25
10 696.25 721.22 68.57 24.97
20 674.77 720.01 75.06 45.24
30 657.57 707.89 86.51 50.32

1400
Furnance temperature, C

1200
0

1000

800

600

400
Voltmeter temperature reading
200 Chart ploter temperature reading

0
0 200 400 600 800 1000 1200
0
Temperature reading, C
Figure 3.9 Calibration graphs for digital voltmeter and chart recorder using
thermocouple (Type K) as sensor

3.9 Nomenclature

Nomenclature or notation is the list of all the symbols used in the report and their meaning

presented in a tabular form. Roman letters used as symbols may be listed first, followed by

Greek letters, the subscripts, superscripts, operators and abbreviations. An example of

nomenclature is shown in figure 3.8.

14
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

NOMENCLATURE
Symbol Non-dimensional Form Meaning
a A = a/a0 Speed of sound
E Activation energy
C -Electrical conductivity,
h -Mould thickness
R -Radius of metal mould,
T -Temperature,

Greek Symbols
ε                -strain rate,

ρ        D  = ρ/ρ0      ‐Density

η -friction factor,

Superscripts

t -time
Subscripts
s -solid state
Abbreviations
CPU -Central processing unit

Figure 3.10 Example of nomenclature


15
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

4.0 MAIN BODY OF THE REPORT

4.1 Introduction

Introduction is the first part of the main body of the report. The function of the

introduction is to describe the purpose and scope of the project. The body of the report

should be tied to the information given in the introduction. Generally, the reader is first

introduced to the overall topic, the methodology of approach to solving the problem and

then to the specific areas addressed in the report. A length of about 1 to 2 pages of

introduction should be sufficient except in few special situations. The background to the

project is presented with sufficient details to enable the reader understand why the study

was undertaken. Introduction should be closed with a section on the objectives of the

project, the constraints and limitations to the project clearly stated.

4.2 Literature review

This may form part of the chapter on introduction or it may be a separate chapter. It is

expected that work done by others in the past that are relevant to the present work be

discussed briefly. This constitutes the foundation on which the intended report is built on.

The review of the literature summarizes and evaluates the previous authors’ contribution to

the present study. It states how literature has contributed to the area of research and gives

appraisal of the strengths and weaknesses of previous studies. It also informs the writer’s

understanding of the research problem.

Teitelbaum [3] noted that while reviewing the work done by others, there are five

types of notes that can be taken. They are:

i. Quotation (use author’s exact words),

16
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

ii. Paraphrasing (use the authors’ idea in another words),

iii. Summarising (use author’s main points),

iv. Copying (use author’s figures, tables or charts), and

v. Personal reactions or comments on the work.

Direct quotation should be used sparingly in the write-up and it should be brief, starting

and ending with inverted commas (quotation marks). When paraphrasing, the ideas are

stated in the writer’s own words. This is an alternative to direct quotation. Teitelbaum [3]

has suggested that to ensure that the writer uses his own words, he reads the portion of the

text to be paraphrased, close the book and then write down the idea in his own words. A

summary is the gist of the work being reviewed stated in the writer’s own words. Personal

reactions or comments may be an appraisal or otherwise of the results or the methodology

of obtaining the results. In writing the project report, the advice of Tarpley [4] quoted

below is worthy of note.

“Give credit for all ideas, research and information not original. If credit is not assigned, this is

known as plagiarism and it is unethical. Do not copy the exact words from some source and then

use them as your own.”

Give credit to the source of an idea by writing the number associated with that source in

the list of references in a square bracket or writing the author’s name and year.

4.3 Methodology

Methodology explains how data was gathered or generated and how it was analysed. The

method of analysis should be fully justified in the write up while considering other

methods of analysis that are previously been adopted or may be adopted. The language

17
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

used is in the past tense. The research carried out is what to be discussed in details and not

the activities of the researcher leading to the research work.

4.4 Mathematical Formulations

The symbols used should be defined immediately after the equation and also in the

nomenclature. All equations should be numbered consecutively using Arabic numerals

written in brackets ( ) on the right margin, in order to distinguish them from any reference

numbers which may appear in square brackets. Equations should begin on a new line and

be referred to in the text in the same manner, e.g. inserting equations (1) and (2) into

equation (3). Equations should be typed with Microsoft equation editor available in all

Microsoft words.

Equation should be written as;

I=
P
(1)
V

and not as

I= P (1)

4.5 Materials and Equipment

Materials, instruments and pieces of equipment used should be mentioned in the write-up.

The serial numbers, name and place of manufacturer should also be mentioned. A

photograph of the experimental rig or prototype of the machine produced must be included

in the write-up.

4.6 Experimental Procedure

The procedure used in gathering the experimental data should be given in detail. Any

precaution taken and difficulties encountered should be mentioned. Proper description of

18
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

any equipment constructed for the purpose of the project work should be made in the

write-up.

4.7 Results and Discussion

With diagrams, graphs, tables, charts etc., the results are presented by giving clear

explanations on the results obtained. The results are to be compared with what has been in

previous literatures highlighting conformity or deviation. The purpose of the discussion of

results is to communicate what was learned and how the results lead to the conclusions.

The results are discussed in terms of what they show about the results and what they mean

in the context of the goal of the report. Explanation of results should include comments on

unexpected results and offering reasons or hypothesis for such behaviour. The discussion

forms the bridge between the original observations and what they will ultimately mean to

the reader. And finally a statement on how the result findings can be applied in

engineering or daily life is discussed.

4.8 Conclusions

On the basis of the results obtained the conclusions are drawn. Conclusion is a concise

statement(s) of the results and their significance to the topic or knowledge.

4.9 Suggestions for further work

Suggestions for further work could be in areas that the writer wished could have extended

the work to if time permits. It is to guide future workers working on similar topics who

want to extend the study. Suggestions for further work are important to those who must act

on the report.

5.0 REFERENCES AND APPENDICES

5.1 References

References must be provided in the report if someone else’s opinions, theories, data or

research findings were used. Failure to indicate the sources of the ideas may
19
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

suggest that the writer is wrongfully claiming another person’s ideas or words to be his

own. This is known as plagiarism an offence punishable in academic circle. Referencing of

sources is also encouraged because it strengthens a writer’s argument and adds credibility

to the write up. Referencing shows wide knowledge in the subject matter and identifies the

critical aspects of other research in a similar area.

There are two different types of reference lists used in engineering:

• Alphabetical reference list according to author – used with the author-date

(Harvard) system,

• Numbered reference list in order of their appearance in the text – used with the

numerical system.

Whichever format is adopted there must be consistency. However, the numbered reference

system is adopted for project write-up. Examples of how to reference are listed below from

different publications.

Journals

1. Sule, B.F., 1989, Use of correlation and regional statistics methods to construct

streamflow record, The Nigerian Engineer, vol.24, No2, pp29-36.

2. Oyeleke, I.F., Olaoye, J.O., Faseyi, S.A., 2004, Capacity utilization of wetland

(fadama) infrastructure in Kwara State, Nigeria, Nigerian Journal of Technological

Development, Vol 4(1), December, pp64-72.

Books

3. Adedayo, S. M., 2000, Graphics for Engineers, INDEMAC (Nigeria Publishers)

Limited, Ilorin, Nigeria.

20
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

4. Hannah, J, and Hillier, M.J. 1999, Applied Mechanics, Longman, UK.

5. Holman, J.P., 2001, Heat Transfer, TATA McGraw-Hill, New Delhi.

Thesis

6. Terebo, M., 2007, Investigation of the foundry properties of some natural sand

deposits: A case study of Ilesha and Ilorin moulding sand, B.Eng, Project Report,

Mechanical Engineering Department, University of Ilorin, Ilorin, Nigeria.

Reports

7. Lubard, S.C. and Helliwell, W.S., 1973, Calculation of the flow on a cone at a high

angle of Attack, “R & D Associates, Santa Monica, Calif., RDA TR 150, Feb.

Proceedings

8. Ukaegbu, O.D. 1999, Managing Nigeria’s energy sector for sustainable national

development, Proceedings of the National Engineering Conference and AGM,

Ilorin, Nigeria, pp205-217.

9. Kaufman, H.R., and Cohen, A.J., 1971, Maximum propellant utilization in an

electron bombardment thruster,” Proceedings of the Symposium on Ion Sources

and Formation of Ion Beams, edited by T.J.M. Sluyters, Brookhaven National

Laboratory, Oct., pp61-68.

5.2 Appendix

Appendices contain standard derivations, maps and lists of parameters, which would

interfere with the continuity of the main body of the report. All documents in the

appendix, which is not the author’s work, should be properly referenced. Appendix should

be numbered consequentially, i.e. Appendix I, Appendix II etc. Appendix with large

figures should be reduced to A3 size where possible to avoid multiple folding. In most

cases appendix contains:

21
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

• All the figures corresponding to the report.

• Photocopies of documents, cuttings and all traced drawings.

• Other material which may be crucial to the report

6.0 ADDITIONAL COMMENTS


6.1 Report Formatting

Appropriate formatting of reports improves the readability accessibility of information.

The Department outlines the essential formatting guidelines required of the report. Reports

should maintain the same internal style and structure throughout. Reports are processed on

the computer. White A4 paper, printing on one side only is preferred for project report

while each chapter of the report begins on a new page. The recommended margins are

3.0cm on the left, 2.5 on the right sides, and 3.0cmm at the top and bottom of the paper.

Use double spacing, Times New Roman in 12-point font size normal size for the body of

the report. The title page should not be numbered while all other preliminary pages are in

Roman numerals. All other pages from introduction page to the end of the appendices are

numbered in the middle bottom page (footer) in Arabic numerals. One space between

heading and subheading, one space between paragraphs, and two spaces between the end

of a section and the next heading is required. The supervisor can provide some help

regarding the technical accuracy of the report.

6.2 Technical Language

Effective use of technical language is a critical part of report writing. Important aspects of

technical language to be considered are structure, grammar, vocabulary and punctuations.

A quality engineering report exhibits the following characteristics:

i. Clear statement of aim or purpose,

ii. Concise and precise presentation of detail,

22
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

iii. Cohesive and logical development of data and ideas,

iv. Considered objective separation of fact and opinion, and

v. Categorised layout of well-spaced headings, paragraph

6.3 Appearance

Spelling, grammar and neatness are important components of report writing. Clear and

simple English should be used with simple sentences without slang while avoiding

repetition of particular words in a report. Avoid the use of capital letters for emphasis, bold

or italics may be used where such emphasis is required. Tables and graphs should be well

organized and clearly labelled. They should be able to stand as separate entities. Scaling of

graphs should be done in such a manner that the graph is not crowded in a corner or on the

side but covers a major part of the sheet. The use of S.I. units is required. Work to some

significant figures i.e. if a diameter is determined as 6.453545mm in the calculations then

it is better written to two significant figures as 6.45mm except in few cases of iteration.

6.4 Proofreading

This is the checking of every aspect of the written work, the content, grammar, layout etc

of the write up. Do not submit any work or report without first proofreading it. It may not

be possible for the writer to proofread accurately, because of familiarity with ones job

where mistakes may not be found. Have a colleague read the report for clarity,

organization, and visual design. It can be given to somebody who is knowledgeable in the

area of the project to proofread, whose name is recorded and acknowledged.

6.5 Deadline
Be aware of the deadline for the completion of the report and try to meet it. Remember
there is normally a penalty for late submission.

23
University of Ilorin, Mechanical Engineering Department, Technical report 2008-06

Aweda, J.O and Lasode O.A

7.0 REFERENCES

1. Oni, K.C., 1995, Research reporting: A guide to thesis preparation for Agricultural

Engineers, Department of Agricultural Engineering, University of Ilorin, Ilorin,

Nigeria, March.

2. Olorunmaiye, J.O., 1999, A guide for writing final year project report, Department

of Mechanical Engineering, University of Ilorin, Ilorin, Nigeria, December.

3. Teitelbaum, H., 1975, How to write thesis, Monarch Press, New York, pp33-39

4. Tarpley, M., 1978, Paper Writing Guide, Baptist Press (Nig.) Limited, Ibadan.

24

You might also like