Documentation Standards

Project Legacy

Audience and goals of the Legacy

The project legacy is the collection of all documents listed in this standard plus additional information that will assist student teams in the future should your project be extended or maintained.

The project legacy itself is a 3-ring binder that contains all of the information described below. Use tabbed dividers to organize the legacy and make it easy to use.

Electronic versions of all of the components of the legacy will be located in the appropriate directories of your project directory. The project directory will be tranferred to the S2S repository as soon as all development is complete.

---

Contents of the Legacy

The purpose of the legacy is to gather all of the relevant and important information in one place in order to ensure that your product can be enhanced with minimal difficulty. The legacy will include the following:

• Introductory information:
  • A file legacy-toc.html (or legacy-toc.txt), which will describe the contents of the project legacy; this file should be placed in the home/ directory. It will be an overview of the entire notebook.
  • The team's home page
• Descriptive information for future teams, users, and adminstrators:
  • The final README file
  • The "What do I need to use this software?" page, called TO-USE.html
  • Any help or reference information that is not embedded within the product
• Legal information:
  • A SOURCES.html file that acknowledges all sources of images, graphics, etc.
  • Copies of legal permissions for graphics, artwork, and other materials in the product if not originated within the team.
• Final versions of project documents
  • bid document
  • Project Plan
  • SRS
  • SDS
  • V&V Plan
  • V&V Results
• Information about the implemented product.
  • An implementation overview, doc/impl-overview.html, which will serve as an introduction or overview of the implementation section. The information in this section should help a team that is studying your legacy understand exactly what you have included in the implementation section and why.
  • Any programming standards or other guidelines that the team developed.
  • Printouts of selected source files for the final version of the product. The choice of files should include key or representative portions of the product. If you have questions about what should be included, contact the instructor well ahead of the date for your turnover meeting.
• Team process information:
  • The Final Report
  • The audit response files, including the response to the final audit (called response-final.html; it should be similar in format to the earlier response files)
  • The client meeting reports
  • The activity reports
  • Copies of the slides from the team's presentations (at least the final version)
• Copies of important or key email messages (to/from the CEO, the customer, a mentor, between team members, etc.), if any
• Other relevant sections, depending upon the nature of the project. For example, include the User's Manual if one was created or pointers to documentation about tools or platforms used in creating the product.

It is helpful to include floppies, a CD, or a zip disk with the most recent versions of all documents, reports, and the product itself.

During the team's Legacy Turn-In meeting, the instructor will inspect the legacy notebook for completeness and to ensure that all parts have been completed correctly. The bullet list above will serve as the agenda for the Legacy Turn-In meeting.