CSCI-4440 Software Design and Documentation
Spring 2001

Term Project Writeup (due April 25th).


Term Project Deliverables

Each project should be documented with project requirements documents and design documentation. Implementation (including partial implementation or prototying) descriptions are great, but not required. Each individual is responsible for at least 5 pages of documentation, these documents should include UML Models. Make sure your models are real UML. For each model included you must include a textual description of the model that clearly identifies:

The combined documentation from group members must be a single, consistent document. It's OK if there are gaps in the document (if there are not enough group members to cover the entire part of the project handled by the group), but there cannot be duplication of efforts. Every individual is responsible for proving their effort through their own documentation.

Each group document must include a section that identifies the purpose of the group (what part of the project the group worked on), the group members, and the responsibility of each group member.

Documentation on the project as a whole is also expected. At a minimum there must be a document that describes the project and the breakdown in to groups. Individuals whose primary responsibility was for requirements and design documents related to the project as a whole are expected to submit these documents using the guidelines above (this is their writeup).

Grading will be done individually. Part of each grade will depend on the cohesiveness of the group document as a whole - so you can lose points if the group documentation is poor (even if your part is great). In general, you should make sure your documentation is necessary, understandable (in the context of the group document), and consistent with the rest of the group document.