Guidelines

Due 11.59pm, Sunday, Aug 16th.

• You will be graded on completeness and clarity
• All assignments are individual
• Submit to WebCT before the deadline
• ONE PDF FILE ONLY!!!

There is no late policy for this course!

If you do not complete the report by the deadline, you will receive 0
You "may" be excused pending discussion with your TA

Overview

Now that your game is complete you are ready to write your final report. Your report should chronical the creation of each object used in your gamee. Interactions between objects should also be summarized. Given your report, another programmer should be able to recreate your game in a similar fashion without seeing the application. It is important that you use the language of the course and computer science in general to describe each detail of your game so that a fellow programmer may use it as a blueprint. Now that the application is finished, provide some rationale as to whether it was successful or not. Remember to include all details: what worked, what didn't, and what still needs to be done.

Report Requirements

The following slides below describe a template for a rough Software Requirement Specification (SRS). The purpose of this document is to FULLY describe your game, enough so that another programmer would be able to implement it. Follow each section below carefully, and use the language of the course to describe your game.

Section 1: Introduction

A brief introduction to the game. This should give the reader the story, background, genre, gameplay style and any other pertinent information about your game.

Section 2: Features

• 2-3 paragraph simple description of ALL features of the application
• Include EVERYTHING the program can do
• DO NOT get into details, DO NOT explain HOW things work

Section 3: Final UML Diagram

• Include ALL Classes
• Follow the UML Example here

Section 4: Detailed Classes Summary

• Use snippets for complex sections of a class or algorithm
• Explain details
• Explain essential methods
• DO NOT explain trivial methods (getters / setters / simple methods)

Section 5: Main Application

• How are your objects created, stored, destroyed?
• How many states are there in your program? (start, play, game over)
• How are objects iterated?
• How interactions between objects handled

Section 6: Meeting Requirements

Describe how you met the following requirements:

• Inheritance
• Polymorphism via Overridding
• Method Overloading
• Objects as Parameters to Methods
• Objects Declared Within Objects

(use references to the classes section, example: see the collision method of the ball class)

Section 7: Summary

Summarize the application:

• What worked?
• What didn't?
• What needs to be done?
• Are you happy with the results?
• Do you think the client is happy?

(use references to any previous section)

UML Requirements:

• Class name
• Fields with type
• Methods with name, parameters, and return type
• Inheritance relationships

Example:

Tips and Tricks

• DO NOT WAIT UNTIL THE LAST MINUTE
• FOLLOW THE TEMPLATE SECTIONS EXACTLY
• USE THE TERMS PAGE ON THE COURSE WEBSITE
• DESCRIBE EVERYTHING IN DETAIL
• IF WE CAN'T UNDERSTAND IT, THERE'S TROUBLE...