Scribd
Upload
11 views18 pages

Lecture TRW

Uploaded by

mohamed tawfik
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
11 views18 pages

Lecture TRW

Uploaded by

mohamed tawfik
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 18

University of Canal Suez

College of Engineering
Department of Mechanical Engineering
Mechanical Power Engineering
Technical Report Writing; Level zero
Dr. Abdelnabi Zaghloul Abdelnabi
Dr Hany Salem

Lecture 2

The Structure of Technical Report


Writing (TRW)
Format of Technical Report (TR)
A TR typically has the following format:
• Title page
• Acknowledgements
The beginning
• Table of Content
• Abstract or Summary
• Introduction
• Sections/Chapters – containing the text body.
• Conclusions The middle
• References The End
• Appendixes
Title Page
• The title page is the first page of the report and
it should include:
– The title and author’s name.
– The report reference number and date (if available)
– The organisation’s name and logo (if desired)
– A statement of copyright, if needed.
NOTE: For your Stage N reports, there are
templates for the title page and it should
include the thesis supervisor’s name.
The organisation’s
name and logo Suez Canal University
Faculty of Engineering

Solar Panels
Image
The title and
author’s name.

By
-----------------------------------

supervisor’s name Supervisor


Dr . Abdelnabi
The report reference Ref # 2355
number and date Data 04/11/2023
A statement of copyright
Copyright is a type of intellectual property that
protects original works of authorship as soon as
an author fixes the work in a tangible form of
expression.
Acknowledgements

• This section is used to thank people and/or


organizations who helped prepare the report.
• This may be from librarians, technicians or
computer center staff, for example.
Table of Content
• The contents page sets out the sections and
subsections (or chapters) of the report and
their corresponding page numbers.
– It should clearly show the structural relationship
between the sections and subsections (chapters).
– A reader looking for specific information should be
able to locate the appropriate section easily from
the table of contents
NOTE: The sections and subsections are
numbered by using the decimal point number
system.
Table of Content
Page No.

CHAPTER ONE : BASIC HEAT TRANSFER


1.1 INTRODUCTION 1
1.2 RELATION of HEAT TRANSFER to THERMODYNAMICS 10
1.2.1 Conservation of Energy for Control Volume 15
1.2.1.1 The mass and volume flow rate 20
Summary/Abstract/Synopsis
• The summary or Abstract provides a brief
overview of the substance of the report.
– It is usually not more than half a page (definitely
should be less than a page).
– It is NOT and introduction to the topic.
– It should outline all the key features of the report,
including the topic, what was done and how it was
done.
NOTE: The summary gives the most important
findings of the research or investigation.
Summary/Abstract/Synopsis
This should be a short paragraph summarising the main
contents of the report.
It should include a short statement of the main task,
the methods used, conclusions reached and any
recommendations to be made.
The abstract or summary should be concise,
informative and independent of the report.

Write this section after you have written the report.


Introduction
• The introduction provides the background
information needed for the rest of your report
to be understood.
– It is usually 3/4th of a page to maximum 2 page.
• It includes
– The background to the topic.
– A clear statement of the purpose of the report.
– A clear statement of the aims of the project.
Body of the Report
• This is the main part of the report, where the
work done is presented.
NOTE: Introduction and Conclusions act as the
frame (often called head and Feet) for the
body only and hence all the details of the
work done must be included here.
• The presentation of information should flow
logically so that the reader can follow the
development of the project.
Conclusion
• The Conclusion section provides an effective
ending to the report.
• It must give some overall insight into the value
of the work done in general and inform the
reader about the major impact of the project
work done.
NOTE: Often in the Stage N report, this will
contain another section called future work,
where the writer’s view of directions that can
be taken for taking the work further would be
presented.
References
• The Reference shows that information comes
from another source and also gives the details
of these sources.
NOTE:
1. Only material that was relevant to the work
reported in the report should be included here.
2. Complete details of the sources is essential.
3. There are rules of how and what details of the
sources are to be included.
References
Standard form for a web entry:

Author's surname,
rest of name,
date of document,
Title of document,
<web address>,
date accessed.

An example of this is:

McCrum, Ian J. 2007 Report writing


http://www.eej.ulst.ac.uk/~ian/modules/MEC002J1/report_writing.ppt
(accessed 29th September, 2007)
Appendixes
• The Appendixes contain material that is too
detailed to include in the main report (e.g.
raw data or detailed drawings, questionnaires,
etc.)
• Usually each Appendix must be given a
number and title.
NOTE: Usually capital alphabets are used for
different appendixes (e.g. A, B, C,.. Or A1, A2,
A3,…)
Thank You!!!

You might also like