Form and Format of Deliverables
- Looseleaf notebook (one inch thick)
- Title page
- Tab for each section (deliverable), see below
- Print documents on both sides of pages for conciseness
- 3.5" floppy disk containing
- Deliverable document: teamX-2003.doc
- Code, database, webpages: teamX-2003.zip
- PowerPoint slides: teamX-2003.ppt
0. Team Website
- Name and contact information for each team member
- Links to deliverables as they come due, and modified as working documents
1. Overview and Requirements Document
- One-page agreement that describes the system and objectives -
signed by your instructor, client, and team members
- More detailed description (2-4 pages) of the system
to be delivered to your client
- Requirements (2-10 pages - depends, for eample, on the number of use cases)
- Project Planning and Risk Analysis: see Pressman Chapters 5 & 6
- Scope of project
- Resources required
- Project estimation (rough time estimate for each component)
- Make/buy decision
- Risk analysis
- Use Cases and User Interface Prototyping: Ambler Chap 3&4
- Use Case simple prose: see Ambler p. 55 bottom, Fowler p 40
- Use Case diagrams: see Ambler figures on pp46,58,60,61; Fowler Fig 3-2
- 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
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. If possible and appropriate, try to do an O-O design!
- Conventional Design
- 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
- Object-Oriented Design
- class diagram (per Fowler Fig 4-1)
- sequence diagram for each use case (per Fowler Fig 5-1)
- package diagram (per Fowler Fig 7-1)
- state diagram for each class (per Fowler Fig 8-1)
- Hardware and/or Database and/or Website (as necessary for project)
- 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
- Implementation tools - Dreamweaver, etc.
- Printout of web pages
3. Testing Document
- Conventional: Pressman Chap 17&18
- Object-Oriented: test cases per list in Pressman p 637-8
each test has:
testID, associated class, purpose of test, list of test steps
4. Users Manual
- Standard manual instructing users how to use the system
- Must have a section on "System Installation"
that specifies the environment and installation procedures
necessary to install the system. For example, given the client-server
architecture of many of your project systems,
this entails specifying the required server hardware and software,
ditto for a client machine, the files that must be uploaded
to the server (include a disk containing the files), and any
installation procedures that must be followed. In other words, a client
given this information should be able to install your system in another
(presumably the client's) environment that has the specified equipment.
(Before the end of the semester I will test your installation procedures
by trying to install your system either on another server or in a
different folder on the development server.)
- Include screen shots for a Web interface
Final Documentation (1" looseleaf notebook with titlepage and following tabs)
- Overview and Requirements Document (updated)
- Design Document (conventional or object-oriented, updated)
- Testing Document (conventional or object-oriented)
- Users Manual
- Hardcopy of presentation Powerpoint slides (6 per page)
- Difficulties encountered on this project and recommendations to avoid these
in future offerings of the course
- General recommendations for improving the project portion of future offerings of the course
- Recommendations for future work on this project by other teams
- Floppy disk as specified above
Technical Paper for Possible Publication
- Typical sections include:
- Introduction (e.g., from course 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. (document any results, describe utility of system, etc.)
- Conclusions, Implications, Recommendations, and Summary (make projections)
- Paper format (IEEE format,
except single column is also acceptable, and the number of pages is limited to 8).
The main IEEE requirements are (see sample at IEEE site above):
- Type-style and Fonts. Times font is preferred, Times Roman may also be used.
- The Main Title should be centered in Times 14-point, boldface type.
Initially capitalize nouns, pronouns, verbs, adjectives, and adverbs;
do not capitalize articles, coordinate conjunctions, or prepositions (unless the title begins with such a word).
Leave two blank lines after the title.
- Author's Name(s) and Affiliation(s) are to be centered beneath the title and printed in Times 12-point,
non-boldface type. This information is to be followed by two blank lines.
- The Abstract is to be in fully-justified italicized text, below the author and affiliation information.
Use the word "Abstract" as the title, in 12-point Times, boldface type, initially capitalized.
The abstract is to be in 10-point, single-spaced type.
- Main Text. Type main text in 10-point Times, single-spaced. Do NOT use double-spacing.
- First Order Headings should be Times 12-point boldface, initially capitalized,
flush left, with one blank line before, and one blank line after.
- Second Order Headings should be Times 11-point boldface, initially capitalized, flush left,
with one blank line before, and one after.
- References. Number and List alphabetically by first author all bibliographical references in 9-point Times,
single-spaced, at the end of your paper.
When referenced in the text, enclose the citation number in square brackets, for example .