Technical Report Model
Uploaded by
ScribdTranslationsTechnical Report Model
Uploaded by
ScribdTranslations1.
Definition of Technical Report
The concept of report, as derived from the verb to inform, is the oral or
written, about the characteristics and circumstances of an event or matter. It is about
other words, of the action and effect of informing (to report). In writing, a report
it is the document characterized by containing information that reflects the result
of an investigation or a work, adapted to the context of a situation
determined. Generally, the purpose of the report is, obviously, to inform. Of
In any case, these writings may include persuasive elements, such as
recommendations or suggestions. Thetechnical reportit is the written presentation of
the circumstances observed in the examination of the issue being considered, with
detailed explanations that certify what has been said. In other words, it is a text
expository and argumentative, through which information is transmitted about
executed on a certain topic and specific time, or what is advisable to do with it;
they are generally addressed to a recipient who, usually, will have to make a
decision regarding the topic discussed in the text.
Generally, the data obtained from an experiment is summarized in reports.
technical notes should be written in an impersonal way, so they should be avoided.
personal pronouns. The report should be written assuming that the reader,
whoever this may be, is not familiar with the topic at hand; in this way the
The report will be understandable by itself.
The technical report has the following characteristics:
It is short but complete (concise).
Contains only what is necessary.
It is simple and written correctly, without repetitions and without redundancies.
It contains interesting and relevant information.
It is well ordered, structured, and organized.
It is nice to read illustrations, photographs.
It is organized and structured.
2. Structure of the Report
The correct structure of a technical report is essential for it to be able to
to be understood clearly; this way a clear writing is guaranteed.
objective, this is how one should use concrete and concise phrases, without losing sight
the objectives of the work. The total length of the Report should be between 3 and 8
pages, including figures and references.
The structure must be composed of at least the following parts:
a) Presentation
b) Introduction
c) Development/Findings/Results
d) Conclusions and Recommendations
e) Annexes
Presentation: The presentation of a report consists of the cover and the
index or table of contents; the basic elements are described below
consider these aspects in the writing:
Cover: It is the first page of the report and allows for the identification of the document.
which consists of the title of the report, the name of the author and/or authors, the date on which it is
The title of the report comes from the general objective of the technical report.
It is the first contact of the reader with the work that is offered to him, and for that reason, the cover
it must contain in a few words the necessary and sufficient information to leave in
Of course, what the text refers to and engaging him in reading.
Index or Table of Contents: List the main titles and the page on which they appear
each of them. List the subtitles under their corresponding main title.
The importance of this section lies in that it provides a framework for the report; the
the reader will immediately know where to look for what interests him.
Introduction: This part of the report briefly presents a description of
what the respective report is about, with the purpose of situating the reader and offering a
framework.
Background: It is the contextualization that will serve for the reader to have
knowledge of what the respective report is about, what kind of facts are desired
clarify?, since when does it occur?, how do they affect reality?, etc.
Period covered and where it was conducted: Every technical report must explain
briefly the period that encompasses the topic presented in said report, followed by
from the place where the conducted research took place.
General Objective: The objectives are the purposes of the work, they express the end that
it aims to be achieved and therefore all the work will be directed towards achieving that objective. The
The general objective is the main guideline to follow within the process that is to be investigated,
to study, demonstrate or know. The steps that lead us to achieve it are the objectives.
specific.
Specific Objectives: They express how the general objective is intended to be achieved.
other words are the steps that lead us to its achievement. Furthermore, they operationalize it and
they tell us how each one provides separately, a percentage of the overall objective,
until it is completed one hundred percent. For the drafting of the objectives, the following will be taken into account
take into account the following:
Be directed at the basic elements of the problem under study.
Be measurable and observable
Be clear and precise
Expressing oneself through an infinitive verb (e.g. Implement)
It is recommended that the report have a maximum of three specific objectives for
achieve the general objective, otherwise these objectives will tend to
to confuse oneself with goals.
EXAMPLES OF SPECIFIC OBJECTIVES
They respond to the question How?
SPECIFIC OBJECTIVE No. 1:Define the scope of infection on the server of
email.
SPECIFIC OBJECTIVE N° 2: Analyze the way the X virus spreads.
SPECIFIC OBJECTIVE NO. 3: Quantify the infected email accounts.
Scope: Corresponds to the area of work, that is, the field of application of which
the information was extracted.
Problem and its justification: they indicate the reasons that give rise to the need for
to investigate (as an introduction) such a topic; the problem is stated and justified
need to conduct the research, indicating its feasibility and its probable duration.
Development/Findings/Results: This section of the report presents the results
of the analysis and evaluation of the specific reality. It can be divided into two sections:
Methodology used: The methodology used section details step by
I pass the work procedure used.
a) Nature of the project
b) Time management, resource management, and activity scheduling.
c) Information collection procedure.
d) Techniques used for data processing and interpretation of the
information.
Presentation of Findings and Results: Presentation of Findings and
Results: Once the methodology followed is outlined, it will be presented in a
in an orderly manner the results obtained from the analysis in question. The titles of the
chapters of this section will match each of the specific objectives
cited and will be developed with the findings and results obtained.
Each chapter will be assigned a title whose name is created through the
removal of the infinitive verb with which each of the specific objectives begins.
Figures, graphs, photos, and diagrams must have a number and title, placed in
the bottom part of them. The frames must also have a number and title,
placed at the top. Refer to the examples of specific objectives
previously cited, to understand the chapter titles of the findings and
results that must be developed:
EXAMPLE OF FINDINGS AND RESULTS
Title No. 1: SCOPE OF INFECTION IN THE EMAIL SERVER
Virus X has infected the following points on the email server:
20% infection of the server's Registry file.
b. 20% operating system infection.
c. 20% RAM memory infection
d.X amount of backdoors
Title No. 2: METHOD OF PROPAGATION OF VIRUS X
The X virus spreads through the execution of a '.Exe' file attached in emails whose title
"Miss photos".
Title No. 3: NUMBER OF INFECTED EMAIL ACCOUNTS
X infected email accounts were found in a count at 9 o'clock in the day
February 15.
The collected data and the statistical treatment are generally presented.
practice. In the first instance, the main idea that points out is briefly described
results or discoveries and then the results are reported. In the presentation of
findings and results can use tables, graphs, and illustrations with the
the purpose of making the report much more comprehensive and more appealing.
Conclusions: They are the essence of the report and must be clear and precise; they are no more
that the results are presented in a consecutive and emphatic manner. A conclusion reveals
the relationships between the various findings–if there were several– and deduces the effects of
its importance. This section should note whether the general objective was achieved and
if each of the specific objectives achieved its purpose, regarding
operationalize the general objective. The concluding points of a
clearly, concretely, and precisely. They must be presented in the same logical order as
developed the work.
Recommendations: Recommendations are exhortations or suggestions that
the technician offers once the results of the work have been presented and that
clearly states that certain actions must be taken to prevent the risk, the
opportunity, advantage, relevance, necessity, convenience or urgency,
among others.
Attachments: The attachments are considered separately from the final part, because
Although they are not always required, they can be an essential part of some reports.
The annexes are used to present material that:
a) It is necessary to complete the text, but if inserted into the body of the
report, can alter the orderly and logical presentation of the work.
b) It may be omitted for the ordinary reader, but it can be valuable for the
subject matter expert.