Form and Format of Deliverables
- Looseleaf notebook (one inch thick)
- Title page
- Tab for each section, see below
- Print documents on both sides of pages for conciseness
- CD or 3.5-inch floppy disk containing
- Deliverable document: teamX-2005.doc
- Code, database, webpages: teamX-2005.zip
- PowerPoint slides: teamX-2005.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
The overview and requirements document consists of several parts, see below.
This document should be posted on your team website and hardcopy
delivered to your instructor on the date due.
- Overview (one page)
- One-page description of the system to be delivered to your customer
- Project Planning and Risk Analysis (2-3 pages, brief and straightforward)
- Scope of project
- Resources required
- Project estimation (rough time estimate for each component)
- Make/buy decision
- Risk analysis
- Use Cases and User Interface Prototyping (2-10 pages, done carefully, size depends
on the project since some projects will have, for example, more use cases than others)
- Use Cases: in the form of steps, scenarios, diagrams, etc.
- User Interface: in the form of prototype model, flow diagrams, etc.
- Future Work (one page)
- Projection as to what will be added to the project in CS616 (for CS615 projects)
- Work that might be done to extend this project by future teams (for CS616 projects)
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
- Data Flow Diagram (DFD): at least Level 0 (Context) and Level 1
- Entity Relationship Diagram (ERD)
- State Transition Diagram (STD)
- Data Dictionary
- Design Model: description of the following items as appropriate
- Data Design
- Architectural Design
- Interface Design (e.g., Web Interface)
- Component Level Design
- Hardware and/or Database and/or Website (as necessary for project)
- Database (reference: 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.
- Purpose of Website
- Description of theme, etc.
- Navigation method
- Implementation tools - Frontpage, Dreamweaver, etc.
- Printout of web pages
3. Implementation Document
- One-page overview of the implementation: strategy, computer languages used, rationale for choices, etc.
- Code listings, etc. (only include hardcopy of the key procedures/classes, but include full listing on CD/disk)
4. Testing Document
- See appropriate chapters in Pressman
- Test cases should be listed with each test having appropriate information, such as
testID, associated class, purpose of test, list of test steps
5. 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 customer's) environment that has the specified equipment.
(Before the end of the semester the graduate assistant or the QA team 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
- 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
Final Documentation (1" looseleaf notebook with titlepage and following tabs)
- Overview and Requirements Document (updated)
- Design Document (updated)
- Implementation Document: Code listings, etc. (hardcopy only summary, full listing on CD/disk)
- Testing Document (updated)
- Users Manual: e.g., include screen shots of web interface (updated)
- Hardcopy of presentation Powerpoint slides (6 per page)
- Floppy disk (as specified above) placed in a pocket of (or taped to) the inside front cover of the notebook
Technical Paper for Possible Publication
- Typical sections include:
- Introduction (e.g., from course website project description and the overview/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 preferable, 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 .