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.
It would be especially nice if tutorial information about specific devices
and/or interfaces and how to deal with them is placed in a a separate appendix
so that it can be easily distributed to future students. 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
Go into some detail on the implementation of your
project. Remember, I'm going to have to understand it
and new students will too. Concentrate on
describing the functionality and the interfaces of components.
You've already done a lot of this for the Design
Review.
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 schematics with documentation
Verilog listings with documentation
Microcontroller program listings with documentation
Complete and detailed operating and testing instructions