The Technical Report

I. The Technical Report

l.1. Concept
1. Initial part
1.2.1. First and second cover page if
it is necessary.
1.2.2. Cover.
1.2.3. Summary.
1.2.4. Index.
1.2.5. Glossary.
1.2.6. Preface.
1.3. Body of the report:
1.3.1. Introduction.
1.3.2. Core of the report with illustrations and tables
1.3.3. Conclusions and recommendations.
Acknowledgments
1.3.5. Reference lists.
1.4. Final part.
1.4.1. Annexes:
1.4.2. Gratitude
References
The technical report.

I.1 Concept

A technical report is a written presentation of data or facts addressed to someone, regarding a matter, or to
what is advisable to do about it. It is, in other words, a document that describes the state of a problem.
scientific. It is usually prepared at the request of a person, a company, or an organization.

It is important not to confuse the technical report with the project, as they are not synonymous at all. Thus,
while the first document refers to a reality, which is a specific technical problem regarding
a specific question, the second work done is nothing more than a framework or a set of ideas and
plans for an action that is intended to be carried out and that, therefore, is not yet a reality.

Every technical report must have a structure consisting of the introductory part, the bodies of the report, the
annexes and the final part.

Next, we will get to know each of them.

I.2 Initial part

The initial part should include the cover (with the report title, its author, and the date), the title page, the summary, the
index, the glossary (with the signs, symbols, abbreviations, and technical terms used) and the preface (in case it is
necessary).

1.2.1. First and second cover page:

Cover or frontispiece.

It is the sheet that precedes the cover and the first printed odd page, on which only the title is presented.
work and the author summarized, and sometimes the collection or a summary before the beginning of the book. Originally it was a
protective sheet, as a cover. It is printed on the 'front' (front side) and sometimes it is utilized
the "verse" (back part for information, such as news or other books in the collection). Both pages go
not numbered, although the pagination may start on it.

Back cover

It is the page facing the cover (the back of the title page). It should not be confused with the back cover.
back cover or fourth of covers, which constitutes an element of the exterior of the book.

1.2.2. Cover
It must contain, at least: Identification of the organization (university, company, etc.)

Title (including subtitle if any). The title should be concise yet explanatory Example: Determination of
parameters of a three-phase induction machine. It should include important keywords to facilitate its
location in a bibliographic or informational system (for example, the words you would use to search for it)
If the report has several parts or volumes, all must share the title, although it may vary the
subtitle. The volume or part must be indicated following the title. If it is a new version of another report.
it must be indicated beforehand.

Author. Authors must appear with their full name. The order should be alphabetical if there is no
priority regarding the development of the report. If it is intended for a foreign audience, it is advisable to use only the
first surname or join both with a hyphen, to avoid confusion between middle name and surname

Date. The date should preferably be indicated in full. If written in numbers, the notation should be used.
according to ISO 8601 (YYYY-MM-DD

Other possible information: Identifier code.

Author's priority date (date when it was completed)

1.2.3. Summary
The summary should contain an abbreviated version of the entire report, occupying a space between 250 and 500.
words (about 10-15 lines)

It should normally occupy a single paragraph. The reader of the summary should get a clear idea about the object.
of the report, the methodology and the main results.

The summary should not include images, formulas, or references. It should be readable in a way
independent; it must include the keywords of the report (to facilitate searching and locating in systems
bibliographic or informatics

I.2.4. Index.

It is essential in a report, unless it is very short.

It must include the main sections of the body of the report and the appendices, with their numbering and the page.
in which it is located. If the document is long, it is also advisable to include a table of contents and another one for tables.
illustrations (figures).

Glossary

The glossary is a list of signs, symbols, units, abbreviations, acronyms, or terms used in the text.
and that are not immediately understandable to the reader, with their definition.

The glossary or glossaries (multiple lists can be included, for example, one for symbols and another for acronyms) is
includes after the index. The inclusion of the glossary does not prevent explaining the corresponding symbol or acronym.
first time it appears in the text.

1.2.6. Preface
It is used when one wants to highlight something about motivations or circumstances related to work. It is placed right
before the body of the report, although it is sometimes placed before the index or even the abstract.
1.3. Body of the Report

This part of the report includes:

1.3.1.Introduction: You should focus the field of work in its context, including aspects related to, by
example: Scope, relationship with other works or previous developments, objectives, typical information of the
preface (if this does not exist). It should not repeat phrases from the abstract, nor include issues related to the methodology.
results or conclusions.

1.3.2.Core of the report with illustrations and tables: The core of the report may vary depending on the type of
report, although in general it should include the following contents:
Methodology (materials and methods): It explains how the work that leads to the report has been carried out, but without
explain results. It helps another person to correctly interpret the results and/or repeat the
work or similar

Results: Equations, tables, and/or illustrations (figures) are used to show the results in the most
clear possible.

Discussion: The results are interpreted and compared with existing theory, the hypotheses proposed or
previous results existing in the literature. Sometimes it is joined with the results (results and discussion) and others
sometimes it is joined to the conclusions (discussion and conclusions).

1.3.3. Conclusions and/or recommendations.

The conclusions must be a clear, concise, and orderly reflection of the deductions reached based on the
work. They can include numerical results, but they should not include the arguments on which they are based (that
it should go in the results and/or the discussion).

The recommendations correspond to measures that should be taken based on the conclusions obtained and not
are necessary in all reports.

Acknowledgments (optional)

They are used to thank the people who are not listed as authors but have collaborated in some way.
Important, also the entities or individuals who have provided financial or material support for the work.

They should not be used to thank the authors of cited or consulted publications, as this goes against the
references section.

1.3.5. References.

A list of references must be included to indicate the data of previous works that are referenced.
expressed in the text of the report. These may be useful for the reader but are not cited in the text and can
go in an annex.

The references consist of three fields, in this order:

Author(s)
The reference list can be in alphabetical order or numbered in the order of citation in the text.
citation mode function.

1.4. Final part

1.4.1. Annexes
They include material that, due to its characteristics, should not be included in the body of the report. This is mentioned:

Lists or very long data tables that are not essential for understanding the report.

Information that may be omitted for most readers but may be useful for a specialist.
Information that, due to its origin, format, or characteristics, cannot be inserted into the normal body of the text.

Lists of computer programs.

Supplementary bibliography not cited in the text.

Long mathematical elaborations (formula demonstrations, calculations).

They are numbered with letters or Roman numerals: e.g., Annex A, Annex B, Annex I, Annex V.

The tables or figures included in the annexes do not follow the numbering of the body, but rather that of the annex.
corresponding.

1.4.2. Acknowledgments

The acknowledgments or recognitions. This is a very delicate point, especially if the technical report -
A scientific work is an exceptional job, a thesis, or a report of professional activity, which is where most
it is customary to use them. It is a gesture of courtesy to write a small note of thanks to the
people who directly helped in the work described in the report. The acknowledgments, in a paragraph
about five lines, they should go in the report after the title page and before the summary. If they
thesis, exceptional work, or report, will go after the signed authorization letter.

1.4.3. References.

The most important concepts of the work are added to them.

References to similar works.

References to the basic techniques used and/or results.

References to the work that is being extended (line of work).

It is important to remember that the references are not bibliographies with general information related to the content.
or specific documents whose content has been used.

Articles from magazines or books can be included, considering later the articles in conferences.
avoiding personal communications or technical reports if possible.
1.3.4 not working