Our principal source of documentation this
semester will be the project Web sites, so we
must ensure that they adequately document
the projects for all potential viewers.
Who are the potential viewers?
• The team members for the project
• The CS 499 course instructor
• Other CS faculty
• Future CS Senior Project participants
1
Each release has certain minimal expected Web
documentation, as does the project as a whole.
Release One
Release Two
• Main project page
 Mission statement
 Site map
 Link to 425 material
• Team bios
 Photos & e-mail addresses
 Assigned tasks
• Code documentation plan
• Release One plan (due early in cycle)
 Full implementation details
 Planned features
 Day-by day timeline
 Specific member responsibilities
• Release Two outline
• Release Three sketch
• Updates to earlier pages
 Including Release One details
• Release Two plan (due early in cycle)
 Full implementation details
 Planned features
 Day-by day timeline
 Specific member responsibilities
• Preliminary User’s Guide
 On-line version
 Link to text version
• Coding/Algorithm Design Document
 On-line version
 Link to text version
• Release Three outline
2
Release Three
• Updates to earlier pages
 Including Release Two details
 Coding/Algorithm Design Document
• Release Three plan (due early in cycle)
 Full implementation details
 Planned features
 Day-by-day timeline
 Specific member responsibilities
• Full User’s Guide
 On-line version
 Link to text version
• Customer Feedback Document
 On-line version
 Link to text version
• Social Implications Document
 On-line version
 Link to text version
Project (due by presentation date)
• Final versions of all earlier pages
 Including Release Three details
 Final User’s Guide
 Customer Feedback Document
 Social Implications Document
• Post-Mortem Document
 On-line version
 Link to text version
• Link to faculty presentation
Remember:
Your Web site is neither an in-class
presentation nor a textual document.
Make sure that desired information is easy
to locate and pleasantly presented!
3
•
•
•
•
•
•
•
•
•
•
Curtail the length of any given page (one or two page-scrolls)
Facilitate obvious links (avoid having to repeatedly back-page)
Consider using a Table of Contents hyperlinked list
Enhance Web site regularly (daily or at least semi-weekly)
Don’t rely on text alone, but don’t overdo the bells & whistles
Use reasonable fonts and color schemes
Don’t just convert text documents into Web pages: Redesign!
Documentation counts as half of the 499 grade
Your Web site design counts as one-eighth of the 499 grade
You should expect about one-quarter of your team’s time to be
spend on textual and Web documentation
4