Scribd
Upload
0 views

1. Technical Report Elements

The document outlines the significance of technical writing for engineers, emphasizing that they spend a substantial amount of their time creating various reports to communicate essential information to management and other stakeholders. It details the structure and components of a technical report, including front matter, text, and back matter, along with guidelines for effective writing. Additionally, it provides tips for writing and references for further reading on the subject.

Uploaded by

sammush79
Copyright
© © All Rights Reserved
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
0 views

1. Technical Report Elements

The document outlines the significance of technical writing for engineers, emphasizing that they spend a substantial amount of their time creating various reports to communicate essential information to management and other stakeholders. It details the structure and components of a technical report, including front matter, text, and back matter, along with guidelines for effective writing. Additionally, it provides tips for writing and references for further reading on the subject.

Uploaded by

sammush79
Copyright
© © All Rights Reserved
Available Formats
Download as PPTX, PDF, TXT or read online on Scribd
You are on page 1/ 40

Forging new generations of engineers

Technical Report
Writing
Elements and Standards
Associated Lesson
Concept
Engineers spend a great deal
of time writing technical
reports to explain project
information to various
audiences.
The Importance of Writing
Engineers perform Upper Management
technical writing to
communicate Decision
pertinent information Control
that is needed by
upper management to Detailed
make intelligent Knowledge
decisions that will
effect a company’s Project Engineer
future.
The Importance of Writing
Many engineers spend between 1/3 and 1/2
of their work time engaged in technical
writing. Examples include:
• proposals • technical reports
• regulations • progress reports
• manuals • emails
• procedures • memos
• requests
Technical Writing
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
Technical Reports
Engineers write technical reports (also
called engineering reports) to communicate
technical information and conclusions about
projects to customers, managers, legal
authority figures, and other engineers.
A technical report follows a specific layout
and format as specified by the American
National Standards Institute (ANSI).
Layout and Format
Analogy:
Think of the layout and
format of a newspaper.
Stock market information
is found in a specific
location in a newspaper
(layout), and is presented
in a table format.
Text
Front
Cover

Back Matter
Front Matter
Title P
a ge

Abstr
act
Table
of Co
ntents
List o
f Table
s and
Figure
s
Summ
ary
Introd
uction
Metho
ds, As
su
and P mptions,
roced
ures
Resul
ts and
Discu
ssion
Concl
usion
Refer
enc es
Appen
Technical Report Layout

dixes
Abbre
viatio List of Sym
ns, an
d Acr bols,
onym
s
Back
Cover
Front Matter
The front matter is used to help potential
readers find the report.
Once found, the front matter will help the reader
to quickly decide whether or not the material
contained within the report pertains to what they
are investigating.
Front Matter
1. Cover*
2. Label*
3. Title Page
4. Abstract
5. Table of Contents
6. Lists of Figures and Tables
*May be an optional element
Front Matter: Cover*
A cover and label are used
if the report is over 10 pages
long.
The cover (front and back)
provides physical protection
for the printed report. Plastic
spiral bindings and thick,
card-stock paper are
recommended.
*May be an optional element
Front Matter: Label*
A label is placed on the cover to identify:

• Report title and subtitle


(if a subtitle is
appropriate)
• Author’s name
• Publisher*
• Date of publication

*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).
A title page duplicates the
information found on the
front cover (if one is used).
Front Matter: Abstract

An abstract (informative style) is a short summary


that provides an overview of the purpose, scope,
and findings contained in the report.
Purpose - identifies the issue, need, or
reason for the investigation
Scope - reviews the main points, extent
and limits of the investigation
Findings - includes condensed conclusions
and recommendations
Front Matter: Abstract
• no more than 200 words*
• provides an “in a nut shell”
description without providing
underlying details
• contains no undefined
symbols, abbreviations, or
acronyms
• makes no reference by
number to any references or ii

illustrative material
Front Matter: Table of Contents

