4. Structure of a technical Report

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 47

1.

5 Structure of Technical documents


( Reports and thesis)

1.5.1 Reports
1.5.2 Thesis
1.5.1 Reports
Report

* Report?

4/4/2024 3
Experimental report
* What is an experimental report?
Definition and traits Main outline
1. TITLE PAGE
Experimental reports (also known as
2. CRAFTING YOUR STORY
"lab reports") are reports of empirical
• What is the story you would like to tell?
research conducted by their authors.
• What literature do you use to tell that
You should think of an experimental
story?
report as a "story" of your research in
• How do your results tell the story?
which you lead your readers through
• How can you discuss the story in broad
your experiment. As you are telling this
terms?
story, you are crafting an argument
3. ABSTRACT
about both the validity and reliability of
4. INTRODUCTION
your research, what your results mean,
5. METHODOLOGY
and how they fit into other previous
6. RESULTS AND DISCUSSIONS
works?
7. CONCLUSIONS
4/4/2024 https://owl.purdue.edu/
8. REFERENCES 4
Experimental report
* An example
of a short
experimental
report

4/4/2024 5
Experimental report
* An example of a long experimental report

4/4/2024 6
Experimental report
* An example of an experimental report

4/4/2024 7
Experimental report
* An example of an experimental report
Theory

4/4/2024 8
Experimental report
* An example of an experimental report

4/4/2024 9
Experimental report
* An example of an experimental report

4/4/2024 ………………………. 10
Experimental report
* An example of an experimental report

4/4/2024 11
Internship report
* What is an internship report?

➢ An internship report is a summary of your


internship experience that many employers
require to complete your time at their
organization.

➢ It is important because it informs your educator


of the lessons and skills you learned and the
opportunities you had to apply those skills.

➢ Your internship report includes relevant


details about your intern experience: your
position with the organization, the tasks you
completed and the skills you learned, etc.

https://www.indeed.com/career-advice/career-development/how-to-
4/4/2024
write-an-internship-report
12
Internship report
* How to create an internship report?
Use the following steps to create your internship report:
Step Contents and Useful Notes
1 Draft a title page Name, class, date and the name of the organization,..
2 Create a table of contents to navigate to the parts of the report
Include background The date it was founded, the business’s purpose or
3 information on the mission statement, the types of tasks the company
organization completes daily and any other relevant details.
Include your position give your reader a more complete overview of your
4 and responsibilities in internship and allow you to discuss your accomplishments
the internship in the role.
Discuss what you describe the specific things you learned and the skills you
5 learned and the skills cultivated. Relate these skills back to your educational
you developed experiences → Contribute to your development.
Conclude with ongoing be useful to consider the skills or experiences that you
6
considerations would still like to develop.
4/4/2024 13
Internship report
* Template of an internship report?
Title page

[Name] Assignment
[Class]
Task: Practically write an
[Internship dates] internship report for ……..
[Internship organization] Due time:

Table of contents
1. Company information
2. Internship description
3. Overview of internship experience
4. Ongoing consideration
5. Conclusion

Company information
[Company Name] was founded in [year] with the intention of [details]. The
company’s mission statement is to [mission statement]. [Company Name]
plays a vital role in the community with [details]. I chose this organization
because I find their mission to be important and relevant to my career goals.
4/4/2024 14
Internship report
* Template of an internship report?
Internship description

My role at [Company Name] was to [details]. I worked directly with [team] in


[internship responsibilities].

Overview of internship experience

During my internship experience with [Company Name], I was able to develop


my [skills]. I particularly found [experiences] to be useful in improving my
[skill]. Although I found [experience] to be challenging, I found it to be
valuable in developing my [skill].

Ongoing consideration

While I had many useful experiences at [Company Name], I feel that I still
need to develop my confidence levels with [task]. I would have enjoyed more
time completing [task].

Conclusion, [details].

