This is a group assignment.  READ THIS ENTIRE ASSIGNMENT OVER CAREFULLY BEFORE MEETING WITH YOUR GROUP!.

Each group in the class is to hand in one separate assignment. You can delegate the individual parts of the assignment to a subset of the group members, but it is a good idea for all group members to read over the entire completed assignment before one of the members hands it in to webct.

Overview

In this assignment, your group will complete the project by handing in a user manual for your finished system and your source code and doing a very small demostration of your project for the class.

Your hand-in/report should consist of the following things (see below for more details):

• Section 1: A User Manual for your finished system --> A pdf file
• Section 2: ALL your commented source code and Javadoc documentation --> Use jar to group all the .java files and javadoc files together into two .jar files (one for the Blackberry side and one jar file for the Standalone side).
• Section 3: Project Plan Document --> A pdf file.
• Section 4: Presentation

User Manual

The title page of your user manual must contain the following things:

• The course number  
• The section number.
• The words "Group Project - User Manual''.
• The due date of the assignment.
• The number of your group.
• The names of all your group members.

Sample Title Page:

As well, the manual must also contain at least the following things:

• A table of contents.
• Descriptions of each of the commands of the system (if you are using a text interface), or descriptions of each of the GUI controls (menu items, buttons, icons etc.) if you are using a GUI. (Descriptions of obvious and well-known user interface features, such as a dialogue box with "Yes'', "No'', and "Cancel'' buttons, are not necessary.)
• At least two examples to illustrate how to use the system.
• At least one screen shot, to illustrate the screen layout and to remind us of what your interface looks like.

Of course, it cannot have just these features and nothing else; you have to organize the document in a reasonable fashion.

Convert the user manual to a pdf file and call it Group?UserManual.pdf where ? is your groups group number.

Screen Shots

To make a screen shot, you can use the Unix command snapshot, available on the Gaul system. Here is one way of using it to do this.

• While your system is running, run snapshot.
• Click on the ``Hide window during capture'' button.
• Click on ``Snap''. (This will capture the window in the snapshot program's memory.)
• Click on the title bar of the window you want to take a snapshot of (e.g., the window that shows what your system looks like).
• Wait a few seconds for the snapshot control panel to come back.
• Click on ``Save...'' and select a file name to save the image in.
• Click on the ``Save'' button in the popup window.

To convert your screen shot to printable (PostScript) form, you can use the command xv, available on the Gaul system. Here is one way of using it to do this.

• Run xv on the file name containing the image (e.g., xv snapshot.rs).
• With the cursor in the xv window, click the right mouse button. (This will show the control panel.)
• Click the Save button.
• From the Format: menu in the upper right of the popup, select PostScript.
• Select another name for the Save file at the bottom of the popup, if you wish (e.g. snapshot.ps).
• Click the Ok button in the popup.

HINT: SnagIt is another excellent tool for capturing windows, it runs on MS Windows systems. If you have Windows 7, there is a tool called Snipping Tool that does screen captures. Go to All Programs>Accessories>Snipping Tool

Source Code

• Your source code should be neatly formatted and well commented so that it is clear to the reader what each module and data structure is for and what each function and code section is supposed to do.
• Each module should have a heading containing the file name of the module, its purpose, a description of the functions it contains and the author's name(s) (i.e. the group member(s) who wrote this code) Do not worry if some members wrote more code than other members, HOWEVER, every member of your group should have done SOME coding. 
• The easier it is for the marking t.a. to navigate your code, the better your mark will be, so try to hand your code in in an organized manner.
• Combine all the files together (the .java files and the javadoc html files) into two jar files called Group?SourceCodeBlackberry.jar and Group?SourceCodeStandAlone.jar where ? is your groups group number.

Project Plan Documentation

This document should include a complete Gantt chart showing the scheduling and division of tasks for the whole project. Send the final Gantt chart to pdf file called Group?FinalGantt.pdf

Presentation

Your group is required give a VERY short demo of your system in front of the rest of the class. Please bring your own laptop with your software installed on it. I will hook up the laptop to the display unit in the classroom. The demo should:

• not try to show every feature in your system, instead just demonstrate ONE or TWO of the parts of the system that your group thinks was done very well in your implementation.
• be less than 10 minutes.
• run smoothly, you might want to have one person type while another person does the talking to the class.

After your demo is finished, one or two (or the entire team if you want) of the group members must answer the following two questions for the entire group in front of the class:

1) What did your CS2212 group do (or not do) that made your project successful, i.e. what things worked so well that you would do them the same way in CS3307?

2) What did your CS2212 group do (or not do) that caused problems and thus you would NEVER do again in CS3307?

:

Tips

• The point of the user manual is to help the user to use the system effectively. Keep this in mind as you are designing and writing the manual.
• For the user manual, emulate some user manual that you think is good.
• Use a spell checker program.

Marking

The marks will be tentatively assigned as follows:

• Title page and general formatting: 2 mark.
• User manual: 12 marks
• Source code and Javadoc: 20 marks
• Project plan documentation: 2 marks
• Presentation: 6 marks

Submitting the Assignment

• NOTE: THIS TIME YOU WILL BE SUBMITTING 4 FILES TO WEBCT!
  • Group?UserManual.pdf
  • Group?SourceCodeBlackberry.jar
  • Group?SourceCodeStandAlone.jar
  • Group?FinalGantt.pdf
• Have one of the members in your group:
  • Log onto webct.
  • Go to assignments, group assignment 1
  • Attach the required FOUR files using the attach button in webct
  • Hit the Submit button
  • Hit the OK button

FINAL Peer Evaluation (to be done individually)

Within FOUR days of this assignment's due date, complete the peer evaluation for all members in your group. If you do not complete the final peer evaluation before the above due date, you will individually lose 0.5% off of your final mark for the course. NOTE: THIS IS YOUR FINAL CHANCE TO INDICATE TO US ABOUT THE WORK DONE BY EACH MEMBER IN YOUR GROUP.  THIS FINAL PEER EVALUATION COULD BE USED TO INDIVIDUALLY ADJUST THE GRADES OF GROUP MEMBERS. PLEASE BE FAIR, CLEAR AND CONSTRUCTIVE WHEN FILLING IN THESE FORMS.

Click here to submit a peer evaluation  (remember to also evaluate your own performance as well as ALL your other group members)