The table of contents


lists the title and
beginning page
number of each major
section within the
report (excluding the
title page and the
table of contents).
iii
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

*May be an optional element


Front Matter: List of Figures and
Tables*

A figure is any drawing, photograph,


graph, or chart that is used to explain
and support the technical information
in the text.
The figure number and title will appear
below the image.
Refer to a figure or table within the
text, and place the image close to the
reference.
*May be an optional element
Front Matter: List of Figures and
Tables*

A table is an arrangement
of detailed facts or
statistics that are
arranged in a row-and-
column format.
The table number and title
appear above the table.

*May be an optional element


Text
The text is the part of a technical report in
which the author describes the methods,
assumptions, and procedures; presents
and discusses the results; draws
conclusions, and recommends actions
based on the results.
Text
• Summary
• Introduction
• Methods, Assumptions, and Procedures
• Results and Discussion
• Conclusions
• Recommendations*
• References

*May be an optional element


Text: Summary

• States the problem,


method of investigation,
conclusions, and
recommendations
• Contains no new info
that is not contained in
the report
• Does not contain 1

references
Text: Introduction

The Introduction
prepares the reader to
read the main body of
the report.
This page focuses on
the subject, purpose,
and scope of the
report.
3
Text: Introduction

Subject - defines the topic and associated


terminology; may include theory,
historical background, and its
significance
Purpose - indicates the reason for the
investigation
Scope - indicates the extent and limits of
the investigation
Text: Methods, Assumptions, and
Procedures

The methods, assumptions, and procedures


used in the investigation are described so the
reader could duplicate the procedures of the
investigation.
Information in this section includes:
• System of measurement
• Types of equipment used and accuracy
• Test methods used
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
How did you gain a better 4

understanding of the problem?


Text: Results and Discussion

The results and discussion section describes


what you learned about the problem as a result of
your research, identifies the degree of accuracy
related to your findings, and gives the reader your
view of the significance of your findings.
Text: Results and Discussion

Results
What did you learn about
the problem through your
research?
Discussion
How accurate are your
findings? What is the
significance of the results
of the research?
6
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
results?
9
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.
The author may recommend additional areas of
study and suggest a course of action, such as
pursuing an alternate design approach.

*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

*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
• support the information
contained in the report
14
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.
Back Matter
• Appendixes*
• Bibliography*
• List of Symbols, Abbreviations, and
Acronyms
• Glossary*
• Index*
• Distribution List*
*May be an optional element
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:
• Large tables of data • Detailed explanations
• Flowcharts and descriptions of test
techniques and
• Mathematical analysis
apparatus
• Large illustrations • Technical drawings
*May be an optional element
Back Matter: Appendixes*
Appendix A
Hose Nozzle Part Drawings

*May be an optional element


Back Matter: List of Symbols,
Abbreviations, and
Acronyms*

If more than five


symbols,
abbreviations, or
acronyms are used in
the report, they are to be
listed with their
explanation.

*May be an optional element


Tips for Writing
• Create an outline of your report before you
write it.
• Write the body of the report first. Then
write the front and back matter.
• Have someone proofread your report.
References

National Information Standards Organization. Scientific and Technical Reports -


Elements, Organization, and Design. ANSI/NISO 239.18-1995
(R1987).
Alley, M. (1996). The craft of scientific writing. (3rd ed.). New York: Springer-
Verlag
Day, R. A. (1998). How to write & publish a scientific paper. (5th ed.). CT: The
Oryx Press.
Beer, D., McMurrey, D. (2005). A guide to writing as an engineer (2nd ed.).
Hoboken, NJ: John Wiley & Sons, Inc.
Lannon, J. M. (1994). Technical writing. NY: Harper Collins College Publishers
Newman, J. M. (2006). Resources for technical and business writing: Glossary.
Retrieved August 3, 2006 from
http://www.lupinworks.com/roche/pages/glossary.php

You might also like