Check List for task 5 -User / technical Documentation

There are five marks for user documentation. To gain these marks you must include the following. Firstly your documentation will contain two parts. The user guide and the technical documentation. The Documentation is important because it is here that you show the examineer all the skills you have used in creating the project. You must remember the actual project so uses lots of screen shots of it so that s/he can tell how good it is.

The user guide

The user guide is aimed at an office worker who will use the package for routine tasks like data entry or updating. It will

1. Tell the user how to start the computer and how to open the package you have made.
2. Tell the user how to enter the data for a new customer
3. Explain any likely problems (for example if you have made an input mask and they try to enter the wrong data type).
4. Once you have made the user guide get someone to try it out, prepare a tick list to show that each stage works get them to sign the document and comment on any problems they found.
5. Modify your instructions in the light of any problems and make a record of these changes.
6. Print out as a separate document ideally as a booklet (possibly fold the A4 paper in two to make A5)
7. It will contain lots of images and the text will be simple and clear.
8. Include an index and page numbering.

The Technical Guide

This is written so that the office manager can perform the following tasks

1. Create a new table
2. Add or delete fields from existing tables
3. Modify any data input masks
4. Modify any default data values
5. Modify any relationships between the tables.
6. Add a new form
7. Modify existing forms
8. Add new query
9. Modify any existing queries
10. This document is best presented as a small booklet with the same look and feel as the user guide.

© LEV