GUIDELINES FOR EFFECTIVE TECHNICAL REPORT

8/7/2019 GUIDELINES FOR EFFECTIVE TECHNICAL REPORT

1/21

GUIDELINES FOR EFFECTIVE TECHNICAL

REPORT

1-INTRODUCTIONYour 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.

2-DEADLINE FOR PRELIMINARY REPORT ( BEFORE THEFINAL DISCUSSION)

Two copies the preliminary report should be applied with soft cover at least

one week before the date, determined by the department; of the final discussion.

3- DEADLINE FOR FINAL REPORT ( AFTER THE FINALDISCUSSION)

The student should handle, within three days after the final discussion; the

following:

i) Five hardcover copies of the final report after performing the required

modifications given by the referees.

ii) One CD containing:

a- all the contents of the final revised report, including the figures,b-all the contents of the final revised report as a PDF file.

iii) if the project includes an establishment of Web site on the internet

(web/ftp-site); the report should include the URL that indicates to the

Web site.

1


2/21

4-MAIN FEATURES OF THE REPORTa- 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 documentsessential 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 bottomones 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.

5- ENGLISH LANGUAGE USAGE

Your sentences need to be as short, comprehensive and direct aspossible.

Provide accurate information and present your material logically. Avoid using the expressions with I did this, then I did that and use

instead the passive voice, such as This was done, then it was

performed.

Make your ideas accessible, i.e. without even reading a word, we canlook at the pages of the report and get a good idea of how efficiently

the material is presented.

Try to prepare your ABSTRACT in a direct way.

2


3/21

An accurate proof reading and grammar checking of the report shouldbe performed through one of the word processing programs.

When using a word, such as Figure at the beginning of a sentence, itshould 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- BODY OF THE REPORT

The report should contain the following parts:

COVER ACKNOWLEDGEMENT ABSTRACT LIST OF ABBREVIATIONS LIST OF SYMBOLS CONTENTS REPORT LAYOUT CONCLUSIONS AND TRENDS FOR FUTURE STUDIES. REFERENCES APPENDICES

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


4/21

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.4LIST OF ABBREVIATIONS

It contains a full description of all the abbreviations contained through the

report, see App. 3.

6.5LIST OF SYMBOLS

It contains a full description of all the symbols contained through the report,

see App. 4.

6.6CONTENTS

It contains all parts of the report in the form given in App. 5.

6.7REPORT LAYOUT

It consists of the different chapters of the report in the following form:

a- CHAPTER 1

INTRODUCTION

It starts with a brief description about the aim of the project, followed by a

brief description, just in few lines; of each chapter in the report.

No obtained results are to be mentioned in this chapter, but just a

description of what was performed.

Through out this chapter, the present tense is to be used, such as Chapter 2

gives a description of

4


5/21

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 maybe:

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 4RESULTS

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


6/21

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].

In case of copying a part of a reference, its number should be mentioned in

the text; otherwise it is considered as a part of your work. Of course, this is

illegal.

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/21

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:

Figure 2.1 shows a simple block diagram of the speech communications

process using a speech coding system [4].

All of the primary elements in a digital speech coding system are illustrated in

Fig. 2.2.

Figures are to be put in the following way:

Concept Language Vocal trace Sound

Coder Channel Decoder

Sound Ear Language Concept

Fig. 2.1 Speech communications process

Avoid mentioning a figure without giving a description.

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


8/21

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:

=+=

= p1j

)jk(y)j(bq

0i

)ik(N)i(a)k(y (3.8)

8


9/21

))1

UMM AL-QURAH UNIVERSITY

FACULTY OF ENGINEERING

DEPARTMENT OF COMPUTER ENGINEERING

Predicting Electronic Devices Response

At Radiation Environments

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


10/21

))2

/

2004

10


11/21

))3

LIST OF ABBREVIATIONS

BJT : Bipolar junction transistor,

CBO : Collector to base with emitter open,

CEO : Collector to emitter with base open,

CPU : Center processing unit,

DUT : Device under test,

FFT : Fast Fourier Transform,

H.C : Hybrid combination,

KCL : Kirchhoffs current law,

KRAD : Radiation composite damage constant,

LTDM : Level tunnel diode multivibrator,

PM : Programmable meter,

RAD : Radiation flounce or dose,

T. D : Tunnel diode,

T. S : Transistor switch.

.

11


12/21

))4

LIST OF SYMBOLS

S(t) : Input continuous speech signal

S(k) : Digital speech signal

: The synthetic digital speech signal(k)S

(t)S : The analog synthetic speech signal

TS : The sampling period

FS : The sampling rate

B : The number of bits per sample

I : The transmission bit -rate

(k)SQ : The quantized signal

(k)SC : The transmitted encoded signal

(k)SC

: The received encoded signal

(k)SQ : The received decoded signal

: The signal energy2S

2q : The quantization noise energy

M : Number of points in the signal

Lq : The quantization levels

: The quantization step size

q(k) : The quantization error

: The maximum signal amplitude beyond which the

. . Signal is clipped

SMAX

N(k) : Tap input

w(n) : Weight

12


13/21

))5CONTENTS

Acknowledgement

Abstract

List of Abbreviations

List of Symbols

Chapter 1 Introduction

1.1. Switching Characteristics

1.2. Radiation Effects on Transistor Systems1.3. Present Work

Chapter 2 Experimental Apparatus and Procedures

2.1. Experimental apparatus

2.2. Gamma Irradiators

2.3. Experimental Procedures

2.3.1. Static Characteristics2.3.2. Dynamic characteristics

2.3.3. Temperature Effects on the Transistor Characteristics

2.4. Gamma Radiation Irradiation

2.5. Radiation Defects Modification

Chapter 3 Static and Dynamic Characteristics

