Suggestions for Project Reports in MCS 170

A very short sample project report is available entitled Hello Me Web Page

General advice

After you have finished carrying out the task outlined in the project assignment, you need to write a report that outlines the project task, describes your work on this task, and shows testing of your work to ensure correctness of solution. The project report is similar to papers that you write for other classes in that it should have an introduction, a body and a conclusion.

The introduction explains to your readers what the report is about and why they should read it. It gives a road map explaining the report's structure. The body of the report describes your work in detail, along with any code, analysis, or research that you have done for the project. Although most of the assignments present a list of questions and/or tasks that are meant to guide you through the project, you should not use these questions to organize your report. Instead, you should organize it so that you present the material in a logical and coherent manner. Finally, the conclusion should summarize what was learned during the project. 

Assume the audience includes people who have taken a similar course somewhere else. This means that they haven't read the book or the project assignment, but that they do know basic HTML and JavaScript. If necessary, you may assume the reader has a copy of the book handy so that you can cite it.

Using code in your reports

You will write, test and debug JavaScript code for many of the projects, and you will often need to put this code in your paper. You want to do this in such a way that your reader can easily understand what the code does and how it works. You also need to convince the reader that the code does work, usually by presenting (i.e., describing and giving examples of) your testing.

Project report DOs and DON'Ts