0% found this document useful (0 votes)
4 views19 pages

Final Project Report Writing Guide

The document is a guide for writing a final study project report for the Department of Mechanical Engineering at ISET Siliana. It outlines the organization, formatting, and essential components of the report, including the cover page, table of contents, body structure, and presentation rules. The guide emphasizes clarity, structure, and adherence to specific formatting guidelines to ensure a professional presentation of the student's work.

Translated by

ScribdTranslations
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
0% found this document useful (0 votes)
4 views19 pages

Final Project Report Writing Guide

The document is a guide for writing a final study project report for the Department of Mechanical Engineering at ISET Siliana. It outlines the organization, formatting, and essential components of the report, including the cover page, table of contents, body structure, and presentation rules. The guide emphasizes clarity, structure, and adherence to specific formatting guidelines to ensure a professional presentation of the student's work.

Translated by

ScribdTranslations
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

TUNISIAN REPUBLIC

MINISTRY OF HIGHER EDUCATION


AND OF SCIENTIFIC RESEARCH

DIRECTORATE GENERAL OF TECHNOLOGICAL STUDIES


Higher Institute of Technological Studies of Siliana

Department of Mechanical Engineering


***********

MODEL FOR WRITING A REPORT


FINAL STUDY PROJECT

Produced by: Department of Mechanical Engineering

(ISET Siliana 2012/2013)

Academic year: 2012/2013

ISET Siliana - New City Elmadina 6100 Siliana Tél. (+216) 78 874 600 Fax. (+216) 78 874 699
Writing a final study report

Table of contents
I. SETTING UP A PFE
II. ORGANIZATION OF THE REPORT.............................................................ERROR! UNDEFINED BOOKMARK.
[Link] PAGE...................................................................................................................................... 4
[Link] OF CONTENTS................................…………………………………………………………………6
[Link] DEDICATIONS PAGE..............................................................6
[Link] THANK YOU PAGE.......................................................6
II.5. BODY OF THE REPORT ..........................………………………………………………………………………6
a. General introduction ........................................................................................................................... 6
b. Development...................................................................................................................................... 6
c. General conclusion ............................................................................................................................. 7

III. FORMAT OF THE REPORT ............................................................................................................. 7


[Link] TO APPLY........................……………………………………………………………………7
[Link]...........................……………………………………………………………………………8
[Link]
[Link] ..................................................................................................................................................... 9
[Link] and styles........................................................................................................................................ 9
[Link] of contentss .................................................................................................................................11
e. Header ..................................................................................................................................................11
[Link] of the pagee..........................................................................................................................................12
g. Pagination ...........................................................................................................................................13
h. Tables, figures and curves.................................................................................................................13
i. Technical drawings................................................................................................................................14
[Link] ...........................................................................................................................................14
[Link]
V.6. PIMAGINATION.......................................................................................................................................13
V.7. TABLEAUX, FFIGURES ANDCOURBES.......................................................................................................13
V.8. DTECHNICAL DRAWINGS..........................................................................................................................14
VI. GRAMMAR AND SPELLING .................................................. ERROR! UNDEFINED SIGNATURE.
VII. ANNEXE ......................................................................................................................................................14
VIII. GRAMMAR AND SPELLING ......................................................................................................16
[Link]
IX. FINAL INTERNSHIP DEFENSE .................................................................................17
IX.1. CONDUCT OF THE PRESENTATION....................................................................................................................17
IX.2. PREPARATION OF THE PRESENTATION
a. Rules for preparing the presentation............................................................................................................ 17
b. The course of the defense ..............................................................................................................18
c. Some tips for the oral presentation.......................................................................................................18
IX.3. EVALUATION
[Link] of the report ..............................................................................................................................18
b. The questions ...........................................................................................................................................18
c. The answers to the questions.........................................................................................................................18

Iset Siliana 2
Writing a graduation report

