Your final project report should follow the guidelines below. It should be written to the level of a student entering CSE477 (as you were at the beginning of the quarter). It should contain all the information necessary to reproduce your results. That is, a new 477 student should be able to modify your project based on your report with a minimum of fuss and trouble.
The main part of your report should be a narrative that describes the structure of your project and the rationalle for the decisions you made. Focus on the parts that are not straighforward. The design details should be in the Appendices. If you have done your job over the quarter, then most of this will already be written.
Your reports may be provided to future classes to help them get
started on their projects. I prefer short reports to long
reports, but it's a lot harder to write good, short reports.
Introduction - 2-3 pages
A high-level description of your project, including
an overview of the system architecture.
Use figures liberally.
Design description - 2-4 pages
Describe the functionality of the various
modules. The specs and design documents are in the appendices,
so don't repeat that information. Instead,
this description should give the high-level information that will
allow the reader to easily understand those documents.
Commentary and Retrospective - 1-2 pages
Describe the final status of the project.
What did you learn? What advice do have for
other designers trying to build similar projects?
How would you design the project knowing what you
know now?
Appendices
Slides from you project presentation
Design specs for all components
Design schematics with documentation
Verilog listings with documentation
Microcontroller program listings with documentation
Complete and detailed operating and testing instructions