Course Project Report Description
A single report is required per each team. This report should be a
self-contained document, which describes all team efforts on
the project up to the submission date. This means that your report
should not refer to any other reports or documents that you previously
handed in. Any material from those documents that is relevant to this
report should be included here.
Every report must have a cover page containing:
· the course title,
· group number,
· project title,
· project website,
· submission date, and
· all team-member names.
Negative points will be assigned to reports missing- or having an
incomplete cover page.
The second page of each report must detail the breakdown of
individual contributions of each team member to the project. Each
student should quantify, as a percentage, his or her own contribution
to each top-level section of the report (listed below). If all team
members feel that their contributions were about equal, just write
down Equal contributions.
The rest of the report must contain the following sections:
- Introduction and Background Information:
Here you should essentially re-tell the story you told
in your presentation slides: formulating
the project goals and system requirements.
the relevant details of technical analysis indicators that will
be implemented in your system; dont describe what you
have no plans to implement. Cite references to sources such as books,
papers, or website URLs, where the reader can find additional
information about all concepts introduced here.
- System Design:
Start with the block diagram, describe all
the components, and how they interact. It is preferable that you use
UML diagrams, such as package
diagrams, class diagrams, interaction
diagrams, etc., for graphical representation of your
Describe the interface of your Web service (what goes in
and what comes out of your Web service), and list explicitly the
stock indicators that your service will track, etc.
When describing the interface, give the exact UML classes and
not only a high-level description. Generally, be
specificdo not talk about what could be done; rather, say
what you will do in your project
So far, you developed two major components of your system (data
collection and Web service infrastructure), so provide as much detail
as possible about these two.
- Implementation and Results:
Describe the componentes you implemented so far. What
technologies you used, how many stocks you are tracking and which
ones, how are you managing the collected data, and general experience
Provide analysis of results (if applicable at this stage of the
project), such as after-the-fact analysis of the price prediction
accuracy, or usefulness of suggested actions (buy,
- Plan of Work:
List the projected milestones and
dates by which you plan to accomplish them. Preferably, you should
use Gantt charts for
planning and scheduling your project.
(Rutgers students can download Microsoft Project at the University Software
Also provide the breakdown of responsibilities: what each team member
did so far, is currently doing, will do in the future.
The list of references should
contain exact references and URLs of any material that is
used in the project and doesnt come from the textbook.
reference should be cited in the main text; otherwise, it should not
appear in the list of references.
There is no limit on the number of pages for the
report. Of course, you should avoid stuffing your report with
redundant or irrelevant material. The report must be
self-contained; the grader should not need to read any other
material to read and understand the report.
Brevity is good because it will be easier for you to create a
professionally looking technical reportit is easier to
maintain consistency, clarity, and readability for shorter
Check also: 10+ ways
to reduce wordiness in your writing (TechRepublic)when you
streamline your wording, your message becomes more powerful and clear.
Please turn in your documents electronically in PDF format. Here is
writer you can use from Windows. Macs automatically convert
postscript to PDF by clicking on the file icon. There are UNIX
utilities that convert postscript to PDF for Linux users; make sure
you include all fonts in the created PDF.
Last modified: Thu Mar 20 17:07:34 EDT 2008