| Unit 4: Introduction to Software Development |
| Documentation for your assignment |
| Documentation checklist for you project The documentation for a simple program falls into four sections: � Identification. � General specification. � User information. � Program specification. Most users will need access to the first three sections; the fourth section will only be needed if the program is to be modified. The following checklist is a guide to what to include in the documentation for a program. 1. Identification � Title of program and short statement of its function. � Author and date written. � Language used and version if relevant. � Hardware requirements. 2. General specification � Description of the main action(s) of the program under normal circumstances. � File specifications. � Restrictions and/or limitations of the program. � Equations used explaining any complex procedures /techniques involved. 3. Program specification � Structure charts/flowcharts/decision tables. � Annotated listing. � Testing procedure including test data with expected output / test log. 4. User Guide � Installation instructions. � Detailed explanation of the operation of the program. � Tutorial. � Screen shots. � Troubleshooting guide. |