Home  Back Topics CD Orders  INDEX 
CG2 - Program Documentation
Preliminaries...(Suggestions)
Listings of variables etc can be done as tables in a word document.
 
Program Documentation (15 Marks)
Section Marks
Data structures and variables 3
  List and document all the variables used in the program.
(State the name, data type and a brief explanation of each.)

List and document all data structures used. (These should match and extend the ones you described in the Design section)

List and document all objects used (for Visual language programs)

List and document all subroutines used.

 

  
User Interface 2
  Provide screenshots of your user interface.

Explain the features that make it fit for audience and purpose.

 

  
Annotated Listings 10
  Print out a listing of all your code (make sure it is fully annotated)

Make sure your annotation shows that you understand the code.

 

  
HINT : It is better and less tedious to include annotations in your program as you are writing the code.