I. Implementation of a PFE
[Link]
processedinmonomialorbinomial.(Requestforacceptanceforinternshiptobereceivedfromtheserviceof

internshipatISETinordertocopyitseveraltimes,fillinthedifferentcopiesandtransferthemto
severalcompaniestoincreasethechancesoffindinganinternshipattheendofstudies.
Upon obtaining a principle agreement from the supervisor, the process must take on a character
[Link],thestudentmustsubmitthecompletedandapprovedacceptancerequest.
fromtheindustrialsupervisortothedepartmentforthefinalconfirmationoftheproposedsubject.

NB :
The time allocated to each project is about 13 weeks. Supervision is provided by
by teachers from the department and by the heads of the institution that offers the
subject.

The industrial supervisor or the manager in the company who proposed the subject is the one who
commitstoestablishingthespecifications.

[Link]
copyaninternshipreportfromanyinstitution.

After final confirmation of the subject, the student concerned must contact, presenting the
Request for acceptance endorsed by the department, the internship office of ISET for
toreceiveanassignmentletter.

II. Organization of the report

The formatting and presentation of the final project report must be given attention.
of particular attention because these are two elements on which it will partly rely
the jury's evaluation.
The first impression given by the overall appearance of your report is therefore very important and
It is necessary to avoid having this impression be negative. The goal is for your report to be clear.
presented, pleasant to read, neat, airy, illustrated and above all structured.
The reviewers must be able to quickly understand your work and your reasoning.
until the conclusion of the report. Thus they will be able to have a quick idea of the quality of the content.
and the relevance of your work.
The report of a final year project consists of about 30 to 50 pages (excluding appendices).
and must necessarily include the following elements:

Iset Siliana 3
Writing a graduation report

1-A cover page.


2-A dedication (1 to 2 pages).
3-A thank you (1 page).
4-A table of contents or summary
5-A list of figures (not mandatory).
6-A list of tables (not mandatory).
7-The body of the report which includes:
7.1. A general introduction.
7.2. The development presented in the form of chapters.
7.3. A general conclusion.
8-The annexes.
9-The bibliography.

II.1. Cover page


The cover page (see template on the next page) must include the following elements:
The header of the ISET of Siliana and the Mechanical Engineering department

The project title at the center of the page (the title must not exceed 10 words)
The first names and last names of the supervisors (ISET and company).
The first names and last names of the students.
The academic year (centered and at the bottom of the page).
The project code.
It is recommended not to change the format. Special attention should be given to this page.
to avoid containing errors (spelling, form, etc.).

Note: We want the following model of the cover page to be respected.


to unify the presentation of all final year projects within the department. This
The cover page template is available at the IT support in the secretariat.
mechanical engineering department.

Iset Siliana 4
TUNISIAN REPUBLIC

MINISTRY OF HIGHER EDUCATION


AND SCIENTIFIC RESEARCH

DIRECTORATE GENERAL OF TECHNOLOGICAL STUDIES
Higher Institute of Technological Studies of Siliana
Department of Mechanical Engineering

Final project
Code: GM……. /2013

Title title title title title title title


title title title title title title title
Prepared by:
Mr. Mrs. Miss. (Name and first name of student 1)
Mr. Mrs. Ms. (Name and surname of student2)

Framed in the ISET by:


Mr. Mrs. Miss. (Name and first name of the educational supervisor)

Developed in:

Company Logo

Framed in society by:


Mr. Mrs. Ms. (Name and first name of the industrial supervisor)

Academic year: 2012/2013


ISET Siliana - Elmadina Eljadida 6100 Siliana Phone. (+216) 78 874 600 Fax. (+216) 78 874 699
Writing a final thesis report

II.2. Table of contents or summary


The table of contents must display the numbers and titles of the headings and their
pagination. For the sake of readability, it is desirable to present the titles of 3èmelevel
at most.
The table of contents must be created automatically. To do this, it is necessary to
correctly define the styles of the different titles.
The titles of the appendices and their pagination must be included in the table of contents.

The list of figures and the list of tables are optional elements.
II .3. The dedication page
The dedication page is optional. It is left to the author's discretion to please
those for whom work really matters. Don't overdo it.
II.4. The acknowledgments page
It is obviously a matter of thanking the responsible persons of the hosting organization, the supervisors.

pedagogical (ISET Siliana) and professional and anyone who contributed


to your work. Avoid overly elaborate or overly warm phrases. Stay true and sincere.
The format is free which will allow you to express yourself in your own style.
These thanks are expressed in a maximum of ten lines, in the most
simple as possible, without platitude or exaggeration.

II .5. Body of the report


a. General introduction
The introduction has three objectives:
She introduces the topic. This means that one must briefly present the context.
general work accomplished, for example the professional environment and then define the
subject in precise and concise terms;
She then briefly outlines the objectives of the personal work and the resources allocated.
efforts to try to reach them;
It concludes with a clear presentation of the different parts discussed in the following.
report.
The introduction must remain accessible to a non-specialist reader of the subject. If necessary, it can include

will provide a brief definition of the technical terms used. Finally, its size should remain moderate;
it must not exceed 2 pages.
b. Development
We will not impose a uniform structure on the development of the report. Each project
is a particular case. However, the structure of the development can follow the following logic:

ISET Siliana 6 DGM


Writing a graduation report

Problematic: This chapter will need to detail the project's problematic.


He will briefly present the company, then in detail the mission entrusted to
intern
-Work done (study, realization, etc.): This chapter may present the approaches,
the methods and materials used in the project (software, test bench, measurements,
measures, etc.). In this part, the student must present their work well and put it in
value.
Results and discussions: This chapter will serve to present and discuss the developed results.
by the student. It is not necessary to introduce new concepts or issues at this stage.
of the report.
NB :
The work must be divided into chapters. Each chapter must include an introduction.
which announces the content, and a conclusion aiming to summarize the chapter and
to announce the next chapter.
It is recommended to have chapters that are fairly balanced in terms of number of pages.
At the time of writing the chapters, it is important to indicate the source.
bibliographic of ideas borrowed from other authors (books, articles, reports of
PFEs, reference manuals, documents found on reliable web sources, etc.).
The bibliographic source must be indicated by its number in the list of references.
bibliographic references enclosed in brackets ([1], [2], etc.).

c. General conclusion
The conclusion summarizes the work done and clearly shows whether the objectives have been achieved.
reached. If new difficulties have been raised, it is appropriate to explain why and
possibly to propose solutions.
The conclusion can present perspectives following the work done and an opinion.
student's personal work on their project.
The conclusion must not exceed one page. It should allow the hurried reader to respond to
this simple and unique question: What should I take from this work?

III. Formatting of the report


Presentation rules are conventions established to achieve a certain uniformity and
to improve the readability of a report. Failure to comply with these rules can lead to a
a document unpleasant to read, therefore penalizing for its author.

III.1. Advice to apply


Do not change software while writing;
ISET Siliana 7 DGM
Writing a graduation report

Ensure to access the same version of the software when working on different stations;
III.2. Layout
The manuscript must be typed single-sided on A4 paper, in black and white. The use of the
Color is allowed only for illustrations (figures, graphs, etc.), if necessary.
a. Margins
We set the following margins for the report through the Page Layout function found in
the File menu of the main menu of Word:
Skin 2 cm Enough 2 cm
Left 2 cm Right 2 cm
Binding 0.5 cm

Disposition
Header 1.25 cm
Footer 1.25 cm

ISET Siliana 8 DGM


Writing a final study report

The margins must remain uniform throughout the document, including the
annexes.
b. Police
We adopt the Times New Roman font for the entire document.
c. Sizes and styles
. Corps du texte :
- Taille : 12 points
Alignment: Justified
Line spacing: 1.5 lines
Note: Alignment and Line spacing appear in the Paragraph function of the Format menu.
main menu of Word.

ISET Siliana 9 DGM


Writing a final study report

. Style Title 1:
- Police: Size: 20 points; Bold and small (only the 1erathe letter is in uppercase)
- Alignement : Justifié
- Withdrawal after the text: 35 points
Line spacing: 1.5 lines
- Numbering: in chapters (Chapter 1; Chapter 2; etc.)

Chapter 1: Title 1

Each chapter must begin on a new page with the title centered (page not
numbered and without header or footer.
. Style Title 2:
- Police: Size: 16 points; Bold and small (that the 1erathe letter is in uppercase
Alignment: Justified
Withdrawal before the text: 6 points
- Withdrawal after the text: 6 points
- Line spacing: 1.5 lines
- Numérotation : En chiffre romain (I. Définitions ; II. Présentation de la soci
etc.)

I. Title 2

ISET Siliana 10 DGM


Writing a thesis report

II. Title 2
. Style Title 3:
- Police: Size: 14 points; Bold and small (than 1erathe letter is in uppercase
- Alignement : Justifié
- Withdrawal Before the text: 3 points
Withdrawal After the text: 3 points
Line spacing: 1.5 lines
- Numbering: In digits with hierarchy with Title 2 (I.1 Data of
problem; I.2. Calculation assumptions; etc.)

I.1. Title 3
I.2. Title 3
. Style Title 4:
Police: Size: 12 points; Bold; Italic and lowercase
- Alignement : Justifié
Withdrawal Before the text: 0 points
Withdrawal After the text: 0 points
Line spacing: 1.5 lines
Numbering: In letters without hierarchy (a. First case; b. Second case; etc.)
a. Title 4
b. Title 4
In order to insert an automatic table of contents (under Formats: Official), it is necessary to
define the style of each title using the Style function and format through the Format menu
main menu of Word.
d. Table of contents

CHAPTER 1: TITLE1 .10


CHAPTER 2: TITLE2................................................................................ERROR! UNDEFINED BOOKMARK.
I TITRE2 ...................................................................................................................................................10
II TITRE2 ...................................................................................................................................................11
II. 1. Title 3............................................................................................................................................11
II.2. 2. Title 3............................................................................................................................................11

e. Header
In the header, we display the project title with the following characters:
- Size: 10 points; tiny (like 1erathe letter is in uppercase)
Line spacing: Single

ISET Siliana 11 DGM


Writing a thesis report

-Underlined on the entire header. This is done using the Border function in the Format menu.

main menu of Word.

Example
Design and sizing study

f. Footer
In the footer, the name of the institute, the name of the company if applicable, and the
page number. To do this, we insert a table in the footer consisting of 3 columns
and 1 line.
In the 1erain the column we display the name of the ISET aligned to the left
In 2thcolumn we display the page number centered in the cell (see
the paragraph of the pagination).
In the 3emecolumn displays the name of the company in which it was done
the project, aligned to the right.

The characters of the text are as follows:


- Size: 10 points; tiny (like the 1eraletter is in uppercase
Line spacing: single
- Underscored on the entire footer. This is done by the Border function in the Format menu

from the main menu of Word.


Example:
ISET Siliana 12 SNCFT

ISET Siliana 12 DGM


Writing a graduation report

g. Pagination
The numerical pagination is mandatory. It starts immediately after the cover page.
So the first numbered page will be the table of contents.

Any possible appendices must be paginated in continuity with the document, unless they are
gathered in a separate document.
h. Tables, figures and curves
The tables, figures, and graphs must be numbered and have a title positioned at
preference below. They must be clear and legible. They all must have a caption.
with sequential number for the entire report (see Figure 1 of the following example) placed at
below. The body of the text must describe and refer to the figure using expressions
as: as shown in figure x or as illustrated by figure x or see figure x. The title
must have the following characters:
- Size: 12 points; Italic and lowercase (only the 1eraletter is in uppercase
Line spacing: 1.5 lines.
- Withdrawal before the text: 6 points.
Withdrawal after the text: 6 points.
Alignment: Centered relative to the table.
. Example:
Type of Speed Temperatures Diametrical pressure Product P.V
bearing maxi limits of admissible in Admissible
admissible operation operation (N/mm2.(m/s)
(m/s) (°C) (N/mm2)
Acetal glacier 2 to 3 -40 to 100 14 0.5 to 0.9
Glacier PTFE 3 -200 to 280 20 0.9 to 1.5
Bronze-tin 7 to 8 >250 7 to 35 1.7
Bronze-Lead 7 to 8 250 20 to 30 1.8 to 2.1
Nylon 2 to 3 -80 to 120 7 to 10 0.1 to 0.3

Table 2.1: Comparative performances of standard bearings.

Note: For the tables and graphs that represent results or data, it is
must necessarily mention the corresponding units (m, kg, m/s, etc.)

ISET Siliana 13 DGM


Writing a graduation report

Figure 1.5: Bearings.

i. Technical drawings
The technical drawing sheets (definition or assembly drawing) must be represented
must necessarily follow the standardized format. They must contain the frame, the standardized cartridge,
the nomenclature, etc.

IV. Punctuation
Here are some simple rules to strictly adhere to:
There is no space after an open parenthesis, before a comma, before a period,
before and after a hyphen in a compound name (e.g., a wallet) ;
There is always a space after a period, a comma, the % sign, the quotation mark
closure;
There is no period after a title.
There is a space before and after an opening quotation mark, a colon, the semicolon, a
question mark and exclamation mark ;
Ordinarily, uppercase letters are not accented;
We never start a line with a punctuation mark (except for the
enumerations)

V. Writing
The synthesis is one of the primary qualities of a report. Every sentence must have an interest and
be inserted into a logical set. The sentences must be short, precise and
understandable (15 to 20 words) and the paragraphs will be justified and not left-aligned.
Think about spacing your pages by skipping lines. A page generally contains 35 to 45 lines.
Beyond that, it becomes painfully readable.
The generalities as well as all the passages fully reproduced that come from sources
external materials (downloaded, copied, photocopied, etc.) must therefore be sent back as annexes. It

ISET Siliana 14 DGM


Writing a final study report

It is not advisable to write sentences before having constructed a detailed plan to organize the
ideas.
The style must remain understated: superlatives, passive constructions, negative forms, the period.
of exclamation, certain adverbs (very, a lot, always, never, etc.) and certain adjectives
Words (incredible, great, huge, etc.) showing the student's enthusiasm should be avoided.
The use of acronyms (ANPE, CCI, GPAO...) should remain moderate and they must be
explained at their first use as well as in a table of abbreviations, if applicable.
Except during the defense or in conclusion, value judgments and forms
normatives (must, we must, etc.) should be avoided and must in all cases be accompanied
of arguments. The use of 'I' and narratives of personal experiences are only possible when
during the defense.

VI. Grammar and Spelling


The use of spelling checkers in office tools is of course essential.
However, it is essential to proofread and have one's report reviewed by others.
external perspectives that will provide a more critical look at syntax and grammar.
Here are some common mistakes to avoid:
The use of We or He / She is much more correct than I.
Second and not 2nd or 2nd;
etc. and not etc...
As a follow-up to, and not as a result of;

Mr. and not Mr...


the European Union and not the European Union (the first letter of the names is in
uppercase, but adjectives are only capitalized if they are placed at the beginning of
the acronym);
Equip yourself with at least a grammar manual, a dictionary, and a thesaurus.
synonyms when writing your work.

VII. Annexes
The appendices aim to lighten the body of the report with detailed information or results.
intermediaries, or secondary, but nonetheless strictly necessary (example: listing of
programs, plans, functional diagrams, etc.)
It is advisable to avoid any disproportion between the annexes and the body of the report. The annexes
do not aim to artificially increase the thickness of the report.

ISET Siliana 15 DGM


Writing a thesis report

The appendices must be written and presented with the same rigor as the rest of the document.
Thus, they must have a serial number and a title that will appear in the table of
subjects (e.g.: Appendix 1: Supplier Quotation, Appendix 2: Program Listing, etc.).

VIII. Bibliography
The list of bibliographic references concludes the report. It gathers all the sources.
the documentation used for writing the report and which has been explicitly cited in the
text. The reader must be able to consult any cited document in order to allow them to trace back to
the original information.
References will be arranged in alphabetical order by the author's name, or by the first author if
and there are several.

All entries in the bibliography list must correspond to the references


cited in the text and vice versa.
The format of this list follows specific rules:
For a book reference
Initiale(s) + Nom de chaque auteur, titre du livre, éditeur, lieu de publication,
number of pages, year.
For a reference from a report
Initiale(s)+ Nom de chaque auteur, titre du rapport, type de rapport, nom de
the company or establishment, place of publication, number of pages, year.
Example

For an internet resource


Initial(s) + Last name of each author. "Title of the resource". [If applicable, add
the broader resource to which the cited document is attached; proceed from the
in the following manner: In Author/title or title of the site or document that contains the

ISET Siliana 16 DGM


Writing a final report

resource.], [Type of support]. URL address: provide the complete URL address of
the resource (Resource consulted on: specify the date.)

Example

Caleffi Hydronic solutions. Distributor of components for hydraulic water installations.


cold and hot sanitary water (Taps, mechanical connections, separation collectors,
safety valves, etc.). (Page consulted on November 14, 2008)
Hydraulic Reviews: Hydraulic 2: Pressure losses in installations–The
dimensioning of mixers, [Online]. URL address: [Link]

IX. The final internship defense


It aims to evaluate both in terms of form and content (quality of the report, quality of
the presentation, understanding and answers to questions...) the skills of the students.

IX.1. Presentation Process


The presentation is given by the student (or students) for 20 minutes and will rely on a
presentation by video projection using software such as PowerPoint (or other) put on
CD or on USB stick. (Between 2 and 25 slides).
IX.2. Preparation of the presentation

a. Rules for preparing the presentation

To succeed in his defense, the student must prepare his presentation by following the rules.
following:
The defense presentation must not be a copy or a repetition in any case.
oral » from the 'written' report: the jury members have read the report, so it is not
necessary to summarize it!
We will need to choose the strong points of the report and derive a new plan inspired by it.
summary and prepare the oral presentation taking into account the allowed time.
ISET Siliana 17 DGM
Writing a final project report

Slides documents should not be a photocopy of pages from the


reports, but titles or diagrams specially enlarged to be readable.
b. The course of the defense:
Speech by the president of the jury
Candidate's oral presentation
Interview with the jury
Deliberation
Jury decision.
c. Some tips for the oral presentation:
It is important to prepare well for the defense. It is just as important in the evaluation of the candidate.
that the report itself.
It is strongly recommended to draft the intervention plan in advance, emphasizing the
way to start the speech and the way to conclude it.
One must ensure to have an attire and behavior that do not shock others.
jury members.
It is necessary to monitor the rate of speech, the language used, and to avoid colloquial expressions.
In case of very high stress, request a moment to think, breathe, and do not speak again.
only once relaxed.
Before starting the actual oral presentation, it is customary for the candidate
starts by thanking their supervisor as well as the jury members.
IX.3. Evaluation
The evaluation is carried out by the jury members, and it will focus on the quality of the report, that
of slides and the student's competence (answers to questions).
a. Evaluation of the report:
Each report will be evaluated by the jury members. The evaluator decides whether the report
is accepted or rejected based on predefined criteria (Clarity and precision of the
description of the company and the description of the work done, personal effort
provided by the student for the writing of the report, form, style and spelling...
b. The questions:
The questions aim to evaluate and specify the student's knowledge about the completed internship.
c. The answer to the questions:
During the second part of the defense, the student is required to answer the questions of the
jury. He must inform the candidate whether to answer the questions one by one or if he should take notes.
the set of questions from a jury member to respond to them in a global way.

ISET Siliana 18 DGM


Writing a final report

It is important to know how to listen to the jury in order to fully understand the questions asked, and to
take time for reflection. In case of misunderstanding, the student can rephrase the
Question to be sure to respond correctly.
Some candidates may be tempted to respond off-topic when the question is...
embarrassment. Be careful, the jury members are not fooled, even when they say nothing.
It is also important to observe the jury well and avoid looking at a single member. Observing gestures,
the faces and looks of the jury members can indicate to the candidate that they are asking themselves
questions, whether they are bored or disapprove of what he puts forward as ideas.
NB:
. During the completion of the final internship, the student is monitored and supervised by a
educational supervisor (of the ISET) and another industrialist, consequently all
complaint from one of these supervisors regarding the behavior of a student,
The absence from supervision sessions, the lack of progress on work... can lead to
automatically at the end of the internship.

. For a topic presented by a pair, the evaluation is by student (the two students
may have two different grades).
. The student must submit to the department secretary:
-03 copies of internship final reports, at least one of which is certified by
the company internship location,
a copy of the internship certificate,
A CD with a label identifying the PFE and containing an electronic copy
of the report.
. The student must adhere to the deadlines for submitting reports (which will be posted by the
department), otherwise it automatically leads to non-validation of the internship.

ISET Siliana 19 DGM

You might also like