A SUGGESTED STRUCTURE FOR PROGRAM DOCUMENTATION

OVERVIEW

Describe briefly your system so that the reader has a reasonable understanding of what the program does (usually most of this information can be obtained from the homework assignment) and some important concept about its implementation (it is a discrete event simulation; it is a client-server system that ..).

INSTALLATION

Here you indicate what files are part of your program, how the program(s) is compiled, and all else that is necessary to do before your program(s) can be launched and used.

USER MANUAL

Here you indicate how to execute your program(s) and then how to interact with it. Be sure to say if and what data files are required or created by the program.

TECHNICAL SUMMARY

Describe in english, possibly with diagrams, the design and software structure of your system. Concentrate on what are the objects used and how they interact. Give some high level pseudo-code for the main components of your system. If there is some interesting technical issue, describe it.

PROGRAM STRUCTURE

Here you list the files used in your program and indicate the basic functions they contain. Have files that represent the objects of your program, just as if you were in C++. Don't say too much about the content of the files. If the files are well documented it is unnecessary.