Guidelines For Effective Technical Report
Guidelines For Effective Technical Report
REPORT
1- INTRODUCTION
Your B.Sc. graduation project is one of the main documents needed when
applying either for a job or for post graduation registration. So, it can give the
first impression about your character. Although different people approach
writing tasks in somewhat different ways, these guidelines follow in general the
overall process used by successful engineering writers.
1
4- MAIN FEATURES OF THE REPORT
a- Number of pages should be around fifty pages.
b- English is the only accepted written language, except both the cover and
abstract that should be submitted in English and Arabic languages.
c- Not only should your language be easy to access your document’s
essential message, but all your information should also be in the right
place.
d- Page setup : 1- right and left margins are 2.5 cm, while top and bottom
ones are 3 cm.
2- page numbering is to be at the bottom center of the page,
starting from the introduction, in 1, 2, 3, …… form,
while those before the contents are to take the lowercase
Roman numerals (i, ii, iii, iv, …..).
e- Avoid use more than 2 subtitles. So 3.1.3 is acceptable, but 3.1.2.4 is not
acceptable.
2
• An accurate proof reading and grammar checking of the report should
be performed through one of the word processing programs.
• When using a word, such as Figure at the beginning of a sentence, it
should be written without any abbreviations. The word can be
abbreviated if: i) it comes in the text except at the beginning, ii) it titles
a figure.
6.1 COVER
Both Arabic and English versions of the cover should be prepared, see App. 1
and 2. The first and second are to be put at the right and left sides of the report,
respectively.
6.2 ACKNOWLEDGEMENT
In this part, the student expresses all his emotions forward those who helped
him through performing the project. Of course, it should be prepared in English.
3
6.3 ABSTRACT
This part should present a brief description of the project with the obtained
results. Besides, it should give an idea about how to make use of the project
practically. This abstract should be prepared both in Arabic and English
languages, and put on both side of the report after the cover.
6.6 CONTENTS
It contains all parts of the report in the form given in App. 5.
4
b- CHAPTER 2
(Suitable title)
This chapter can be titled in any way according to the main objective of
the project. It should include a historical background of the project, i.e.
what was mentioned in the literature with the required references, in the
form mentioned in part 8.6 of this document. This chapter may be split
into two chapters instead of one, according to requirements of this
background.
Past tense is only used through out this chapter.
c- CHAPTER 3
(Method)
This chapter includes a full description of the method or what was
performed through out the project, beside the figures. The method may
be:
• A theoretical part in the form of mathematical analysis and proofs.
• An experimental part.
• Software programming.
• Modeling and simulation using CAD.
Only the present tense is used through out this chapter.
d- CHAPTER 4
RESULTS
All the obtained results are to be mentioned with suitable explanation;
sometimes those results are compared with previous documented results.
All figures should be given a description.
Only present tense is used in this chapter.
5
e- CHAPTER 5
CONCLUSIONS AND TRENDS FOR FUTURE STUDIES
This chapter consists of two parts. The first includes the conclusions of
the project; mentioning whether or not they adapt with the main
objective of the project. Besides, the difficulties and withdrawals you
faced throughout the work. As an extension of the project, the second
part includes the trends for future work. Of course it is much better to
suggest some improvements that are useful for the future work.
6.8 REFERENCES
A list of references is to be given at the end of the report, see App. (6).
Throughout the text, reference number is to be put between two square brackets,
[]; such as the following example:
In 1997, Paul Horowitz and W. Hill also reported that the transistor is the
essential ingredient of every electronic circuit, from the simplest amplifier or
oscillator to the most elaborate digital computer [13].
6.9 APPENDICES
In this part, all the appendices, such as tables and software programs that have
been used throughout the project; are to be put.
This part is attached at the end of the report and should be mentioned
throughout the report according to its sequence, in the form like this: App. (3).
6
7- FIGURES
Figures should be put in the report in its proper place in the text. If a figure or
so is taken from a reference, its number should be mentioned, like that:
8- TABLES
Tables should be placed in their proper position in the text according to their
sequence, like this: Table 3.4, see App. (7).
7
9- EQUATIONS
The number of the equation in the text is to be put like this:
At optimum setting of the coefficients, Eq. (3.8) can be written as:
q p
y (k ) = ∑ a(i )N(k − i ) + ∑ b( j)y (k − j) (3.8)
i=0 j=1
8
(1) ﻣﻠﺤﻖ رﻗﻢ
Project Report
Submitted for the award of the B. Sc degree
in Computer Engineering
By
ASHRAF MOSLEH OSMAN
Supervised by
Prof. Dr. KADRY I. MONTASSER
2004
9
ﻣﻠﺤﻖ رﻗﻢ )(2
ﺟﺎﻣﻌﺔ أم اﻟﻘﺮي
آﻠﻴﺔ اﻟﻬﻨﺪﺳﺔ واﻟﻌﻤﺎرة اﻹﺳﻼﻣﻴﺔ
ﻗﺴﻢ هﻨﺪﺳﺔ اﻟﺤﺎﺳﺐ اﻵﻟﻰ
ﺗﻘﺮﻳﺮ ﻣﺸﺮوع
ﻣﻘﺪم ﻟﻠﺤﺼﻮل ﻋﻠﻰ درﺟﺔ اﻟﺒﻜﺎﻟﻮرﻳﻮس ﻓﻰ هﻨﺪﺳﺔ اﻟﺤﺎﺳﺐ اﻵﻟﻰ
ﻣﻘﺪﻣﺔ ﻣﻦ
أﺷﺮف ﻣﺼﻠﺢ ﻋﺜﻤﺎن
اﻹﺷﺮاف
اﻷﺳﺘﺎذ اﻟﺪآﺘﻮر/ﻗﺪرى إﺑﺮاهﻴﻢ ﻣﺤﻤﺪ ﻣﻨﺘﺼﺮ
2004
10
(3) ﻣﻠﺤﻖ رﻗﻢ
LIST OF ABBREVIATIONS
11
(4) ﻣﻠﺤﻖ رﻗﻢ
LIST OF SYMBOLS
12
(5) ﻣﻠﺤﻖ رﻗﻢ
CONTENTS
Acknowledgement
Abstract
List of Abbreviations
List of Symbols
Chapter 1 Introduction
1.1. Switching Characteristics
1.2. Radiation Effects on Transistor Systems
1.3. Present Work
13
(6) ﻣﻠﺤﻖ رﻗﻢ
REFERENCES
14
(7) ﻣﻠﺤﻖ رﻗﻢ
Table 3.4 Comparison between the noise interference canceling, and the
. prediction, model used in speech signal:
Interference canceling Prediction
model model
15
GUIDELINES FOR WRITING EFFECTIVE
ENGLISH
2. PUNCTUATION
The following suggestions are offered on the most common problems many
engineers tend to have with punctuation.
16
cause your reader to be shortly confused.
If an acoustic horn has higher throat impedance within a certain frequency
range it will act as a filter in that range which is undesirable.
Solution
If an acoustic horn has higher throat impedance within a certain frequency
range, it will act as a filter in that range, which is undesirable.
Solution
Fresnel’s equations determine the reflectance, transmittance, phase, and
polarization of a light beam at any angle of incidence.
Solution
Ahmed, Aly, Mohammed, and Badr build the best turbines for our purposes.
2.2 Parentheses ( )
a- Parentheses are used to set off facts or references in your writing.
This reference book published in 1993 contains up-to-date information.
Solution
This reference book (published in 1993) contains up-to-date information.
17
Typical indoor levels radon average 1.5 Pico curies per liter a measure of
radioactivity per unit volume of air.
Solution
Typical indoor levels radon average 1.5 Pico curies per liter (a measure of
radioactivity per unit volume of air).
b- Emphasis
Staying up all night to finish a lab project is not so terrible once in a while.
Solution
Staying up all night to finish a lab project is not so terrible-once in a while.
c- Summary
Reading all warnings, wearing safety glasses and hand hats, and avoiding hot
materials all these practices are crucial to sensible workshop procedure.
Solution
Reading all warnings, wearing safety glasses and hand hats, and avoiding hot
materials-all these practices are crucial to sensible workshop procedure.
d- Insertion
My opinion whether you want to hear it or not is that the drill does not meet
the specifications promised by our supplier.
Solution
18
My opinion-whether you want to hear it or not-is that the drill does not meet
the specifications promised by our supplier.
2.4 Hyphens
Hyphens have been called the most underused punctuation marks in
technical writing. Omitting them can sometimes create real noise.
We used a 16 keypad. Solution We used a 16-key keypad.
Research showed the computer aided students improved their grades
dramatically.
Solution
Research showed the computer-aided students improved their grades
dramatically.
19
b- Use semicolons to separate a series of short statements lists in a sentence
if any one of the statements contains internal punctuation. The semicolon
will then divide the larger elements.
I suggest you choose one social science subject such as psychology or
philosophy one natural science course such as chemistry, physics, or biology
and one math class.
Solution
I suggest you choose one social science subject, such as psychology or
philosophy; one natural science course such as chemistry, physics, or
biology; and one math class.
20
GUIDELINES FOR PREPARING YOUR
PRESENTATION
Prepare not more than eight slides. Presentation of each slide is to take not
more than three minutes. Description of slides should be in short sentences.
Slides are to take the form:
• One like that of the cover
• Another containing the steps of the presentation
• Five containing the PROJECT LAYOUT
• The last contains CONCLUSIONS AND TRENDS FOR FUTURE
STUDIES
Some software like POWER POINT can be used to prepare slides. The
student can use a DATA SHOW for his presentation.
21