- Names and contact information for each team member
- Log of all meetings with team, client, instructor, or support personnel
- meeting type: team, client, instructor, support
- brief summary of meeting
- Log of weekly highlights of activities and accomplishments
- All deliverables as they come due, and modified as working documents
Form and Format of Deliverables
- Looseleaf notebook with
- Tab for each deliverable (Final Document will have 7 tabs, see below)
1. Overview and Requirements Document
The overview and requirements document consists of the three parts.
The first part should be brief: a one-page client agreement
plus 2-4 additional pages.
The second part should be done carefully, 2-10 pages, and its size depends
on the project since some projects will have,
for example, more use cases than others.
The first two parts concern only what will be delivered this semester.
The third part should be no more than one page and
is simply what your team estimates
they will add to the project system next semester.
This document should be posted on your team website and hardcopy
delivered to your instructor on the date due.
- Project Planning and Risk Analysis: see Pressman Chapters 5 & 6
- One-page description of the system to be delivered to your
client, signed by client
- Scope of project
- Resources required
- Project estimation (rough time estimate for each component)
- Make/buy decision
- Risk analysis
- Use Cases and User Interface Prototyping: see Ambler Chapters 3 & 4
- Use Case simple prose: see Ambler p. 55 bottom
- Use Case diagrams: see Ambler figures on pp. 46, 58, 60, 61
- Use Case steps: see Ambler figures on pp. 54, 55, 62
- Use Case scenarios: see Ambler p. 117
- User Interface prototype model: see Ambler figures on pp. 68, 70
- User Interface flow diagrams: see Ambler figure on p. 73
- One-page projection as to
what will be added to the project in CS616
2. Design Document
The design document will vary depending of the nature of your project -
that is, whether it has hardware, a web interface to a database, a website,
a database, etc.
- Analysis Model: the following items as appropriate, see Pressman Chapters 11 & 12
- Data Flow Diagram (DFD): at least Level 0 (Context) & Level 1
- Entity Relationship Diagram (ERD)
- State Transition Diagram (STD)
- Data Dictionary
- Design Model: description of the following items as appropriate
- Data Design: see Pressman Chapter 13
- Architectural Design: see Pressman Chapter 14
- Interface Design: see Pressman Chapter 15 (e.g., Web Interface)
- Component Level Design: see Pressman Chapter 16
- Database: see, for example, Database System Concepts by Silberschatz, et al.
- Entity relationship diagram (ERD)
- Table structures, each showing
- All fields (columns)
- Field format and length: e.g., char(10), integer(8), etc.
- Primary Keys, Foreign Keys, etc.
- List of reports, queries, etc. (if any)
- Purpose of Website
- Description of theme, etc.
- Navigation method
- Proposed implementation tools
(looseleaf notebook with titlepage and the following tabs)
- Overview and Requirements Document (updated)
- Design Document (updated)
- Implementation Document: Code listings, etc.
- Testing Document: see Pressman, Chapters 17 & 18
- Users Manual: e.g., include screen shots of web interface
- Printout of Web Pages from Team Website
- Draft of Paper for Publication - typical sections include:
- Introduction (e.g., from website project description & overview and req. doc.)
- Relevance in the context of other work (search and document similar work)
- Methodology (e.g., condense material from design document)
- Results - usefulness, etc. (make guesses here, most will come next semester)
- Conclusions, Implications, Recommendations, and Summary (make projections)