‫‪Preparing Technical Reports‬‬

‫‪Writing‬‬
‫اﻟﻤﺤﺎﺿﺮة اﻟﺨﺎﻣﺴﺔ‬
‫ﻗواﻋد اﻟﻛﺗﺎﺑﺔ اﻟﻠﻐوﯾﺔ ﻟﻠﺗﻘﺎرﯾر اﻟﻔﻧﯾﺔ‬
 Report layout and format
 The layout of the technical report should be involves the following
items:
1. Standard A4 paper should be used or B5 paper in master degree and Ph.D.
2. Apply page design format.
3. Standard margins should be used (3 cm from left and 2.5cm from all sides).
4. Typing the report: you should use Times New Romans Font Size 12.
5. Using 1.5 spacing between lines, and leaving 2.5 space between paragraphs.
6. Giving headings (font size 16 Bold and all capital) and sub‐headings (Font
size 14 Bold, first letter capital in each word) for each section. Capitalizing and
using bold will make your headings stand out well. ‫ﺗﺒﺮز اﻟﻌﻨﺎوﯾﻦ ﺑﺸﻜﻞ ﺟﯿﺪ‬
7. Using a clear numbering system.
1. HEADING
1.1 Sub‐Heading.
8. Making clear diagrams which are both LABELED and LINKED to the text.
.‫ ﻗﻢ ﺑﻌﻤﻞ رﺳﻮﻣﺎت ﺑﯿﺎﻧﯿﺔ واﺿﺤﺔ ﻣﺼﻨﻔﺔ و ﻣﺮﺗﺒﻄﺔ ﺑﺎﻟﻨﺺ‬.8
9. The figure or picture caption title should be included under the figure or
picture while the Table caption should be on the top of it.
10. The report cover should be with the Project Title in the mid of the page. On
the top of the page, the University logo is located to the left while the Faculty Logo
is located to the right. At the bottom of the page, the year should be written in the
middle.
11. The first page of the project should include all of the previous data in the cover
page in addition to the name of your supervisor and project student team as
shown in the following template.
12. The report should be stapled and bounded (hardcover).
13. One of the most important things to remember now is, you are no longer at
school and that fancy colors and decorations ‫ اﻟﺪﯾﻜﻮرات‬are not recommended.
Page Numbering

• Number all the preliminary pages in lower-case

Roman numerals (i, ii, iii, iv,…..).

• Do not place the number (i) on the title page. Just

count it and put (i) on the second page of the report.

• Number all the remaining pages of the report with

Arabic numerals (1,2,3,4,…..). Thus the report
begins on page 1 with the Introduction.
Page Numbering
Decimal system: Alphanumeric system:
 ‫‪Write Sentences in Reports‬‬
