The key elements of your report include the following. Use the same ordering
and numbering as you see here when you address these elements in your report.
-
(1) title of project (and, if not clear from the title,
which topic option you have chosen);
-
(2) names and roles of
each teammate;
-
(3) what the applet is supposed to do. Include such things as
(a) let the user construct a graph, (b) automatically construct a graph,
(c) solve a certain kind of problem, (d) demonstrate an algorithm, (e) explore certain new ideas;
-
(4) technique(s) used, including (a) standard graph algorithm(s) and
(b) extra technique(s);
-
(5) a detailed explanation of the techniques mentioned in (4).
This should include pseudocode and a diagram.
-
(6)
how much you have succeeded in getting to work;
-
(7) one code excerpt for each partner. For each one, include
(i) a piece of code (typically at least 3 but no more than 30 lines)
that plays an important or an interesting role in your program,
(ii) the name of the partner who wrote it, and (iii) an explanation of what it is doing
and why it's an interesting or important part of the program;
-
(8) any remaining functionality that was intended but not
working;
-
(9) what the most challenging part of the project was;
-
(10) what the most enjoyable part of the project was;
-
(11) what each team member learned in this project;
-
(12) a list the names of your source code files and roughly what each
of them contributes to the overall program (list not only the files
you have edited but also the Visual Data Structure Applet framework
files you are using);
-
(13) instructions for running a demo of your project,
including a sequence of commands that can be copied and
pasted into the applet's command text area and executed
to show all the key features of your project;
-
(14) A list of references and sources that you consulted
for your project, including books, web sites, human consultants,
and other materials (you should have at least two). If you
cite books or articles, include page numbers. If you cite
web sites, include the full URLs;
-
(15) any changes you have made to your program after
the project demonstrations.
-
(16) any other comments.
|