Professional Documents
Culture Documents
Writing Technical Reports
Writing Technical Reports
Writing Technical Reports
The main elements of the reports differ according to the size of the report and
the requirements of the institution for which the research is submitted. The
main elements of long reports (consisting of dozens or hundreds of pages) are:
title, abstract, introduction, list of contents, list of figures, list of tables,
explanation of abbreviations and symbols, introduction, heart of the report -
the main content of the report - conclusions, recommendations, references,
and appendices. .
Use of templates in writing reports:
Most institutions keep ready-made forms (prepared previously) and the report
preparer fills in the necessary data, but this does not guarantee that the report
will be good unless the report preparer is fully aware of the data and
information that the report prepares and also has sufficient experience in
preparing reports. Therefore, the preparer of these forms is required Reports:
• To be familiar with and understand that data and information
• To be familiar with the techniques of writing a good report.
• He has the ability to update these models and build new ones.
Types of reports:
Reports can be divided into groups in terms of:
1. Release time.
2. The aim of the report.
3. Report content.
4. Report format.
5. The entity to which the report is addressed.
6. The approach followed by the report.
The design of one report may differ from
another according to the nature and length of
the report, as well as the design of the report
may differ from one institution to another and
• We must realize that we are writing for people like us who have tendencies, feelings and interests
• their needs. their interests. and their knowledge of the subject.
• The written material must be supported by facts related to the reader's degree of knowledge of
the topic.
• The report preparer may need to present the report before the person who requested the report
or before a specific committee, and then take into account:
Use a number of appropriate means to convey information to others.
Identify the mindsets of recipients of information so that they can present the report effectively.
3. Content
arrangement
Arranging ideas
Logical sequence
Divide the topic into paragraphs
Each paragraph has a specific idea
Each paragraph is divided into useful sentences
To make it easier for the reader to understand the
sentence, the sentence should be short and useful
In the case of using a long sentence, punctuation marks
such as periods and commas, for example, must be used
properly.
Paying attention to the objective and formal aspects of the
report, including:
Formal aspects: paper used, margins and spaces, fonts.
Objective aspect: clarity, accuracy, brevity, courtesy,
impartiality.
Skill in writing a
report
parts of the
report
Title Summ table Prepar the Body Report Recom the Accom
cover ary of atory introd of the conclu menda review panim
page
conten lists uction report sions tions er ents
ts List of
format
s
List of
tables
Symbol
s list
cover
The title page is the first page of the report or research page, and this
page enables us to know basic information about the report or
research quickly.
College of Engineering
Department of Architecture
Preparation
The summary of the technical report (or abstract) should include a brief
overview of the investigation, findings and recommendations. It should
include all the key information the reader needs to make a decision,
without having to read your entire report. Don't treat your summary as
an introduction; It should serve as a standalone document.
SUMMARY
This report explains what green and
sustainable buildings are and their importance
in creating models that protect the
environment and adapt them to the
environment in terms of energy and resource
use.
table of contents
The table of contents is a table that shows the page number on which
each section of the report begins so that it is easy to access specific
sections directly.
table of contents
the introduction 1
Description of sustainable buildings 2
The importance of sustainable buildings 6
green building properties 10
sustainable building goals 15
sustainable buildings in Jordan 20
List of formats
• When the report contains a large List of Figures
number of figures (five or more), it is Fig. 1.1: Schematic drawing of two phase flow 2
Page
• The list of figures is similar to the Fig. 2.3: Comparison of Theoretical and experimental results 22
THE LARGEST PART OF THE SCIENTIFIC RESEARCH: WORK REPORTS THAT SHOW WORK REPORTS THAT WORK REPORTS SHOWING
REPORT AND INCLUDES THEORETICAL BACKGROUND WHAT WAS DONE TO SOLVE A SUGGEST CHANGING A PRODUCTIVITY ARE BROKEN
SEVERAL ELEMENTS THAT VARY AND PREVIOUS RESEARCH - PROBLEM: EXPLAINING THE PROCESS: EXPLAINING THE DOWN BY PRODUCT.
ACCORDING TO THE NATURE STUDY METHOD - RESULTS, PROBLEM IN DETAIL - THE CURRENT SITUATION -
OF THE REPORT OR RESEARCH. ANALYSIS AND DISCUSSION. STEPS THAT WERE FOLLOWED - EXPLAINING THE PROPOSED
THE RESULTS AND SITUATION - COMPARING THE
SIGNIFICANCE OF THESE STEPS. CURRENT SITUATION WITH THE
PROPOSED SITUATION.
background in reports
Background gives the reader the information needed to understand the report. Puts the reader into
focus by providing background and perspective. The background is also used to link the report to
previous work.
Results
The results and what they contain of words, tables and figures. It includes comparing the
actual results with the theory, and analyzing the sources of error in the experimental
method.
Write the results in the present tense
Conclusions
From this we conclude, regarding the materials used in construction:
The use of recyclable and reusable building materials, such as aluminum and iron, with dimensions
Standard, which ensures ease of assembly and then ease of dismantling if necessary and redoing
Use or recycle them, to reduce the negative impact of these materials on the environment.
The use of natural building materials produced locally to avoid the use of large energy in
transporting them
To the minimum possible manufacturing processes.
Using building materials that are close or similar in their durability to reduce the energy consumed
in
Maintenance operations over the life of the building
Conclusions and recommendations:
• The most important results, conclusions and recommendations of the
research.
• Recommendations include making suggestions for future research.
• To follow up and complete the study of the problem or any other
research of high priority in the field of research.
• Suggestions for how to benefit from the results of the study.
Recommendations
Based on the results of the study, we suggest the following
• The necessity of adopting the principles of sustainability in urbanism as a solution to problems
that the buildings suffer from
• Orienting the buildings deliberately with the movement of the sun and the wind so that the longitudinal axis of the
building is in a north direction
South to avoid the summer sun and gain
Most of it in the winter.
the reviewer:
References
Acknowledge all information and ideas 1. R. Hartunian and W. Sears, “On the instability of gas bubbles
moving in liquids,” J. Fluid Mech., Vol. 3, pp. 27-47, 1957.
you have incorporated from other 2. G. Levich, Phsico-Chemical Hydrodynamics, Prentice-Hall,
sources into your paper using a Englewood Cliffs, N. J., 1962.
3. D. Moore, “The boundary layer on a spherical bubble,” J.
consistent referential style. This Fluid Mech., Vol. 16, pp. 161-176, 1963.
includes data, tables, and figures. 4. D. Moore, “The velocity of rise of distorted gas bubbles in a
liquid of medium viscosity ,” J. Fluid Mech., Vol. 23, pp. 749-
766, 1965.
5. P. Saffman, “On the rise of medium air bubbles in water,” J.
Fluid Mech., Vol. 1, pp. 249-275, 1956.
Supplement:
If you have data that is too detailed or long to include in the report itself, include it in the appendix.
The reader can then choose to refer to it if interested. Label your appendix with a number or letter,
a title, and refer to it in text, eg. For a complete list of construction stages, see Appendix A.
Commandments for
writing an effective
report