Presentation is loading. Please wait.

Presentation is loading. Please wait.

CS 499 PROJECT DOCUMENTATION

Similar presentations


Presentation on theme: "CS 499 PROJECT DOCUMENTATION"— Presentation transcript:

1 CS 499 PROJECT DOCUMENTATION
Your team will deliver seven written documents this semester, with an additional Web-based document corresponding to each one. The Documents User’s Guide (Release 2 Version) Coding/Algorithm Design Document (Release 2 Version) User’s Guide (Release 3 Version) Coding/Algorithm Design Document (Release 3 Version) Customer Feedback Document (Due with Release 3) Social Implications (Due with Release 3) Post-Mortem Document (Due at Faculty Presentation)

2 USER'S GUIDE For Releases 2 & 3, your team must produce user’s guides to facilitate the use of your product by a novice. Required Contents Introductory overview of product from customer’s point of view Explicit instructions for installation (if necessary) Detailed instructions for accessing, initialization, and/or start-up Specific instructions for utilizing all functionality Troubleshooting guide for recovering from common problems Table of contents, index, and list of relevant references Illustrative figures (as needed) Expected document length: 5-10 pages (for Release 3)

3 CODING/ALGORITHM DESIGN DOCUMENT
For Releases 2 and 3, your team must produce documents that explain the principal coding and algorithm design decisions that were made during the development of your product. Required Contents Explanation of fundamental algorithms employed in the software Outline of substantial data structures, classes, and databases used Detailed explanation of explicit system calls utilized by the product Prose elaboration of code modules whose purpose is not self-evident All material to facilitate a new team member joining the team Expected document length: 5-10 pages (for Release 3)

4 CUSTOMER FEEDBACK DOCUMENT
For Release 3, your team must produce a document surveying the opinions of real and potential customer’s of your product. Required Contents A formal questionnaire for surveying customer opinions Tabulated results of administering the questionnaire List of names of the surveyed customers Optional: Videotaped interviews of customers regarding product Expected document length: 3-5 pages

5 SOCIAL IMPLICATIONS DOCUMENT
For Release 3, your team must produce a document discussing the social implications of your product. Required Contents Specific discussion of the product’s social benefits and drawbacks General discussion of long-range social implications in areas like education, health, economy, security, privacy, safety, & law Survey of each team member’s opinions regarding these issues Expected document length: 3-5 pages

6 POST-MORTEM DOCUMENT For your faculty presentation, your team must produce a document that reviews the CS 499 product development process within the context of your particular project. Required Contents Description & discussion of successful and unsuccessful portions of development process Team leader’s assessment of ways to improve effort coordination Team members’ assessment of ways to improve project leadership Team’s critique of instructor’s role in project Review of CS curriculum in preparing for project Suggested changes to curriculum & 499 administration Expected document length: 8-12 pages


Download ppt "CS 499 PROJECT DOCUMENTATION"

Similar presentations


Ads by Google