Documentation Information

The Assignment Documentation will contain the following headings

1.Introduction

Here briefly explain what the project is all about. For e.g, the project in the sample program , we could write -
This system is used to store customer records in a banking System.

2.Program Overview

This section should mention how you have designed the system. How many programs you have written, what are the classes you have written and briefly explain the programs you have written.

3.Program Details for each of the program

3.1.Program A

3.1.1.Program Flow

How does this program works, explain clear flow of the program, like how are the loops ended, whether the user is supposed to enter anything, how the program starts and ends.

3.1.2.Functions and Variables

Explain in detail what functions you have used and how are they designed, the main variables which are used in these programs.

Repeat the same for each of the programs.

Note
You have to provide the documentation as if it is a commercial document you are giving to your client . Please use your imagination. And also remember about 30% of your project grades depend on this. Please use intelligent comments in your source code and note that your program should not be cluttered with comments.
Also provide a header for each of the source program. The header should include your name, Date of last compilation. System used - Unix, Dos, WindowsNT, Compiler/System used and Compile Statement .

E.g
Programmer : Prashant D Pai
Last Compiled : 09/03/97
System used : HP-UNIX
Compile Statement : g++ sample.cpp