3.1. Theory of Bipolar Transistor Operation3.1.1. DC-characteristics

3.2. Device Capacities

3.3. Dynamic Characteristics

3.4. Tunnel Diode

3.5. Experimental Results

3.5.1. Static Characteristics

3.5.2. C-V Characteristics

3.5.3. Dynamic Characteristics

13


14/21

))6

REFERENCES

1. Zhixiong-Xiao, et al., Analysis of the High Injection Effects in Silicon

Bipolar Transistors at Low Temperatures , Solid State Electronics, Vol. 38,

No. 8, PP. 1455-1460, Aug. 1995.

2. S.A.Kamh and F.A.S. Soliman, Computer Analysis of Microwave

Distributed Amplifiers Using Tunnel Diodes , International AMSE, France,

Vol. 2, PP. 413-418, Sept. 1996.3. B.L. Theraja and A.K. Theraja, Electrical Technology , Publication

Division of Nirja Construction and Development Co., Indian, 1993.

4. Zheng-Jiang, et al., New Relation between Current Gain and Doping

Concentration in the Emitters of Silicon Bipolar Transistors at Low

Temperatures , Int-J-Electron, Vol. 69, No. 3, PP. 339-344, Sep. 1990.

5. Jenkins-Keith-A, Frequency Response of Advanced Silicon Bipolar

Transistors at Low Temperature , IEEE Trans. Electron Devices, Vol. 37,

No. 10, PP. 2243-2249, Oct. 1990.

6. Karlsteen-M; Willander-M, Total Switch Time of Silicon Bipolar

Transistors with Base Doping Gradients or with Germanium Gradients in the

Base , Solid State Electronics, Vol. 36, No. 11, PP. 1571-1578, Nov. 1993.

7. Zheng-Jiang; et al., Silicon Bipolar Transistors with Low Temperature

Coefficient Current Gain , Electronica-Sinica, Vol. 22, No. 5, PP. 61-67,

May 1994.

8. Kang-Bao-Wei; Wu-Yu, Ultra-Fast Power Switching Bipolar Transistors ,

IEEE, Piscataway, NJ, USA, Vol. 1, PP. 387-390, 1995.

9. Lazarus-MJ, Improvement in the Switch Time of Bipolar Transistors

with Profiled Base Current Drive , Solid State Electronics, Vol. 38, No. 2,

PP. 351-355, Feb. 1995.

14


15/21

))7

Table 3.4Comparison between the noise interference canceling, and the

. prediction, model used in speech signal:

Interference canceling

model

Prediction

model

Design of

filter

Requires that the signal andthe noise be stationary and

that the statistics of both.

signals be known a priori

Not requires that the signal and

the noise be stationary and this

technique has the advantage of

requiring no a priori.

knowledge of the detailed

properties of the noise signals.

Sensor Requires two sensors. Depend only on one sensor.

Nature of signalDepend on all nature of the

signal.

Depend only on the quasi-

periodic nature of the speech.

Degree of noiseWorking well with highdegree of noise.

Working well with low degreeof noise.

15


16/21

GUIDELINES FOR WRITING EFFECTIVE

ENGLISH

1. ENGLISH LANGUAGE USAGE

Your sentences need to be as short, comprehensive and direct aspossible.

Provide accurate information and present your material logically. Avoid using the expressions with I did this, then I did that and use

instead the passive voice, such as This was done, then it was

performed.

Make your ideas accessible, i.e. without even reading a word, we canlook at the pages of the report and get a good idea of how efficiently

the material is presented.

Try to prepare your ABSTRACT in a direct way. 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, itshould 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.

2. PUNCTUATION

The following suggestions are offered on the most common problems many

engineers tend to have with punctuation.

2.1 Commas (,)

a- Omitting a comma after introductory words or phrases in a sentence will

16


17/21

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.

b- Commas are useful when a pause is needed.

Fresnels equations determine the reflectance transmittance phase and

polarization of a light beam at any angle of incidence.

Solution

Fresnels equations determine the reflectance, transmittance, phase, and

polarization of a light beam at any angle of incidence.

c- A serial commas may also prevent confusion.

Ahmed Aly Mohammed Badr build the best turbines for our purposes.

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.

b- If your parenthetical material forms a complete sentence, put the period

inside the marks.

17


18/21

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).

2.3 Dashes (-)

a- A dash will make a sentence seem more emphatic by calling attention to

the word set aside or after it.

He was tall, handsome, rich and stupid.

Solution

He was tall, handsome, rich-and stupid.

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


19/21

My opinion-whether you want to hear it or not-is that the drill does not meet

the specifications promised by our supplier.

2.3 Colons (:)

The most common use of the colon within a sentence is to introduce an

informal list.

One of the books recommended for the seminar is The Limit of Safety:

Organization, Accidents, and Nuclear Weapons.

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.

2.5 Semicolon (;)

a- The relation between statements could be better stressed by using a

semicolon:

Take Professor Majeds class. You will find he is a great teacher.

Solution

Take Professor Majeds class; you will find he is a great teacher.

19


20/21

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.

2.6 Quotation Marks

Use quotation marks to set off direct quotations in your text.

We had heard about the four-star marketing plan, but no one remembered what it

involved.

Solution

We had heard about the Four-Star Marketing Plan, but no one remembered

what it involved.

20


21/21

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

The main features of the slides are:

Each slide contains at most eight lines Font should be big, like 18 Pt or more to be easy to read Sentences should be as short as possible and the student gives the full

description of each

Figures, with a brief description; are to be put in a slide in a way to beeasy to follow

Some software like POWER POINT can be used to prepare slides. The

student can use a DATA SHOW for his presentation.

Documents

GUIDELINES FOR EFFECTIVE TECHNICAL REPORT