| Section | Description |
|---|---|
| Header | Include the lab title and your student ID, full name, and e-mail. |
| Introduction | State the purpose and goals of the lab report. You should explain why someone should read your report and give a road-map explaining its structure. |
| Problem statement and proposed solution | Explain the problem and how you solved it. You should present it in a self-contained manner. Assume the report audience includes people who have taken a similar course but somewhere else. So they haven't read the text book, nor have they read the lab description. |
| Testing | It's your responsibility to test your code thoroughly as you write each procedure and to convince the reader that you know all your code works. If your code has a bug, report the bug and explain your testing and what you know about where the bug is in your program. If you fail to report a bug, the grader will assume you either (a) tested poorly or (b) were dishonest in your report. Either way, your grade should be more severely reduced than if you just report your bug. |
| Conclusion | Summarize what the reader should have learned. |
| Acknowledgments | If somebody helped you during the lab or when writing your report, make sure to include her or his name in this section. Also, include your lab partner's name, in case you had one. |
| References | Include in this section any works consulted (books, web pages, etc.). |
This document was based on: Suggestions for clear lab reports in computer science courses.