E1BAPPA 09/10/2010
11:31:17 Page 564
technical reporting formats. The major headings, such as Abstract and Introduction, are typical, but are
not meant to be exclusive.
Abstract
Effective technical communication abilities are important traits for an engineer in a technologically advancing
society. A technical report provides a means to document and to disseminate relevant technical information,
such as test or modeling results. The purpose of this article is both to provide specific procedures and ideas for
generating sound technical reports and to serve as a format example of a technical report. Guidelines for
preparing each section of a report and detailed ideas for presentation of results in plots and tables are provided.
The reader can draw from this outline to prepare a technical report on a chosen subject.
Introduction
In a 2002 report, the U.S. National Academy of Engineering concluded that the majority of Americans ‘‘are not
able to make well-considered decisions . . . about technology (4).’’ Our ability to communicate effectively
with both technical and nontechnical segments of society is essential for addressing the myriads of
technological problems and decisions facing our society. On a more personal level, career advancement in
any profession is largely based on how well a person communicates among peers. The primary form of written
communication used by practicing engineers and engineering managers, as well as researchers, is the technical
report or one of its variations, the executive summary or the laboratory report. Technical codes and standards
would fall into one of these categories, as well. Collectively speaking, these communications are directed
toward a technically knowledgeable audience. The purpose of this guide is to provide reasonable ideas and
suggestions for producing clear and concise technical manuscripts.
The following steps may help you prepare an effective document:
1. Always clearly define the question, the question being the objective or the hypothesis tested in the study
described by the report!
2. Your report should flow from what you sought to show and why it is important, to how you tried to
answer it, to what you found, and finally to what those findings mean relative to the question asked.
Start with a detailed outline using this logic flow. Then expand your outline to at least the level where
topics and some sentences have been formulated. The outline will help you avoid making a
chronological or ‘‘stream of consciousness’’ presentation, which is not desirable. This will enable
you to develop the rationale for your question and how you attempted to answer it in a logical manner.
3. Analyze your data, creating meaningful figures and tables. Then, organize your discussion on what this
information shows. In terms of answering your question, which figures and tables are important and
which are not? Use what is important. When deciding on just what to present, keep the particular
audience for whom you are writing in mind.
4. Set your format or headings using the format or style guide for a specific publication, workplace
template, or use this Guide. Organize around those headings.
5. Write a first draft in which you add meaningful sentences to your outline under each heading.
6. Read the draft, then rewrite it for presentation clarity and accuracy. Remember that you are telling a
technical story, so think clarity as from the reader’s point of view. Edit as needed. Proofread the
manuscript. Remember: Your audience cannot read your mind, just your report – put what you want to
say in writing. If possible, have a peer read the draft and ask for effective feedback on clarity and content.
7. Use a typography that is easy to read. If not specified, try a 12-point serif font, such as Times or Arial. Maintain
margins of at least 1.25 inches (32 mm). Number all pages (exception: page one may be left unnumbered).
Approach
The supporting blocks for constructing an effective technical document are the written text, well-prepared
figures, and clear tables, and an organized structure that communicates the story. Present the report from the
standpoint of your current knowledge. You do not need to report on bad data, failed trials, blunders, and so on
564 Appendix A A Guide for Technical Writing
11:31:17 Page 564
technical reporting formats. The major headings, such as Abstract and Introduction, are typical, but are
not meant to be exclusive.
Abstract
Effective technical communication abilities are important traits for an engineer in a technologically advancing
society. A technical report provides a means to document and to disseminate relevant technical information,
such as test or modeling results. The purpose of this article is both to provide specific procedures and ideas for
generating sound technical reports and to serve as a format example of a technical report. Guidelines for
preparing each section of a report and detailed ideas for presentation of results in plots and tables are provided.
The reader can draw from this outline to prepare a technical report on a chosen subject.
Introduction
In a 2002 report, the U.S. National Academy of Engineering concluded that the majority of Americans ‘‘are not
able to make well-considered decisions . . . about technology (4).’’ Our ability to communicate effectively
with both technical and nontechnical segments of society is essential for addressing the myriads of
technological problems and decisions facing our society. On a more personal level, career advancement in
any profession is largely based on how well a person communicates among peers. The primary form of written
communication used by practicing engineers and engineering managers, as well as researchers, is the technical
report or one of its variations, the executive summary or the laboratory report. Technical codes and standards
would fall into one of these categories, as well. Collectively speaking, these communications are directed
toward a technically knowledgeable audience. The purpose of this guide is to provide reasonable ideas and
suggestions for producing clear and concise technical manuscripts.
The following steps may help you prepare an effective document:
1. Always clearly define the question, the question being the objective or the hypothesis tested in the study
described by the report!
2. Your report should flow from what you sought to show and why it is important, to how you tried to
answer it, to what you found, and finally to what those findings mean relative to the question asked.
Start with a detailed outline using this logic flow. Then expand your outline to at least the level where
topics and some sentences have been formulated. The outline will help you avoid making a
chronological or ‘‘stream of consciousness’’ presentation, which is not desirable. This will enable
you to develop the rationale for your question and how you attempted to answer it in a logical manner.
3. Analyze your data, creating meaningful figures and tables. Then, organize your discussion on what this
information shows. In terms of answering your question, which figures and tables are important and
which are not? Use what is important. When deciding on just what to present, keep the particular
audience for whom you are writing in mind.
4. Set your format or headings using the format or style guide for a specific publication, workplace
template, or use this Guide. Organize around those headings.
5. Write a first draft in which you add meaningful sentences to your outline under each heading.
6. Read the draft, then rewrite it for presentation clarity and accuracy. Remember that you are telling a
technical story, so think clarity as from the reader’s point of view. Edit as needed. Proofread the
manuscript. Remember: Your audience cannot read your mind, just your report – put what you want to
say in writing. If possible, have a peer read the draft and ask for effective feedback on clarity and content.
7. Use a typography that is easy to read. If not specified, try a 12-point serif font, such as Times or Arial. Maintain
margins of at least 1.25 inches (32 mm). Number all pages (exception: page one may be left unnumbered).
Approach
The supporting blocks for constructing an effective technical document are the written text, well-prepared
figures, and clear tables, and an organized structure that communicates the story. Present the report from the
standpoint of your current knowledge. You do not need to report on bad data, failed trials, blunders, and so on
564 Appendix A A Guide for Technical Writing