E1BAPPA 09/10/2010
11:31:17 Page 568
Appendices
Appendices are places to place non-critical, supplemental or supporting information, such as raw data, lengthy
derivations, or sample programs. Appendices are independent from the report; they are often misused by a new
engineer. Uncertain as to whether or not some information should be in an Appendix? Ask yourself: If I place
this material in the Appendix and the reader did not read the Appendix, would the main body of the report still
be sufficient? It should be!
References
The references cited within a report should be detailed in a formal list at the end of the report. Use references
that provide credit for prior work but also to provide more information for the reader. For example, did the
test program follow an established engineering standard? Then provide a citation so the reader can go to this
standard for reading. If you used an internet webpage or web document, cite the URL and the date used.
References for this document provide an acceptable general format.
Some Writing Tips
1. Communicate! You are telling a story, albeit a highly technical one. Proofread, and then rewrite it!
Have someone else read it, and then rewrite it as needed!
2. Do not overdo significant figures. See the discussion in Chapter 1.
On Writing Style
Engineers often write reports in the third person in deference to impartiality and to focus attention on the subject
matter at hand. The idea is to disassociate the writer from the action and make the equipment/model/test the
‘‘doer of the action (5).’’ This is a notable goal but one that takes time and practice to do effectively. But
achieving this goal does not require extensive use of the passive voice, despite traditional beliefs to the contrary.
Do use the active voice where possible to liven up your report. The occasional impersonal construction in the
first person is fine if it improves readability. Frankly, we find it difficult to write extensively in the third person,
passive voice without the writing coming off as clumsy . . . and long. But choose the style that suits your
writing best. The important thing is to communicate effectively!
Conclusions
Technical authors must be cognizant of coupling the intended audience with the test goals when presenting the
results of their writing. This report has outlined the essential features germane to technical report writing and it serves
as an example of both style and format. We describe the purpose and content for each section of a report. We also pass
along some useful advice drawn from our experience in helping young engineers learn to write technically. We
conclude that an effective, polished, and professional product can be produced only through careful revision of
manuscript, by incorporating effective figures and tables, and by targeting the intended audience.
References
1. Tichy, H.S., and S. Foudrinier, ‘‘Effective Writing for Engineers, Managers, and Scientists,’’ 2d ed., Wiley
Interscience, New York, 1988.
2. Donnell, J. and S. Jeter, Writing Style and Standards in Undergraduate Reports, College Pub., 2003.
3. Henry, M. H., and H. K. Lonsdale,‘‘The researcher’s writing guide’’, Journal of Membrane Science 13:
101–107, 1983. (adapted with permission)
4. Committee on Technological Literacy, ‘‘Technically Speaking, why All Americans need to know more
about technology,’’ G. Pearson and A. Young, Ed., National Academy of Engineering, National Academy
Press, Washington, D.C., 2002.
5. Daniell, B., R. Figliola, A. Young, D. Moline, ‘‘Learning to Write: Experiences with Technical Writing
Pedagogy Within the Mechanical Engineering Laboratories,’’ Proc. ASEE, Paper 1141, 2003.
568 Appendix A A Guide for Technical Writing
11:31:17 Page 568
Appendices
Appendices are places to place non-critical, supplemental or supporting information, such as raw data, lengthy
derivations, or sample programs. Appendices are independent from the report; they are often misused by a new
engineer. Uncertain as to whether or not some information should be in an Appendix? Ask yourself: If I place
this material in the Appendix and the reader did not read the Appendix, would the main body of the report still
be sufficient? It should be!
References
The references cited within a report should be detailed in a formal list at the end of the report. Use references
that provide credit for prior work but also to provide more information for the reader. For example, did the
test program follow an established engineering standard? Then provide a citation so the reader can go to this
standard for reading. If you used an internet webpage or web document, cite the URL and the date used.
References for this document provide an acceptable general format.
Some Writing Tips
1. Communicate! You are telling a story, albeit a highly technical one. Proofread, and then rewrite it!
Have someone else read it, and then rewrite it as needed!
2. Do not overdo significant figures. See the discussion in Chapter 1.
On Writing Style
Engineers often write reports in the third person in deference to impartiality and to focus attention on the subject
matter at hand. The idea is to disassociate the writer from the action and make the equipment/model/test the
‘‘doer of the action (5).’’ This is a notable goal but one that takes time and practice to do effectively. But
achieving this goal does not require extensive use of the passive voice, despite traditional beliefs to the contrary.
Do use the active voice where possible to liven up your report. The occasional impersonal construction in the
first person is fine if it improves readability. Frankly, we find it difficult to write extensively in the third person,
passive voice without the writing coming off as clumsy . . . and long. But choose the style that suits your
writing best. The important thing is to communicate effectively!
Conclusions
Technical authors must be cognizant of coupling the intended audience with the test goals when presenting the
results of their writing. This report has outlined the essential features germane to technical report writing and it serves
as an example of both style and format. We describe the purpose and content for each section of a report. We also pass
along some useful advice drawn from our experience in helping young engineers learn to write technically. We
conclude that an effective, polished, and professional product can be produced only through careful revision of
manuscript, by incorporating effective figures and tables, and by targeting the intended audience.
References
1. Tichy, H.S., and S. Foudrinier, ‘‘Effective Writing for Engineers, Managers, and Scientists,’’ 2d ed., Wiley
Interscience, New York, 1988.
2. Donnell, J. and S. Jeter, Writing Style and Standards in Undergraduate Reports, College Pub., 2003.
3. Henry, M. H., and H. K. Lonsdale,‘‘The researcher’s writing guide’’, Journal of Membrane Science 13:
101–107, 1983. (adapted with permission)
4. Committee on Technological Literacy, ‘‘Technically Speaking, why All Americans need to know more
about technology,’’ G. Pearson and A. Young, Ed., National Academy of Engineering, National Academy
Press, Washington, D.C., 2002.
5. Daniell, B., R. Figliola, A. Young, D. Moline, ‘‘Learning to Write: Experiences with Technical Writing
Pedagogy Within the Mechanical Engineering Laboratories,’’ Proc. ASEE, Paper 1141, 2003.
568 Appendix A A Guide for Technical Writing