Intership_Report_Clint_Armstrong_2013.pdf
4/4/2024 15
1.5.2 Thesis
* General structure 1) Hard cover
2) Paperback cover
3) List of tasks
4) Comments of supervisor, reviewer
5) Table of contents
6) List of Tables
7) List of Figures
8) Preface or acknowledgment
9) Main contents: Abstract, Chapters, Headings, sub-
headings, etc., Conclusions.
10) References
11) Appendix
12) Others: Evidences of a published paper,…

4/4/2024 16
Thesis
* General structure

E.g., Time new Roman, size 13

4/4/2024 17
Thesis
* General structure

4/4/2024 18
Thesis
* General structure

4/4/2024 19
Thesis
* General structure

4/4/2024 20
Thesis
* General structure

Example of
Cover page:

4/4/2024 21
Thesis
* General structure

Example of
Cover page:

4/4/2024 22
Thesis
* General structure
Example of
Dedication and
Acknowledgment:

4/4/2024 23
Thesis
* General structure
Example of Table
of contents:

4/4/2024 24
Thesis
* General structure
Example of List of
Tables and
Figures:

4/4/2024 25
Thesis
* General structure
Example of
Abstract:

4/4/2024 26
Thesis
* General structure
Example of a
Chapter:

4/4/2024 27
Thesis
* General structure
Example of a
Figure:

Center-alignment, Spacing (Before/ after, line), font

4/4/2024 28
Thesis
* General structure
Example of a
Table:

4/4/2024 29
Thesis
* General structure
Example of a
References:

4/4/2024 30
Thesis
* General structure
Main contents:

Characteristics of this shape:


1. Abstract needs to have independent
validity; Symmetric
2. It is symmetrical;
3. It narrows towards the central report
section and widens after it.

4/4/2024 31
Thesis
* How to write each component?
i) Abstract:

Note: Many more people will read the title


than the Abstract, and many more will read the
Abstract than the whole paper → it needs to
have independent validity

1) How do I start the Abstract? What type of


sentence should I begin with?
Three
2) What type of information should be in the
questions
Abstract, and in what order?

3) How do I end this section?


4/4/2024 32
Thesis
* How to write each component?
i) Abstract:
+ Definition: An abstract is a short summary of a longer work (such as a dissertation or
research paper). The abstract concisely reports the aims and outcomes of your research
so that readers know exactly what the dissertation/paper is about.

+ In a dissertation or thesis, include the abstract on a separate page, after the title page
and acknowledgements but before the table of contents.

4/4/2024 33
Thesis
* How to write each component?
i) Abstract:
+ 5 basic components:

Model 2

Model 1
4/4/2024 34
Thesis
* How to write each component?
i) Abstract:
+ An example
of Model 1:

Background

Aim + Method

Method_General
Method_Details

Achievement

Implications

4/4/2024 35
Thesis
* How to write each component?
i) Abstract:
+ An example
of Model 2:

What the paper does +


Method + Aim
Method in detail +
Results

4/4/2024 36
Thesis
* How to write each component?
i) Abstract:

The use of VERB TENSE is very


important in the Abstract.

https://diepnguyen.com/
Grammar and writing skills:
1) The gap/problem is normally in the Present Simple tense:
The main problem, however, is…
Although it is known theoretically that…

2) When you are referring to what the paper itself does or what is actual
in the paper itself → use the Present Simple tense:
This paper presents a new methodology for…
4/4/2024 37
Thesis
* How to write each component?
i) Abstract:
Grammar and writing skills:
3) When you are referring to your methodology, it is common to use the Past Simple
tense. However, Present Simple tense can be used, especially when you are referring to
calculations or equations which can be found in the paper itself.
The effect of pH was investigated by means of…
Several models are created using…

4) Results can be expressed in either Present Simple tense or, more commonly, in Past
tense, for example:
We show that this theory also applies to…
This finding correlated with…

