Download presentation
Presentation is loading. Please wait.
Published byJacob Hunter Modified over 9 years ago
2
1 Who are the potential viewers? 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. The team members for the project The team members for the project The CS 499 course instructor The CS 499 course instructor Other CS faculty Other CS faculty Future CS Senior Project participants Future CS Senior Project participants
3
2 Each release has certain minimal expected Web documentation, as does the project as a whole. Release One Main project page Main project page Mission statement Mission statement Site map Site map Link to 425 material Link to 425 material Team bios Team bios Photos & e-mail addresses Photos & e-mail addresses Assigned tasks Assigned tasks Code documentation plan Code documentation plan Release One plan (due early in cycle) Release One plan (due early in cycle) Full implementation details Full implementation details Planned features Planned features Day-by day timeline Day-by day timeline Specific member responsibilities Specific member responsibilities Release Two outline Release Two outline Release Three sketch Release Three sketch Release Two Updates to earlier pages Updates to earlier pages Including Release One details Including Release One details Release Two plan (due early in cycle) Release Two plan (due early in cycle) Full implementation details Full implementation details Planned features Planned features Day-by day timeline Day-by day timeline Specific member responsibilities Specific member responsibilities Preliminary User’s Guide Preliminary User’s Guide On-line version On-line version Link to text version Link to text version Coding/Algorithm Design Document Coding/Algorithm Design Document On-line version On-line version Link to text version Link to text version Release Three outline Release Three outline
4
3 Release Three Updates to earlier pages Updates to earlier pages Including Release Two details Including Release Two details Coding/Algorithm Design Document Coding/Algorithm Design Document Release Three plan (due early in cycle) Release Three plan (due early in cycle) Full implementation details Full implementation details Planned features Planned features Day-by-day timeline Day-by-day timeline Specific member responsibilities Specific member responsibilities Full User’s Guide Full User’s Guide On-line version On-line version Link to text version Link to text version Customer Feedback Document Customer Feedback Document On-line version On-line version Link to text version Link to text version Social Implications Document Social Implications Document On-line version On-line version Link to text version Link to text version Project (due by presentation date) Final versions of all earlier pages Final versions of all earlier pages Including Release Three details Including Release Three details Final User’s Guide Final User’s Guide Customer Feedback Document Customer Feedback Document Social Implications Document Social Implications Document Post-Mortem Document Post-Mortem Document On-line version On-line version Link to text version Link to text version Link to faculty presentation 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! 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!
5
4 Curtail the length of any given page (one or two page-scrolls)Curtail the length of any given page (one or two page-scrolls) Facilitate obvious links (avoid having to repeatedly back-page)Facilitate obvious links (avoid having to repeatedly back-page) Consider using a Table of Contents hyperlinked listConsider using a Table of Contents hyperlinked list Enhance Web site regularly (daily or at least semi-weekly)Enhance Web site regularly (daily or at least semi-weekly) Don’t rely on text alone, but don’t overdo the bells & whistlesDon’t rely on text alone, but don’t overdo the bells & whistles Use reasonable fonts and color schemesUse reasonable fonts and color schemes Don’t just convert text documents into Web pages: Redesign!Don’t just convert text documents into Web pages: Redesign! Documentation counts as half of the 499 gradeDocumentation counts as half of the 499 grade Your Web site design counts as one-eighth of the 499 gradeYour 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 documentationYou should expect about one-quarter of your team’s time to be spend on textual and Web documentation
Similar presentations
© 2024 SlidePlayer.com. Inc.
All rights reserved.