EEE 1101: Introduction to Engineering Studies

Technical Writing
 Technical Writing
2

▸Technical writing is a type of expository writing this is

used to convey information for technical or business
purposes.
▸Technical writing is NOT used to:
•Entertain
•Create suspense
•Invite differing interpretations
 The Importance of Writing
3

▸Many engineers spend between 1/3 and 1/2 of their

work time engaged in technical writing. Examples
include:
• proposals • technical
• regulations reports
• manuals • progress
• procedures reports
• requests • emails
• memos
 Quote
4

Nicholas D. Sylvester in his book Engineering Education

has given data under the title “Engineering Education
Must Improve the Communication Skills of its Graduates.”

From the data, it is observed that

“75% of engineering undergraduates take jobs in industry,
where at least 25% of an engineer’s time is spent in the
reporting process. As the engineer moves up the
managerial ladder, this time can increase to as much as
80%.”
 Report Planning
5

• Before writing, consider:

– Why you are writing
– What you hope to achieve
– Who you are writing for

These considerations will determine your

report’s content, organization, textual
and visual design
 Report Format and Organization
6

• Reports generally include these sections in this order:

– Title Page
– Body of the Report
• Introduction / Background Information
• Procedure / Methodology
• Presentation of Data / Results
• Discussion of Results
• Conclusion
• References
 Report Format and Organization
7

• Write a report on your academic performance in

AIUB. Maintain the following order:
– Title Page
– Body of the Report
• Introduction / Background Information
• Procedure / Methodology
• Presentation of Data / Results
• Discussion of Results
• Conclusion
• References
 Introduction / Background Study
8

• Introduction / Background
– Explains the research problem and its context
• Outlines the objectives of the experiment
• Identifies pertinent background information
• Explains importance of the problem (Why does it matter? Why is
more information needed?)
• Explains reason(s) and goal(s) for study

You want your reader to fully understand the

significance of your research
 Procedure / Methodology
9

• Procedure / Methodology
– Explains how data was gathered/generated
– Explains how data was analyzed
– Assumes reader understands material
• Does not include explanatory material
– Graded on quality, not on quantity/weight
– Is in past tense and passive voice
• “A 1” piece of coil was cut and the following measurements
were taken...etc”
– The research has been carried out
– It is the research, and not your activities, that are of interest
 Presentation of Data/Discussion of Results
10

• Presentation of Data/Discussion of Results

– Visually and textually represents research findings
• Visual representation of results:
– Graphs, tables, diagrams, charts
• Explanatory text:
– Text points out the most significant portions of
research findings
– Indicates key trends or relationships
– Highlights expected and/or unexpected findings
 Conclusion / Summary
11

• Conclusion / Summary
– Discusses:
• How general principle was supported by the findings
• What was learned and what remains to be learned through
research
• Weaknesses/shortcomings vs. strength of study
• Possible applications of study (how it can be used)
• Recommendations

Do not include statements about your

personal feelings or experiences.
 Conclusion / Summary
12

• Conclusion / Summary
– Discusses:
• How general principle was supported by the findings
• What was learned and what remains to be learned through
research
• Weaknesses/shortcomings vs. strength of study
• Possible applications of study (how it can be used)
• Recommendations

Do not include statements about your

personal feelings or experiences.
 Results vs. Conclusion
13

• Experiments require writers to observe results and to draw conclusions

from those observations. Observable results, however, are different
from the conclusions drawn.
• A result is simply what happened; a conclusion goes beyond what
happened. A conclusion requires a scientist to draw an inference, to
make a point about the results.
• For example, Paul Broca measured women’s brains in the mid-1800’s.
When he observed that they weighed an average of 181 grams less than
a man’s brain, he wrongly concluded that smaller brains meant women
were less intelligent than men. His observation, the result of his
measurements, was correct. The brains did weigh less. But less weight
doesn’t lead to the conclusion that women are not as smart.
(Interesting note: What would he have concluded if he had known
Einstein’s brain weighed nearly ½ pound less than the average man’s
brain?)
 Active Voice vs. Passive Voice
14

• ACTIVE FOCUSES • PASSIVE FOCUSES

ON THE PERSON: ON THE PROCESS:
Paul used the Bunn Oxygen saturation
method to test the was tested in all three
oxygen saturation in all locations using the
three locations. Davie method.

Most advice from teachers encourages writers to avoid passive voice and to
write in active voice. The lab report is unique: Lab reports typically rely
heavily on passive voice sentences.
 Active Voice vs. Passive Voice
15

• ACTIVE VOICE: I have • PASSIVE VOICE: Tiny

detected tiny shifts in shifts in blood flow to
blood flow to parts of parts of the brain were
the brain with detected with functional
functional magnetic magnetic resonance
resonance imaging. imaging.
• ACTIVE VOICE: • PASSIVE VOICE: A
We prepared a 50ml 50ml solution was
solution using distilled prepared using distilled
water in volumetric water in volumetric
flasks. flasks.
 Visual Aid
16

• When doing your Lab Report, think about data that could be presented
visually. If that data would help your reader understand your lab report,
then use the visual aid. For lab reports consider using:
• TABLES if you results use a lot of numbers
• SCHEMATIC if your method or results require an understanding of the circuitry
(inside workings) of a mechanism
• DIAGRAM if your method or results involve an understanding of special
instruments or mechanisms
• MAPS if you are working with an outdoor lab where places are important
• GRAPHS if you wish to compare numerical data
• PHOTOGRAPHS if the actual picture would help your understand your data
 Finishing Touches
17

• 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
 Report on Lab Visit
18

• Write Report on Lab Visit:

 Cover Page
 Body of the Report
– Introduction / Background Information
• Basic info on Labs, e.g. why labs are important for EEE / CoE program
– Procedure / Methodology
• How the lab visit was conducted
– Presentation of Data / Results
• Give the detail observations, how many labs, where are they located, what
equipment each labs have
– Discussion & Conclusion
• What have you learned from the lab visit, how was it helpful
– References
 References
19

• Asian Institute of Technology Language Center. (2003). Writing Up Research

Guidebook. Asian Institute of Technology. Retrieved June 9, 2005 from
http://www.clet.ait.ac.th/el21open.htm
• Chan, S.L., Kitipornchai, S., and Al-Bermani, F.G.A. (1991). Elasto-plastic analysis of
box-beam-columns including local buckling effects. Journal of Structural Engineering,
117, 1946-1978.
• Halligan, N. (2004). A short course on writing technical reports. Technical Writing.
Retrieved June 9, 2005 from http://www.technical-writing-course.com/type-of-
technical-report.html
• Kvam, E. (Personal communication, June 11 2005).
• Manivannan, G. "Technical Writing & Communication: What & Why?"
UsingEnglish.com(December 2005), under "Teachers,"
http://www.usingenglish.com/teachers/articles/technical-writing-
communication-what-why.html
20

THANK YOU!