5) Put the finding/result itself or the implication of the result in the Present Simple tense
if you believe it is strong enough to be considered as a fact or truth:
4/4/2024 38
Thesis
* How to write each component?
i) Abstract:
+ Length of an abstract:
- Most are between 80–150 words, Even longer Abstracts (150–250 words)
- A single paragraph (paper), possibly more than one in Thesis.
- Guide: For your first draft, don’t worry too much about the word limit →
Gradually remove words, phrases and even sentences that are not essential.
+ Language:
- Make sure that exact words or phrases appear in your Abstract
- The acronym, abbreviation or technical term can be used in the Abstract but
you should first say what it means or stands for.
+ To figure out what the writer is doing → Look at Grammar and
vocabulary clues
- What is the tense of the main verb?
- What is that tense normally used for?
- Is it the same tense as in the previous sentence?
- If not, why has the writer changed the tense?
- What words has the writer chosen to use?
4/4/2024 39
Thesis
* How to write each component?

ii) Introduction

iii) Method/Setup
Refer to Section 1.6: Structure of a
iv) Results scientific paper

v) Conclusions

But, how to write a good paragraph?

4/4/2024 40
Thesis
* How to write each component?
➢ PARAGRAPHING: 2) Why is paragraphing important?

1) Two common errors:


- Short or single sentence paragraphs, Visual aid to effective reading and writing
- Paragraphs are too long. Skimming (a few minutes)
Find out quickly what it is about and where the
various pieces of information are located so that
3) Instructor for creating a paragraph
you can read it faster and more confidently.
Write down each idea/concept

LOOK QUICKLY AT THE FIRST SENTENCE


Checking that they are in a logical OF EACH PARAGRAPH: Topic sentence
order which give the main idea of the paragraph

Listing what you want to say about Conventional/safe way of


each using bullet points writing paragraph
4/4/2024 41
Thesis
* How to write each component?
➢ PARAGRAPHING: Practice

4/4/2024 42
Thesis
* How to deal with reference, figure, table, table of content
a) Table of contents:
+ Definition: The table of contents is where you list the chapters and
major sections of your dissertation, along with their page numbers.
+ Purpose: A clear and well-formatted contents page is essential as it
indicates a quality paper is to follow.
+ Position: It should be placed before List of Tables/Figures
+ Maximum length: Should be 2 pages, up to third heading level
+ The key features of a contents page are:
✓ A page title
✓ Clear headings and subheadings
✓ Page numbers that indicate where in the dissertation each
section can be found
Check with your university or other educational institution to see if
there are any specific formatting requirements you must adhere to.

4/4/2024 43
Thesis
* How to deal with reference, figure, table, table of content

4/4/2024 44
Thesis
* How to deal with reference, figure, table, table of content
b) Table:
+ Definition: A table is an arrangement of information or data, typically in
rows and columns, or possibly in a more complex structure
→ Check with your university or other educational institution to see if there
are any specific formatting requirements you must adhere to.

Table 1.1 List of Purchased Equipment in 2006

4/4/2024 45
Thesis
* How to deal with reference, figure, table, table of content
c) Figure:
+ Definition: A figure in writing is any text, table or graphic separate from the main text.
→ Check with your university or other educational institution to see if there are any
specific formatting requirements you must adhere to.

How Quality of
figure is? → >
300 DPI for
standard print

Figure 1. (a) Only osmosis flow. (b) Osmosis and pressure-driven flows.

4/4/2024 46
Thesis
* How to deal with reference, figure, table, table of content
d) Reference:
+ Definition: is a relationship between objects in which one object designates
or acts as a means by which to connect to or link to, another object.
+ Why reference? You need to tell your readers where your evidence comes
from.

+ Citations are the ‘hooks’ in the body of the document that are a shortcut to
the full publication details in the References list;
→ Check with your university or other educational institution to see if there
are any specific formatting requirements you must adhere to.
E.g. of International Journal of Heat and Mass Transfer

4/4/2024 47

You might also like