How to make a project report for engineering

As a professional engineer, you have myriad experiences solving problems. Your reports, both formal and informal, help your client, supervisor, or other stakeholders make actionable decisions about those problems. Explore these resources to learn how to write more effective reports for greater project and career success:

Whether formal or informal, interim or final, your report is an essential part of the problem-solving process. Begin by analyzing your communication situation (note: link to Communication Situation) and reviewing communication basics?? (note: link to Communication Basics), then find out how to structure and format your report as effectively as possible:

What elements should my report contain?

Whether you’re writing for a client, your supervisor, or some other project stakeholder, your audience will likely want to know [adapted from P.V. Anderson’s Technical Communication (1)]:

An effective report will be structured to answer these questions clearly and specifically. Depending on its level of formality, your report structure will include all or some of these elements [adapted from the Purdue Online Writing Lab (2)]:

Front matter refers to the preliminary, supporting components of a report. It appears where you might expect: at the front of the report. You will typically attend to this element last and in conjunction with back matter, after you have written the body and executive summary and abstract.

Your report’s front matter includes [adapted from the Purdue Online Writing Lab (3)]:

Formal reports include every component listed above; an informal report may only include some of them. In some cases, your company may specify which of these components to use and how.

Executive summary and abstract

Your engineering report may include both an executive summary and an abstract, or it may only include one or the other. These elements appear between the front matter and the report body. Write these after you have written and revised the report body.

What is an executive summary?

An executive summary is an overview of the key points in your report. It should summarize the purpose and scope of your work, the methods you used, and your key findings, conclusions, and recommendations [4].

What is an abstract?

An abstract is a short but specific summary of the details you cover in the report’s body. It should briefly mention the purpose and scope of your work, the methods you used, and your key findings, conclusions, and recommendations [5].

What’s the difference between the two?

The difference lies primarily in their purpose and length. The abstract provides a preview of the report’s content meant to entice readers to read the entire report. It is typically less than a page long. The executive summary, on the other hand, provides enough information to allow stakeholders to make a decision without reading the full report. It is typically as long as 10% of the full report [6].

Body

The body of your report is where you provide the details of your work. It is the longest part of your report and falls after the front matter and executive summary and abstract. You will produce the body before any other element of your report, with the possible exception of graphics, like figures and tables.

Your report’s body includes [1] [7]:

Back matter

The back matter of a report is its succeeding, supporting components. As its name implies, it appears at the back of the report. You will typically attend to this element last and in conjunction with front matter , after you have written the body and executive summary and abstract.

Your report’s back matter includes [1]:

What is the best way to present those elements?

According to Paul Anderson in his book Technical Communication: A Reader-Centered Approach, “Good [formatting] helps readers understand your information, locate information, and notice highly important content” [8]. A successful report is formatted well.

What components should I consider while formatting?

When formatting your report, pay attention to these common components [8]:

How do I format those components?

Consider these basic principles adapted from graphic design theory when formatting your report [9]. Scroll to the bottom of this page for a rough example of these principles applied to the above components:

Reference Report examples

Your company likely has numerous examples of reports that include some or all of these elements and their individual components. In addition, examples of formal reports abound in professional journals in your field.

How do I use Microsoft Word to my advantage?

Microsoft Word includes numerous tools and functions that will save you time and hassle, and allow you to consistently format your reports. Visit the links from Where can I find more information about writing effective reports? to learn how to use these time-saving tools and functions:

Where can I find more information about writing effective reports?

The IEEE Professional Communication Society’s site provides you with a basic understanding of writing effective reports. Explore other resources to gain more knowledge about this topic.

References

[1] P.V. Anderson, “Writing reader-centered reports,” in Technical Communication: A Reader-Centered Approach. Boston, MA: Thomson Wadsworth, 2007, pp. 539-556.

[2] E. Cember, A. Heavilon, M. Seip, L. Shi, and A. Brizee. Sections of reports. Purdue Online Writing Lab. [Online]. Available: http://owl.english.purdue.edu/owl/resource/726/05

[3] E. Cember, A. Heavilon, M. Seip, L. Shi, and A. Brizee. Mechanical elements of reports. Purdue Online Writing Lab. [Online]. Available: http://owl.english.purdue.edu/owl/resource/726/08

[4] Processes for writing an executive summary. Writing at Colorado State University. [Online]. Available: http://writing.colostate.edu/guides/page.cfm?pageid=1508

[5] E. Cember, A. Heavilon, M. Seip, L. Shi, and A. Brizee. The report abstract and executive summary. Purdue Online Writing Lab. [Online]. Available: http://owl.english.purdue.edu/owl/resource/726/07

[6] K. Khan. (2008, Sept. 19). Difference between executive summary, abstract and synopsis. University of Balochistan. [Online]. Available: http://www.scribd.com/doc/55954574/Difference-Between-Executive-Summary-Abstract-and-Synopsis

[7] E. Cember, A. Heavilon, M. Seip, L. Shi, and A. Brizee. The report body. Purdue Online Writing Lab. [Online]. Available: http://owl.english.purdue.edu/owl/resource/726/06

[8] P.V. Anderson, “Designing reader-centered pages and documents,” in Technical Communication: A Reader-Centered Approach. Boston, MA: Thomson Wadsworth, 2007, pp. 372-398.

[9] R. Williams, The Non-Designer’s Design Book. Berkeley, CA: Peachpit Press, 2004.

© Copyright 2024 IEEE – All rights reserved. Use of this website signifies your agreement to the IEEE Terms and Conditions.
A not-for-profit organization, IEEE is the world’s largest technical professional organization dedicated to advancing technology for the benefit of humanity.