Chapter 5A
Chapter 5A
2
The Importance of Writing
Engineers perform
technical writing to
communicate
Upper Management
pertinent information Decision
Control
that is needed by
upper management to
Detailed
make intelligent
Knowledge
decisions that will
affect a company’s Project Engineer
future. 3
The Importance of Writing
• Many engineers spend between 1/3 and 1/2 of
their work time engaged in technical writing.
• Examples include:
4
Technical Writing
Technical writing is a type of expository writing
that is used to convey information for
technical,education or business purposes.
• entertain
• create suspense
• invite differing interpretations
5
Technical Reports
Engineers write technical reports (also called
engineering reports) to communicate technical
information and conclusions about projects to
customers, managers, legal authority figures, other
engineers and other scientific community.
6
Layout and Format
Analogy:
Body(Text)
Title Page
Back Matter
Front Matter
Abstract
Table of Contents
Summary
Introduction
Methods, Assumptions,
and Procedures
Conclusion
References
Technical Report Layout
Appendixes
List of Symbols,
Abbreviations, and Acronyms
8
Back Cover
Front Matter
The front matter is used to help potential readers
find the report.
9
Front Matter
1. Cover*
2. Label*
3. Title Page
4. Abstract
5. Table of Contents
6. Lists of Figures and Tables
10
*May be an optional element
Front Matter: Cover*
A cover and label are used if
the report is over 10 pages
long.
cover to identify:
12
*May be an optional element
Front Matter:
Title Page
The title page provides
descriptive information that is
used by organizations that
provide access to information
resources (i.e., library).
ii
15
Front Matter: Table of Contents
The table of
contents lists the title
and beginning page
number of each major
section within the
report.
iii
16
Front Matter: List of Figures and
Tables*
A list of figures and
tables helps the
reader to locate
illustrations, drawings,
photographs, graphs,
charts, and tables of
information contained
in the report.
iv
17
*May be an optional element
Text
18
Text
• Introduction
• Methods, Assumptions, and Procedures
• Results and Discussion
• Conclusions
• Recommendations*
• References
19
*May be an optional element
Text:
Introduction
The Introduction
prepares the reader to
read the main body of
the report.
20
Text: Introduction
Subject - defines the topic and associated
terminology; may include theory,
historical background, and its significance
22
Text: Methods, Assumptions, and
Procedures
Methods
How did you discover the
problem? What measuring tools
were used? What
measurement system was
used?
Assumptions
What do you think, but cannot
substantiate as fact?
Procedures
4
24
Text: Results and Discussion
Results
explain your findings
with help of graphs or
tables , simulations etc
Discussion
How accurate are your
findings? What is the
significance of the
results of the
6
25
research?
Text: Conclusion
Restatement of Results
What are the factual
findings that resulted
from your research? What
are you implying as a
result of these findings?
Concluding Remarks
What are your opinions
based on the findings and 9
26
Text: Recommendations*
A section called recommendations is often
included in reports that are the result of tests and
experiments, field trials, specific design problems,
and feasibility studies.
27
*May be an optional element
Text: Recommendations*
Additional Studies
Is there information that still needs to be
learned?
Suggested Actions
What does the author want the reader to do
with the information?
12
28
*May be an optional element
Text: References
The references section is
the place where the author
cites all of the secondary
research sources’ that were
•used to…
develop an
understanding of the
problem
29
Back Matter
The back matter supplements and clarifies the
body of the report, makes the body easier to
understand, and shows where additional
information can be found.
30
Back Matter
• Appendixes*
• Bibliography*
31
Back Matter: Appendixes*
Anything that cannot be left out of a report, but is too
large for the main part of the report and would serve to
distract or interrupt the flow belongs in the
appendixes. Examples include:
32
*May be an optional element
Back Matter: Appendixes*
33
*May be an optional element
Back Matter: List of Symbols,
Abbreviations, and
Acronyms*