| CG4
- Maintenance Documentation |
|
Preliminaries...(Suggestions) |
|
|
Listings of variables etc can be done as tables in a word document. |
| |
|
Maintenance Documentation (10 Marks) |
|
|
| Section |
Marks |
|
Annotated Listing |
5 |
| |
Print out a listing of all your code (make sure
it is fully annotated) Make sure your annotation shows that
you understand the code.
|
|
|
Procedures/Subroutines details |
3 |
| |
List and document all subroutines
used. Explain any parameters
passed by each subroutine. |
|
|
List of variables |
2 |
| |
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)
|
|
|
|
HINT : |
It is better and less tedious to include annotations in your program as
you are writing the code. |
| |
| |
