EE281 Lectures
EE281 Lectures
Table of content
Effective communication ....................................................................................................................2
Importance of communication .........................................................................................................2
Characteristic of effectives communication .....................................................................................2
Effective communication strategies .................................................................................................3
Writing angineering documents ...........................................................................................................5
What is an engineering document? ..................................................................................................5
Types of engineering documents .....................................................................................................5
Examples of technical documents ................................................................................................5
Examples of non-technical documents: ........................................................................................5
How to write an engineering document ...........................................................................................5
1. Conduct research and make a plan ...........................................................................................5
2. Identify the document structure ...............................................................................................6
3. Write the content .....................................................................................................................6
4. Finalize and test ......................................................................................................................6
5. Maintain and update as required ..............................................................................................6
Tips for writing an engineering document .......................................................................................7
Lab Reports ........................................................................................................................................8
Importance ......................................................................................................................................8
Typical Components: ......................................................................................................................9
Lab Report Example .....................................................................................................................11
Correspondence ................................................................................................................................13
Main parts of a letter ..................................................................................................................... 13
Application Letter ......................................................................................................................... 13
Example of a Letter of Application ............................................................................................ 14
Memo Example.............................................................................................................................15
Email Example ............................................................................................................................. 15
Resources .........................................................................................................................................17
Books ...........................................................................................................................................17
Websites .......................................................................................................................................17
Effective communication
Communication is an essential skill for engineers. It plays a crucial role in facilitating
collaboration, problem-solving, and innovation. Effective communication ensures that
engineering projects are completed on time, within budget, and to the satisfaction of all
stakeholders.
Importance of communication
Here is a list of tips that could be considered when writing an engineering document:
Avoid using jargon. Although certain terms may seem like standard knowledge
within the engineering field, other professionals may be unfamiliar with technical
jargon, especially if they're in the beginning stages of their career. For this reason, it's
important to use language that's easy to understand and applies to all members of your
audience.
Use active voice. Using active voice rather than passive voice in your writing can help
you keep the reader engaged and improve the clarity of your work. It can also create a
more succinct document, making it faster for a professional to read, reference and
understand.
Understand your audience. While you are likely creating a document for other
engineers, there are instances where you may create a technical document for a wider
audience, such as a guide or equipment manual. Focusing on your audience can help
you ensure you use the appropriate language and terminology for your reader.
Lab Reports
Lab reports are the most frequent kind of document written in engineering and can count for
as much as 25% of a course – yet little time or attention is devoted to how to write them well.
Worse yet, each professor wants something a little different. Regardless of variations,
however, the goal of lab reports remains the same: document your findings and communicate
their significance. With that in mind, we can describe the report’s format and basic
components. Knowing the pieces and purpose, you can adapt to the particular needs of a
course or professor.
A good lab report does more than present data; it demonstrates the writer’s comprehension of
the concepts behind the data. Merely recording the expected and observed results is not
sufficient; you should also identify how and why differences occurred, explain how they
affected your experiment, and show your understanding of the principles the experiment was
designed to examine. Bear in mind that a format, however helpful, cannot replace clear
thinking and organized writing. You still need to organize your ideas carefully and express
them coherently.
Importance
Writing a laboratory report is of utmost importance for several reasons. The following key
points highlight the significance of writing a laboratory report:
1. Documentation and Communication: A laboratory report serves as a comprehensive
documentation of the experimental process, observations, and results obtained
during a scientific investigation. It allows researchers to communicate their findings
to the scientific community and beyond. Effective communication is essential for
sharing knowledge, replicating experiments, and building upon existing research.
2. Reproducibility and Verification: A well-written laboratory report includes detailed
methodologies, procedures, and measurements that enable other researchers to
reproduce the experiment and validate the results. Reproducibility is crucial in
science as it ensures the accuracy and reliability of findings. By providing a clear
account of the experimental process, a laboratory report allows others to verify and
confirm the reported results, contributing to the overall scientific progress.
3. Analysis and Interpretation: In a laboratory report, researchers analyze and interpret
the data collected during the experiment. This includes statistical analyses,
graphical representations, and comparisons with existing theories or models.
Through this analysis, researchers can draw meaningful conclusions, identify
patterns, and propose explanations for the observed phenomena. The process of
analysis and interpretation helps scientists gain a deeper understanding of the
subject matter and contributes to the development of scientific knowledge.
4. Record of Findings: Laboratory reports serve as a permanent record of the findings
and outcomes of an experiment. They provide researchers with a reference to revisit
their work, recall the experimental details, and use the findings for future research
or for building upon existing knowledge. This record can also be utilized by other
researchers who may be interested in the same topic or need to cite the original
work.
5. Academic Progress and Professional Development: Writing laboratory reports is a
fundamental skill for students and researchers in scientific disciplines. The process
of organizing thoughts, structuring information, and presenting findings in a clear
and concise manner helps develop critical thinking, analytical skills, and effective
scientific communication abilities. It also encourages researchers to reflect on their
work, identify areas for improvement, and refine their experimental design and
methodologies.
Typical Components:
1. Title Page
2. Abstract
3. Methods and Materials
4. Experimental Procedure
5. Results
6. Discussion
7. Conclusion
8. References
9. Appendices
1. The Title Page: needs to contain the name of the experiment, the names of lab partners,
and the date. Titles should be straightforward, informative, and less than ten words (i.e. Not
“Lab #4” but “Lab #4: Sample Analysis using the Debye-Sherrer Method”).
2. The Abstract: summarizes four essential aspects of the report: a) the purpose of the
experiment (sometimes expressed as the purpose of the report) b) key findings, c) significance
and d) major conclusions. The abstract often also includes a brief reference to theory or
methodology. The information should clearly enable readers to decide whether they need to
read your whole report. The abstract should be one paragraph of 100-200 words (the sample
below is 191 words).
3. The Introduction: is more narrowly focused than the abstract. It states a) the objective of
the experiment and b) provides the reader with background to the experiment. State the topic
of your report clearly and concisely, in one or two sentences. When determining the objective,
be sure to identify the end goal of the experiment itself, not the pedagogical goal of the
experiment:
The objective of this experiment was to learn how to use the SEM. (The Professor’s reason
for having you do the lab, but not the objective of the lab itself).
The objective of the experiment was to determine the composition of an unknown sample
using Scanning Electron Microscopy. (This is your key result)
The purpose of this experiment was to identify the specific element in a metal powder sample
by determining its crystal structure and atomic radius. These were determined using the
Debye-Sherrer (powder camera) method of X-ray diffraction.
A good introduction also provides whatever background theory, previous research, or
formulas the reader needs to know. Usually, an instructor does not want you to repeat the lab
manual, but to show your own comprehension of the problem. For example, the introduction
that followed the example above might describe the Debye-Sherrer method, and explain that
from the diffraction angles the crystal structure can be found by applying Bragg’s law. If the
amount of introductory material seems to be a lot, consider adding subheadings such as:
Theoretical Principles or Background.
*Note on Verb Tense: Introductions often create difficulties for students who struggle with
keeping verb tenses straight. These two points should help you navigate the introduction:
The experiment is already finished. Use the past tense when talking about the experiment.
“The objective of the experiment was…”
The report, the theory and permanent equipment still exist; therefore, these get the present
tense:
“The purpose of this report is…”
“Bragg’s Law for diffraction is…”
“The scanning electron microscope produces micrographs …”
4. Methods and Materials (or Equipment): can usually be a simple list, but make sure it is
accurate and complete. In some cases, you can simply direct the reader to a lab manual or
standard procedure: “Equipment was set up as in CHE 276 manual.”
6. Results: are usually dominated by calculations, tables and figures; however, you still need
to state all significant results explicitly in verbal form, for example:
Using the calculated lattice parameter gives, then, R = 0.1244 nm.
Graphics need to be clear, easily read, and well labeled (e.g. Figure 1: Input Frequency and
Capacitor Value). An important strategy for making your results effective is to draw the
reader’s attention to them with a sentence or two, so the reader has a focus when reading the
graph.
In most cases, providing a sample calculation is sufficient in the report. Leave the remainder
in an appendix. Likewise, your raw data can be placed in an appendix. Refer to appendices as
necessary, pointing out trends and identifying special features.
7. The Discussion is the most important part of your report, because here, you show that you
understand the experiment beyond the simple level of completing it. Explain. Analyse.
Interpret. Some people like to think of this as the “subjective” part of the report. By that, they
mean this is what is not readily observable. This part of the lab focuses on a question of
understanding “What is the significance or meaning of the results?”
To answer this question, use both aspects of discussion, a) Analysis and b) Interpretation.
a) Analysis: What do the results indicate clearly? What have you found? Explain what you
know with certainty based on your results and draw conclusions:
Since none of the samples reacted to the Silver foil test, sulfide, if present at all, does not
exceed a concentration of approximately 0.025 g/l. It is therefore unlikely that the water
main pipe break was the result of sulfide-induced corrosion.
b) Interpretation: What is the significance of the results? What ambiguities exist? What
questions might we raise? Find logical explanations for problems in the data:
Although the water samples were received on 14 August 2000, testing could not be
started until 10 September 2000. It is normally desirably to test as quickly as possible
after sampling in order to avoid potential sample contamination. The effect of the delay is
unknown.
Example: The Debye-Sherrer method identified the sample material as nickel due to the
measured crystal structure (fcc) and atomic radius (approximately 0.124 nm).
Notice that, after the material is identified in the example above, the writer provides a
justification. We know it is nickel because of its structure and size. This makes a sound and
sufficient conclusion. Generally, this is enough; however, the conclusion might also be a
place to discuss weaknesses of experimental design, what future work needs to be done to
extend your conclusions, or what the implications of your conclusion are.
9. References: include your lab manual and any outside reading you have done.
10. Appendices
This typically include such elements as raw data, calculations, graphs pictures or tables that
have not been included in the report itself. Each kind of item should be contained in a separate
appendix. Make sure you refer to each appendix at least once in your report.
For example, the results section might begin by noting: “Micrographs printed from the
Scanning Electron Microscope are contained in Appendix A.”
Introduction: Plants require light for photosynthesis. This experiment aims to understand the
relationship between light intensity and plant growth rate.
Materials:
Potted plants (all of the same species and approximately the same size)
Light sources with adjustable intensity
Ruler
Timer
Procedure:
1. Place plants under light sources set at different intensities: low, medium, and high.
2. Ensure all other conditions (water, temperature, etc.) are kept constant.
3. Measure the height of each plant at the start of the experiment.
4. Allow plants to grow for two weeks.
5. Measure the height of each plant again.
Results
Discussion: The results indicate that plants grown under medium light intensity had the
highest growth rate, followed by those under high and then low light intensity. This suggests
that there's an optimal light intensity for this plant species, beyond which additional light
doesn't significantly boost growth.
Conclusion: Light intensity affects the growth rate of plants. For the plant species tested,
medium light intensity was found to be the most favorable for growth.
Recommendations: Future experiments could vary other factors, such as the type of light or
the duration of light exposure, to gain a more comprehensive understanding of plant growth
dynamics.
Remark
It should be borne in mind the previously shown example is a rather simple if not simplistic.
The main point to remember is that captures the essence of what a lab report should be. A real
lab report might include more detailed methods, a comprehensive literature review, more in-
depth discussion, and extensive references. Always refer to your institution's or instructor's
guidelines when preparing a laboratory report.
Correspondence
Enegineering, throughout their course of studies, and engineers, throughout their professional
carriers write and send letters, memos and emails. These are used when applying for jobs,
communicating updates to team members and providing feedback to other companies.
Heading: Include your name and contact information, such as an address, phone
number and email address. You might also include a company logo in the header.
Date: the date you send the letter.
Reference: Applicants may reference a job position or customers may refer to the
order information when filing a complaint.
Recipient's address: the details of the recipient including their address and contact
information.
Subject: Include the topic of the letter. If you are writing a complaint letter, the
subject can be the order number
Salutation: the formal greeting directly addressing the recipient
Body Paragraphs: the full text with details of the letter and relevant information.
Closing: the last paragraph in a business letter that includes what the writer expects
from the recipient.
Signature: Some letters require a handwritten signature in addition to a typed
signature.
Enclosures: Consider including your contact information. You may not need to
include this if you have shared your contact details in the heading.
Copy Circulation: the additional recipients for a letter.
PostScript: You can include an additional message after the writer finishes an article.
You can note this with P.S. and your text after your signature.
Application Letter
Letter of Application Letters of application, also called cover letters, generally accompany a
resume and rely heavily on persuasive writing skills because the main goal is to convince the
employer that the writer of the letter is good enough to be called for an interview. It is helpful
to try to think from the employers’ perspective—what are they looking for? How will they
evaluate credentials? How much information do they want in the letter? What skills are
important to them? Considering these questions and brainstorming before the letter is written
can help the author in deciding what content to include and which skills to emphasize.
Because most employers will probably have several letters to review, it is important to
emphasize major points clearly and concisely in a format— and font—that is easy to read.
Proofreading is critical, as is organization. The letter should only highlight key qualifications
to avoid repeating the accompanying resume.
During the past five years, I have gained valuable experience in various types of technical
writing, documentation, and graphic design. I have written technical specifications,
government contracts, and white papers for International Software Systems, Inc., in
conjunction with several branches of the United States Army and Navy. I have also edited
several ads that were published in major magazines for Object International (such as PC
World, PC Weekly, and ORACLE). In my current position at Dell Computer Corporation, I
have written and illustrated an employee handbook and documented and flowcharted several
corporate processes (such as hiring processes, EMI procedures and flowchart maps for
engineering reviews and checkpoints).
1
The following example of a letter of application was taken from David McMurrey’s online
textbook, Online Technical Writing.
I am currently in the process of completing my Associate Degree in Communication at Austin
Community College. Once I achieve this degree, I plan to transfer to The University of Texas
(at Austin) to complete a Bachelors Degree in Journalism. While my studies at UT have been
invaluable to my career goals, your intern program provides an important element. I have
been searching for an employment opportunity like this one that combines my continuing
education with practical experience in technical writing.
In the past, several team members from your organization have assisted me in completing
projects on a contract basis. They were instrumental in enhancing documents and the work
reflected a strong sense of pride and professionalism. Since these are the same business ethics
I strive for personally, I can think of no better learning environment than joining an
organization such as yours.
I look forward to having the opportunity to further discuss my qualifications with you.
Sincerely yours,
Carol N. Brand
(000) 000-0000
Enclosure: resume
Memo Example
Date: [Date]
To: All Employees
From: [Sender's Name]
Subject: Company-wide Training Session
Dear Team,
Please make sure to arrive on time and bring a notepad and pen to take notes. We believe this
training will enhance our customer service skills and improve overall customer satisfaction. If
you have any questions, please don't hesitate to reach out to me.
Email Example
Subject: Meeting Request - Marketing Strategy
Based on your availability, I suggest scheduling the meeting for [Date] at [Time] in
[Location]. Please let me know if this works for you, or if you have any alternative
suggestions.
Additionally, please come prepared with your insights and ideas regarding target audience
segmentation, key messaging, and the media channels we should focus on.
Thank you for your attention to this matter. I look forward to meeting and working together to
achieve our marketing objectives.
Best regards,
[Your Name]
[Your Position]
[Your Contact Information]
Resources
Books
Kenneth G. Budinski, Engineers’ guide to technical writing , ASM International,
2001
David Beer , and David McMurrey, A guide to writing as an engineer , Fourth
edition, Wiley,2014
John X. Wang, What Every Engineer Should Know About Business Communication,
CRC Press, 2008
Websites
https://ecp.engineering.utoronto.ca/resources/online-handbook/
https://writingcenter.gmu.edu/writing-resources
https://owl.purdue.edu/owl/index.html
https://mcmassociates.io/textbook/models.html