Table of Contents
Phase IV: Report
To document what you did to achieve permanence, recognition and future applicability.
Congratulations on completing the project! Although the project may be finished, your team must write a report. In this written report, It is essential to document all the work that was involved with the project. The finished project is not always telling of all the necessary actions and effort that was used. Be detailed and thorough enough so that anyone who has no experience with the project should be able to grasp the purpose of the project as well as what was required of the team from the start to finish.
What to Do:
● Keep track of everything remotely related to the project: Have all project files backed up in an organized and easily accessible place.
● Keep in mind that readers can’t read your mind: If you don’t document something, no one knows you did it.
● Common Techniques:
○ Start the report early
○ Write everything that may be relevant and revise afterwards. Do not worry about writing too much because it can always be removed in the final draft.
○ Keep a contact list of all people that helped
○ Get the report proofread multiple times by multiple people
○ Be concise in your writing
● Write a User Handbook: Write a user handbook under the assumption the user has little to no engineering background. Use layman’s terms but also include important technical specifications.
What to Submit:
Deliverable: Project Report
A typical report is organized in the following way.
● Title Page
● Table of contents
● Abstract. (This should be no more than a few paragraphs. It must clearly summarize the content of the report for those unfamiliar with the project)
● Introduction. (The scope of the project, setting the scene for the remainder of the report.)
● Previous work. (One or more review chapters, describing the research you did at the beginning of the project period).
● Several chapters describing what you have done, focusing on the novel aspects of your own work.
● Further work. (A chapter describing possible ways in which your work could be continued or developed. Be imaginative but realistic. Also, identify what didn’t work very well).
● Conclusions. (This is similar to the abstract. The difference is that the reader of the conclusions has read the rest of the report).
● References and appendices.