|
Self-Study Guide
Writing Engineering Reports: Understanding Expectations A gap exists between the writing knowledge that engineering students have learned in general writing courses and the specific expectations placed on engineers when writing professional reports. Reports, not essays, serve as the main type of document written by engineers to document their work. This webpage presents a self-study guide on understanding the expectations placed on you when writing an engineering report. Sponsored by the College of Engineering at Penn State, this page carries the purpose of bridging this gap. |
Writing as an engineer or scientist requires skills beyond those taught in general writing courses. |
Section 1: Analyzing Audience and Occasion (about 10 minutes)
In contrast with essays that you wrote for first-year English, most engineering reports carry specific constraints for audience and purpose. Before you begin writing or even outlining a report, you should think deeply about those constraints. For instance, in reports, you often encounter different audiences who have decidedly different levels of familiarity with the content [1]. Understanding your constraints of audience and purpose puts you in position to write a much more effective report.
In contrast with essays that you wrote for first-year English, most engineering reports carry specific constraints for audience and purpose. Before you begin writing or even outlining a report, you should think deeply about those constraints. For instance, in reports, you often encounter different audiences who have decidedly different levels of familiarity with the content [1]. Understanding your constraints of audience and purpose puts you in position to write a much more effective report.
|
Film 1. Analyzing Audience for Reports. |
Analyzing Purpose of Reports. |
Section 2: Crafting an Appropriate Style for Reports (about 25 minutes)
In an engineering report, the style refers to the way the authors communicate the content to the audience [1]. Engineering reports have three important perspectives on style: organization, language, and illustration. Presented in the films below are the aspects of style that most distinguish engineering reports from the style of essays taught in English courses. Given at the end of this guide are additional films that cover deeper aspects of style for writing as an engineer or scientist.
In an engineering report, the style refers to the way the authors communicate the content to the audience [1]. Engineering reports have three important perspectives on style: organization, language, and illustration. Presented in the films below are the aspects of style that most distinguish engineering reports from the style of essays taught in English courses. Given at the end of this guide are additional films that cover deeper aspects of style for writing as an engineer or scientist.
|
Film 3. Organizing a Report. Film 5. Writing Precise and Clear Sentences. Film 7. Incorporating Illustrations. |
Film 4. Writing in Sections. Film 6. Avoiding Ambiguity Film 8. Incorporating Equations. |
Section 3: Meeting Expectations for Form in Reports (about 8 minutes)
In an engineering report, form includes the length, formality, and format of the writing [2, 3]. In addition, form includes the grammar, punctuation, and usage. Although many rules exist for these aspects, the two films here focus on those aspects that are particularly important in engineering reports. While form might not hold as high a standing as content and style, form is often what audiences notice first and therefore shape an audience's first impression about a report. For more detail about the grammar, punctuation, and usage of scientific writing, please see this website's section on grammar.
In an engineering report, form includes the length, formality, and format of the writing [2, 3]. In addition, form includes the grammar, punctuation, and usage. Although many rules exist for these aspects, the two films here focus on those aspects that are particularly important in engineering reports. While form might not hold as high a standing as content and style, form is often what audiences notice first and therefore shape an audience's first impression about a report. For more detail about the grammar, punctuation, and usage of scientific writing, please see this website's section on grammar.
|
Film 9. Analyzing Occasion: Length, Formality, Format. |
Film 10. Avoiding a Major Grammar Error in Reports: the Run-On |
|
Test on Expectations for Reports
Take the Kahoot on the right to see if you learned important content of this guide. Instructors: If you would like to use a similar Kahoot in your classes to test your students on the content of this guide, please email Michael Alley. Note that you will need a Kahoot account. |
|
Acknowledgments
This self-study guide and microcredentialing badge are made possible by funds provided by the Leonhard Center for the Enhancement of Engineering Education in the College of Engineering at Penn State. Providing technical assistance on the films is the Office of Digital Learning, which is also in the College of Engineering at Penn State. Providing specific guidance and support for the guide and badge have been the following individuals: Stephanie Cutler, Casey Fenton, Andrea Gregg, Richelle Weiger, and Elaine Whitmer. Michael Alley, the author of The Craft of Scientific Writing [4], has overseen the creation of content for the guide and badge, and listed below are engineering students who have assisted in that creation.
This self-study guide and microcredentialing badge are made possible by funds provided by the Leonhard Center for the Enhancement of Engineering Education in the College of Engineering at Penn State. Providing technical assistance on the films is the Office of Digital Learning, which is also in the College of Engineering at Penn State. Providing specific guidance and support for the guide and badge have been the following individuals: Stephanie Cutler, Casey Fenton, Andrea Gregg, Richelle Weiger, and Elaine Whitmer. Michael Alley, the author of The Craft of Scientific Writing [4], has overseen the creation of content for the guide and badge, and listed below are engineering students who have assisted in that creation.
|
Conducting Interviews
Morgan Aloi Justin Bardy Dean Ellis Jake Grant Alexander How Belinda Mativenga Kaitlyn Pigeon Alison Wanamaker Mia Wanyo Developing Website Marissa Beighley Alexus Eicher Editing Films Mary Duncan Carrie McCartney Roman Pero Caroline Sinz Sophia Zitkus |
Mechanical Engineering, 2022 Mechanical Engineering, 2021 Aerospace Engineering, 2021 Mechanical Engineering, 2022 Mechanical Engineering, 2021 Chemical Engineering, 2022 Industrial Engineering, 2021 Industrial Engineering, 2021 Mechanical Engineering, 2022 Computer Science, 2022 Computer Science, 2020 Mechanical Engineering, 2021 Mechanical Engineering, 2020 Chemical Engineering, 2020 Mechanical Engineering, 2020 Mechanical Engineering, 2020 |
Penn State Penn State Penn State Penn State Penn State Penn State Penn State Penn State Penn State Penn State Penn State Virginia Tech Penn State Penn State Penn State Penn State |
References
- Michael Alley, The Craft of Scientific Writing, 4th ed. (New York: Springer, 2018).
- "Report Templates," Writing as an Engineer or Scientist, ed. by Michael Alley (University Park, PA: College of Engineering, 1996).
- "Sample Report Format," Writing as an Engineer or Scientist, ed. by Michael Alley (University Park, PA: College of Engineering, 1996).
Additional Films for Writing Engineering Reports
|
Process of Writing Reports as a Team |
Language: Making Connections |
|
Using "I" or "We" in Reports Punctuation: Three Important Comma Rules for Reports |
Language: Being Concise Usage: Verb Tense in Reports |
Please feel free to provide comments, questions, and suggestions for the films, text, and quizzes of this website. To help us understand your feedback, please let us know whether you are a student or faculty member (or other professional).