Embedded Systems – Laboratory Assignment Report Format
All of the homework in this class is presented in the form of laboratory design projects. This means that there is no
single right answer to any problem. In fact, the opportunity to develop creativity is encouraged. Each project
requires a formal, written report.
Each project requires a report with the following components:
1. All work is reported on a web page as the submission medium.
2. A title page including the project number and title, your name and the date.
3. An introduction summarizing the problem, any given specification and the objective. The introduction
must be self contained, i.e., don’t write “see the handout”. Write it in your own words. Be concise. You
may include and edit the original assignment as part of the introduction if you desire.
4. A presentation of the design problem broken down into steps.
a. Provide your source code and any figures.
b. Include screen captures of software showing specific features that need to be highlighted to
emphasize or explain your work. For example, a screen capture might show a single-step
execution of some problem.
c. Present and comment on the execution and measurable outputs.
d. All computer programs require your name and assignment number to be included as comments.
Properly acknowledge any ownership or copyright issues.
e. In copying software or screen captures, be cognizant of the amount of space these things consume
in file space. Use compressed file formats and thumbnails.
5. A Conclusion summarizing what you have accomplished. Describe any unique problems you encountered
and suggest any improvements you would make on the project.
Source Code and File Inclusion:
1. Your laboratory report should list and include a listing of all files used in the project unless this is
redundant from previous projects.
2. You must document your programming code following these guidelines:
a. Include a header on each file, similar to the one used in the book. Acknowledge all ownership
issues. List your name as the one who has modified the program.
b. Under the header category on version history for existing files (e.g., SerComm.cpp) write a brief
summary detailing the changes you made to the file. Include your name and the date.
c. In the code, put a comment above or to the right of any changes you made explaining the purpose
of the change. Include your name, or initials, and the date.
d. It is recommended that you date each function that you change as well as the entire file. This
helps a lot when going over old files and making changes for future work.
Report grading considers these two guidelines:
1. Can the Instructor/TA grader find and understand all of the work in the report without having to “read into”
what is provided.
2. Is the material useful for future work? Could someone replicate the experiment based on what is provided?