CS3733-E04 Project

The course project constitutes a significant portion of your grade. This page contains the information, often via links to other pages, you need for your project and any other helpful information I can think of. Please Let me know if you find an error or omission, or if you have a suggestion for improvement.

General Description

You are going to implement a computer program to help dieters plan their meals and track their food consumption and weight. Your customer is Mr. Russell Customer, an avid healthy lifestyle promoter. Russell has hired your company to implement dieter logbook program that he can distribute with his new book, "Eat Right for Fun and Profit." You will have to elicit and document the requirements from Russell as the project progresses. Some of the requirements will be given during class. Others may require you to talk to your customer outside of class.

You can meet all of the project stakeholders by viewing the stakeholders' page. Russell Customer has written a description of the system for you to start with.

Your team's assignment

Your team is responsible for delivering a complete program. Since there is limited time, Russell recognizes that you will probably not be able to implement everything he'd like to have, but both he and Mr. Draco insist that you deliver working, valuable software at the end of the term. It is up to you to ensure that you work with Russell to prioritize his needs and deliver the most important parts of the system for the initial release.

Artifacts

You will produce several artifacts for the project. Some will be required by the instructor, some will be required by the development process your team chooses to adopt. There are two types of artifacts:

  1. Code artifacts. This is the source code, object code, and any other code-like artifact you produce to implement components.
  2. Process artifacts. These artifacts are non-code artifacts that enable someone to understand what you are building, how you are building it, the status of your project, and so on. All of the non-code artifacts will be contained in your project notebook.

Templates

There are several templates that you can use as starting points for your documents. In most cases, the templates contain more than you need for this course. Therefore, you will need to remove those sections that do not apply. You should be able to explain your reasoning for doing this. One way of ensuring that you can do this is to leave the section header in and replace the contents of the section with a note about why it is not applicable to your project. If you design your own format, you should make sure that you cover the relevant parts described in the templates here.

If a template has blue text, that text is meant to be removed and replaced by the actual content. The blue text is often a set of instructions about how to fill out that particular section of the document.

The templates are

Project Notebook

The project notebook will be divided into several sections. The following is an outline of the sections and their contents.

  1. Introduction
  2. Requirements
    1. Vision
    2. Use Case Model
    3. Nonfunctional Requirements
    4. System traceability document
  3. Analysis and Design
    1. Class and object model
    2. Architectural considerations.
  4. Implementation
    1. Programming standards
    2. Implementation model
  5. Testing and Quality
    1. Quality plan
    2. Test cases
    3. Test results
    4. Review and inspection results
  6. End User Documentation
  7. Plans and Reviews
    1. Project plan
    2. Iteration Plans
    3. Iteration Assessments
  8. Other Project Documents
    1. Process description
    2. Risk list
  9. Communications
  10. Experiences and Lessons Learned

Modified: 17-May-2004 3
Gary Pollice