A separate repository should be created to house all of the final project deliverables. The final report should summarize many of these and include references when appropriate. The repository should be organized and easy to navigate. The final report itself should contain:
Title page
Project/team name
Team members
Team advisor
Sponsor(s) (if any)
Table of contents
Executive summary
Project overview
Specific team accomplishments and deliverables
Plan summary (project time expended, original and final milestones, etc.)
Roadmap document. The purpose of this component is to provide a jump start to a team that may wish to continue work on your project. Include:
A list of references to key project artifacts and documents, in a suggested “learning sequence”, to bring new team members up to speed on your project technologies, status, etc.
External references regarding the market, technologies employed, suppliers, and other relevant information.
A list of any key stakeholders and their contact information.
Project summary. This section provides a summary view of key parts of your broader project documentation. It may include selected diagrams and other information from those other documents. The goal is to provide an overall technical summary of the project so that key elements can be understood without having to do exhaustive study of other project documents.
Project postmortem
How does your project use “knowledge and skills acquired in earlier course work” and incorporate “realistic constraints that include most of the following considerations: economic; environmental; sustainability; manufacturability; ethical; health and safety; social; and political”? (These are
ABET requirements.)
What technical issues did you encounter, and how did you deal with them?
What new technologies, tools, methods, etc., did you have to learn as part of your project work? How successful was this learning effort, for all members of the team?
Compared to your original conception and plan, how did your project change and evolve?
How effective was your planning and management of project risks?
What team work and management issues did you encounter? How did you deal with them? How successful were you in managing them?
What things went well?
What are possible areas for improvement?