‫اﺳﺗﺧدام اﻟﺟﻣل ﻓﻲ اﻟﺗﻘﺎرﯾر‪:‬‬
‫ﺟﻣل ﺑﺳﯾطﺔ وﺗﺎﻣﺔ اﻟﻣﻌﻧﻲ ﻣﺗﻛﺎﻣﻠﺔ ﻣﻊ ﻣﺎ ﻗﺑﻠﮭﺎ وﻣؤدﯾﺔ ﻟﻣﺎ ﺑﻌدھﺎ ﻓﻲ ﺗﺳﻠﺳل ﻣﻧطﻘﻲ‪.‬‬ ‫•‬
‫ﻣﺧﺗﺻرة واﺿﺣﺔ ﻻ ﺗﺣﺗوي ﻋﻠﻲ ﻛﻠﻣﺎت ﻏﯾر ﺿرورﯾﺔ وﺗﺟﻧب اﻟﺟﻣل اﻻﻋﺗراﺿﯾﺔ‪.‬‬ ‫•‬
‫ﺑﻌﯾده ﻋن ﻋﺑﺎرات اﻟﻣﺑﺎﻟﻐﺔ واﻟﺗﮭوﯾل وﺗﺟﻧب ﻛﺛرة اﺳﺗﺧدام اﻟﻣﺑﻧﻲ ﻟﻠﻣﺟﮭول‪.‬‬ ‫•‬
‫ﺻﺣﺔ ﻣﺎ ﺗﺣﺗوﯾﺔ ﻣن ارﻗﺎم واﺳﻣﺎء وﺗوارﯾﺦ‪.‬‬ ‫•‬
‫ﺗﻧﺎﺳب اﻟﻣﻠﺧص ﻣﻊ طول اﻟﺗﻘرﯾر اﻻﺻﻠﻲ‪.‬‬ ‫•‬
‫اﻟوﺣدة اﻟﻣوﺿوﻋﯾﺔ ﺑﯾن اﺟزاء اﻟﺗﻘرﯾر‪.‬‬ ‫•‬
‫اﻟﺗوازن اﻟﻧﺳﺑﻲ ﺑﯾن اﺟزاء اﻟﻔﻘرات ﻣن ﺣﯾث اﻟﺣﺟم واﻟﺗﻧﺎول‪.‬‬ ‫•‬
‫ﻋﺑﺎرات اﻟﺗﻘرﯾر ﻣﺗوﺳطﺔ اﻟطول‪.‬‬ ‫•‬
‫اﻟﻔﺎظ اﻟﻛﺗﺎﺑﺔ ﻓﺻﯾﺣﺔ ﺧﺎﻟﯾﺔ ﻣن اﻟﺗﻌﻘﯾد واﻟﻐﻣوض‪.‬‬ ‫•‬
‫‪ ‬دﻻﻻت اﻻﻟﻔﺎظ واﺿﺣﺔ وﺧﺎﺻﺔ اﻟﻣﺻطﻠﺣﺎت اﻟﻌﻠﻣﯾﺔ‪.‬‬
 Follow the general rules for writing ‫• اﺗﺒﺎع اﻟﻘﻮاﻋﺪ اﻟﻌﺎﻣﺔ ﻟﻠﻜﺘﺎﺑﺔ‬
 Follow grammar and grammar rules
‫• اﺗﺒﺎع ﻗﻮاﻋﺪ اﻟﻠﻐﺔ واﻟﻨﺤﻮ‬
 Follow orthography
‫• اﺗﺒﺎع ﻗﻮاﻋﺪ اﻻﻣﻼء‬
 Suitable writing style for the reader of the report
‫• ﻣﻨﺎﺳﺒﮫ اﺳﻠﻮب اﻟﻜﺘﺎﺑﺔ ﻟﻘﺎرئ اﻟﺘﻘﺮﯾﺮ‬
 Clarity of writing ‫• وﺿﻮح اﻟﻜﺘﺎﺑﺔ‬
 Sequence of subjects ‫• ﺗﺴﻠﺴﻞ اﻟﻤﻮﺿﻮﻋﺎت‬
 Adequacy of the addresses because of the information they contain

‫• ﻣﻨﺎﺳﺒﺔ اﻟﻌﻨﺎوﯾﻦ ﻟﻤﺎ ﺑﮭﺎ ﻣﻦ ﻣﻌﻠﻮﻣﺎت‬

 Correct use of information ‫• ﺻﺤﺔ اﺳﺘﺨﺪام اﻟﻤﻌﻠﻮﻣﺎت‬

 Correct writing of numbers ‫• ﺻﺤﺔ ﻛﺘﺎﺑﺔ اﻻﻋﺪاد‬
 The quality of the report's layout ‫• ﺟﻮدة اﻟﺸﻜﻞ اﻟﻌﺎم ﻟﻠﺘﻘﺮﯾﺮ‬
 Commas

Semicolons

Full stops

Colons

Question marks

Brackets

Exclamation marks

Speech marks
 Good Writing Mechanics :-
• Check Spelling.

• Check Grammar.

• Minimize the use of Acronyms.

• If Acronyms are necessary, always define them at the first use.

• Number all equations, tables, and figures.

• All tables and figures must have captions.

• All figures must have labeled axes.

• All quantities must have units.

 Writing :-
• Keep your paragraphs short.
• Less is better.
• Control the text width by using columns.
• Never use slang. ‫ﻻ ﺗﺴﺘﺨﺪم اﻟﻠﻐﺔ اﻟﻌﺎﻣﯿﺔ‬

• Provide only one way to do something within a step.

• Be precise with your instructions. ‫ﻛﻦ دﻗﯿﻘﺎ ﻣﻊ ﺗﻌﻠﯿﻤﺎﺗﻚ‬
 Writing (cont.)
• Use lists whenever possible.

• Use the title to define the task.

• Use headings and subheadings.

• Use warnings.

• Write a conclusion.

• Don’t annoy the reader.