DELIVERABLE ITEMS

All the documents you produced this quarter, including the source code for your Feasibility Prototype(s) and Extended Prototype (as appropriate).

This includes all project management documents, QA reports, and the post-mortem report.

PROJECT SUBMISSION GUIDELINES

I would prefer to receive your deliverables in electronic form, preferably a CD-ROM.. The root directory on the CD should contain one folder named with your team name. All other documents should be in this folder.

• README.TXT  file that contains:
• an explanation of the organization of files on your CD, for example, a one-line description of the contents of every folder.
  
• list of all development tools used, including version number.  (E.g. "Class diagram - Together 4.1")
• (CPE 206) directions for users on installing and running your the final release of your implementation (if not available on your web site).
  
• (CPE 206) notes for developers explaining how to build your application (if not available on your web site).
• (CPE 206) a list of any "known limitations" or current defects in your Final Release.  Describe any discrepancies from your Final Release Delivery Plan (if not available on your web site).
  
  
• Website folder contains an image of your team web site that is browseable.  Be sure that your team home page has links to all the work products and deliverables you created.  Please use the -linksource option when producing the javadocs so the javadocs contain hyperlinks to the line-numbered source containing the pseudocode (or implementation). Make sure there are no dead hyperlinks or links that point to instructor template files. You can use a "site snagger" software to put the web site on the CD with all the links fixed up for browsing on the CD.  I would prefer that the CD not contain any FTP log files.  (This is not meant to be a huge task; see the instructor if you have difficulties). 
  

(CPE 206) Create a report of all defects from Elementool (your team defect tracking system). Login to Elementool and create an issue report and check the checkbox for "Print View".  Save the resulting page to a file. Include this report on the CD-ROM instead of a link to the Elementool site.

• Prototypes folder contains the source code for your prototypes.  You may create subdirectories for UI prototypes, Feasibility prototypes, and Extended Prototypes. The source code should be included (including any test drivers) as individual Java files.  (CPE 205)
  
  
• Source folder contains your Java source code.
  
  • (CPE 205) the source files for your detailed design or first stage implementation (as appropriate).
  • (CPE 206) the final release source code files, unit and integration test code, scripts, etc. in the directory structure found in your source code repository. You do not need to include the source code for every build, only for the final release.  Please do not include the folders named CVS and CVSROOT.
    
    
  Be sure to include any "project files" created by Together, Rose, JCreator, etc, that accompany your source code. I want to be able to simply load your work into the appropriate tool and be able to compile and run your code.
  
  
• Tools folder includes any development tools that aren't on your web site.  For example, maybe you wrote a custom LOC counter, or used a commercial keystroke capture/playback tool, or wrote a perl script for submitting change requests, or a cron job for updating your web site.  Include any custom test drivers or test support tools you used. It isn't necessary to include Sun's JDK or other commercial IDE.

Please submit your CD in a protective sleeve or case, neatly labeled as follows:

Team name
Project name
CPE 205 quarter year  (E.g. Fall 2002)

• (205) I will pick a requirement from your staged delivery plan and ask you to show me where it appears in the traceability matrix and that the design diagram is consistent with the javadocs and the pseudocode.
• (205) I should be able to type javac *.java in your Source folder and all the files should compile without error.
• (206) I will ask you to guide me through the design to identify some tiny piece that we can implement, or some unresolved defect that we can fix.  Then I want to be able to load your source code onto my workstation, modify your implementation and then follow the directions in the developer HOWTO to build and run it. Then I will expect to be able to run all your system test scripts and your JUnit tests.

If you are uncertain about anything PLEASE ASK the instructor.

Document History

Home