Project :: Report Template

The report should answer the following questions (based upon an excellent resource on writing engineering reports - Handbook on Report Formats (http://owl.english.purdue.edu/owl/resource/726/1/) from from Purdue University Online Writing Lab (OWL)).

  • WHAT was done (the problem being worked)
  • HOW it was done (the procedures used)
  • WHAT the results were
  • WHAT conclusions can be drawn
  • WHAT recommendations can be made

Your report should be structured as follows:

Introduction

What is the purpose of this report, what was the problem being solved and what was the scope of your investigation.

Design

Describe the design of your scheme concisely. Use finite state machine diagrams, sequence diagrams, flow charts, pseudo-codes, or any other formal method that you think is useful to help explain the design. Provide justifications to your design decisions. You can cite existing work (books, research papers, magazine/news articles, case studies, white papers, etc) to support your design decisions.

Evaluation

Evaluation Setup

Describe your evaluation setup. Use diagrams or pictures to clarify your descriptions.

What are your evaluation scenarios and why do you want to evaluate these scenarios? An evaluation scenario is a specific experiment with certain settings. For instance, if you want to evaluate the effect of two parameters A and B, wherein A can have two values (a1 and a2) and B can have two values (b1, b2, and b3), then you will have 6 evaluation scenarios or experiments: (a1, b1), (a1, b2), (a1, b3), (a2, b1), (a2, b2), and (a2, b3).

Results and Discussion

Overview of the results. Plot the results of your evaluation scenarios in meaningful graphs. Do not just report the raw data that you have collected, use your knowledge of statistics to derive some powerful insights.

Explain the results; do not just describe the results. Why did you get these results?

Conclusions and Recommendations

Conclude your report by summarizing what you have done and highlight your key achievements, e.g. if you have based your design on a scheme proposed in publication and you have been able to improve the accuracy, say it.

Provide recommendations for future work, e.g. how your design and implementation can be improved.

References

List publications that you have cited (e.g. papers, technical reports), website for tools used, etc. Every item listed here must be cited in the report.

Appendices

You should include the source code of your implementation and copies of relevant background material. For example:

  1. Appendix A - Source Code
  2. Appendix B - ........
  3. Appendix C - ........

Acknowledgements

This website has been adapted from the NWEN302 Assignment Template.

List also other sources of help that you have received.