CS3007

This section provides a summary of the submission requirements for CS3007, together with advice on the length and content of the documents to be submitted.

Each team is required to submit the following material:

• One complete source code listing for the project, sample data files, etc.
• Two copies of the team report.
• Two copies of each of the individual reports, with accompanying Project Log forms.

• One on-line archive containing source code, make files, installation instructions, etc.

The deadline for submissions is: 3:00pm Friday, May 3rd 2002.

Reports and source code listings should be submitted to the Departmental office. Sign-up sheets will be provided. Details on submission of archives appear below.

One member of each team should collect the following material from the Departmental Office:

• 3 sets of report covers (front & back).
• 3 comb bindings (2 medium + 1 large size).

The report should be a maximum of 50 pages in length (including Appendices). Two copies are to be submitted. A proposed structure follows which you should use as a guide; feel free to modify it as you see fit.

Title

Acknowledgements

Table of Contents

1. Introduction
   Overview of project, summary of team organisation, project management strategy (frequency of meetings, internal procedures, etc.)

2. Requirements
   Summary of requirements analysis phase (procedures followed, etc.), current system, functional and non-functional requirements for proposed system, feasibility study. You should base this chapter on your earlier requirements specification summary.

3. Design
   Overview of design, structure charts, key module designs, data structures, file structure, user-interface design, requirements cross-reference, summary of any modifications made to design during later stages of project. You should base this chapter on your earlier design summary.

4. Coding & Integration
   Planning for coding & integration of modules, key implementation decisions, libraries used, use of existing software, algorithms, etc. I do not expect to see large amounts of code in the report; small code fragments may be used to illustrate major decisions, etc.

5. Testing
   Testing strategy, description of test data, use of stubs & drivers, test results.

6. Summary
   Discussion of outcome of project, if original customer requirements were not satisfied - explanation of why, possible future changes/additions to the system, lessons learnt.

Appendices

1. Appendix 1 - User Manual
   Introductory material on how to run the system.

2. Appendix 2 - Maintenance Manual
   Description of how to install and compile system, hardware/software dependencies (including libraries), list of source code files (with brief summary of role in system), etc.

3. Additional appendices such as: copy of customer contract, material from current system, etc.

It is only necessary to print the first copy of the team report on the laser printer; the second copy can be produced using the photocopier - a photocopier card is available from the Departmental Office.

You will need to use the comb-binding machine to bind the reports.

The code should be printed on the laser-printer (using multicolumn printing). You are reminded that it is your responsibility to ensure that all the code is readable, has not been truncated by the edge of the page/printing area, etc. You will lose marks if the code is not readable.

The code should be bound using one of the sets of report covers and the large comb binding. Again, use the comb-binding machine to bind the report.

The Department retains archives of all projects for possible demonstration and future use. As part of your project submission you are asked to present the software you have developed in a format that can be used by others. To this end, you should provide a compressed UNIX tar file with the following information:

• A one page description of the program;

• Installation instructions - what does a user have to do to get your program running on their machine? How do you compile the program?

• Dependencies - what other elements does the program require to run? Examples include: hardware requirements, operating systems, software packages, libraries. Include version numbers.

• Source code - make sure that you use relative pathnames rather than absolute ones, so that the system can run without depending on your login name.

To submit the archive proceed as follows:

Note that ensuring that your program can be installed and used is a vital part of software development. The instructions and code you provide will be tested during the project assessment.

The report should be 3-5 pages in length (typed). Two copies are to be submitted. You should attach your complete set of Personal Log forms to one copy of the report.

I suggest the structure shown below:

1. Introduction
   Brief summary of aims/objectives of the project.

2. Personal Contribution
   In each of the following sub-sections, you should summarise your personal contribution to the appropriate project phase, initiatives taken, particular problems which you solved, difficulties encountered, etc:

   • Requirements Analysis
   • Design
   • Coding/Integration
   • Testing
   • Documentation

3. Project Management/Other Responsibilities
   Summary of any responsibilities which you took on during the project - leadership of team, leader of project phases, etc. You should discuss how you coped with responsibility, what you achieved, etc.

4. Team Dynamics
   Summary of how you feel you contributed to the overall functioning of the team unit. Any problems within team. Also use this section to summarise (and rate) the contributions made by each of the other members of the team; we recommend that you do this in the following style:

   Joe Bloggs
   summary of contribution made.
   Rating: +10%

   Jane Doe
   summary of contribution made.
   Rating: -25%

   and so on for the other team members...

   The rating here is your recommended delta to be applied to the team-mark for that person, e.g. if a team receives a mark of 80% for the project, a delta of 25% would mean an individual mark of 60%. NB. These are only your personal recommendations - your project manager has the final decision in this matter. (Remember that he will use a number of information sources, including his own experiences of the team, your project log sheets, comments in the individual reports, outstanding CS3007 warnings, as well as student ratings of their peers).

Individual reports should be submitted as stapled sheets of A4 paper, i.e. no special binding/covering is required.