CS-489 Phase 2 Final Report

Version 1.3 (11/19/1998)

The phase 2 final report should contain the following items (items from previous reports should be updated to reflect the current state of the project):

1. Title page, including project name, team number, and names of team members.
2. Table of contents.
3. Executive summary, briefly describing project, including benefits and total project development cost.
4. Project requirements (format from textbook).
5. Analysis use cases:
   • High-level use cases for project requirements.
   • Expanded essential use cases for project requirements.
6. Conceptual model:
   • Include concepts, attributes, and associations; be sure to explain the attributes.
   • Document in one or more Rose class diagrams.
7. System behavior:
   • System sequence diagrams (Rose), with use case references or text.
   • Contracts for system operations (Word).
8. Real use cases.
9. Collaboration diagrams (don't forget the presentation layer objects, as appropriate).
10. Design class diagrams, with state diagrams as appropriate.
11. Glossary of terms and detailed design information.
    • This should include a report of all the documentation in the Rose design model, including:
      • Operation specifications (arguments, preconditions, postconditions, semantics, etc.)
      • Attribute specifications (types, description)
      • Association specifications
    • You may use Rose's "print specifications" and documentation report features to generate most of this information.
12. Code review report(s) for all code reviews (no reviewed code required).
13. Test plan:
    • Unit test
      • List of tests and results for each test.
      • Scaffold code (drivers, stubs), if any.
      • Test data files, if any.
    • System test
      • List of tests and results for each test.
      • Test scripts or other test procedure documentation.
      • Test data files, if any.
14. Program source code (preferably in a ZIP file, optionally in a UNIX tar file).
15. Final Rose model file (preferably in a ZIP file).
16. User documentation with the following content, as applicable:
    1. Instructions for executing the software.
    2. Screen displays and user prompts (you may refer to screen displays from design documentation if you wish).
    3. Expected input.
    4. Error messages and recovery procedures.
    5. Output report formats and/or examples.
    6. Input and output data file formats.
17. Issue list (updated from previous reports):
    • Risks and contingency plans:
      • Identified risks and status (potential, actual, resolved, etc.)
      • Contingency plans for identified risks.
    • Development problems and issues:
      • Pending problems.
      • Possible enhancements.
      • Other issues.
18. Project management information (see process details):
    • Time spent on the project to date, by team member and phase.
    • Total project development cost, using a reasonable hourly rate.
    • Copies of the time tracking sheets (or other form of recording) of all team members.
    • Defect data summary.
    • Team comments on development process and suggestions for improvements.
    • Listing of claimed extra credit (e.g., optional features).
19. Additional project documentation (optional):
    • Code review checklist.
    • Reference material (e.g., Rose or MFC) developed by team members (e.g., development or support managers).
    • Any other material that is relevant to understanding the project or process.

Note: The final report should be submitted in both hard-copy and electronic form. The hard-copy version should be bound in a cover.

This page was last updated on November 20, 1998. Send comments to Mark Sebern.