Prototype Deliverable Template

You are to use this document as a template to prepare your prototype deliverable documentation.

There are three major parts to this deliverable. The first part is the demonstration of your prototype, which you will arrange separately with the instructor.

The second part is a installation/user manual that is intended to provide enough information to locate and execute your prototype. The instructor, or someone else, is going to have to be able to locate and execute your prototype on the appropriate target platform. To enable that, you must clearly indicate what target platform is necessary, how to access the software and how to install the system so that it runs on the target platform. Once your prototype is installed, there will have to be instructions to guide the use of your system.

Finally, there needs to be a guide to the source code of your system, in which you define (in language and environment specific terms) how your system is divided into modules or files.

Use this template to complete your prototype documentation.

-->Cut Here<--

[Project Name] Design Document

v

Winter Quarter 1996
2/23/96

Document Author:

Name of author

Project Sponsors:

GregoryAbowd
Others?

[Project Name] Team:

Name (Manager)
Name (Architect)
Name (Programmer)
Name (Technical Writer)

Project Description of Target System

If I have to tell you what to put here, you are in bad shape!

Installation manual

Include in this section COMPLETE instructions on how to obtain and install your software system. This includes indicating the expected target platform as well as procedures for accessing the code (e.g., you could include a link to an ftp'able compressed archive of your system) and building it for the target platform.

User guide

Include in this section directions to a potential user as to how they are expected to interact with your prototype. You can include specific directions using screen dumps and textual explanations. Consider this document your first attempt at a user's manual that would accompany the final system.

Guide to the source code

In this section, you must describe exactly how your code is structured. This is a fairly straightforward exercise for "traditional" procedural or object-oriented systems on a system like unix. If you are developing your system in another integrated development environment (Visual Basic or Delphi, for example) you need to indicate what outside packages are used by your project (VBX's in Visual Basic, for instance) as well as the defined units you created (modules or forms in Visual Basic).
Link to [Project Name] Project Notebook
Last Modified 1/17/96 -- Gregory Abowd