CS121: Software Development
Project 2: Documentation
You should document your development process on your
wiki as described in the Wiki Guidelines and the Work Organization Guide.
The formal documents you need to write include
- Users' Guide
- Final Report
This document describes your game including its design (UML) and your
test plan and results. Be sure to
elaborate on any important design considerations such as the use
of a design pattern.
The report should also include describe any
known bugs and problems, possible future enhancements, and
anything else you deem important.
Beyond the formal documents, we will review your code!! It should be
clean and well documented.