Home
Up


Project 2 Guidance - Documentation

USER DOCUMENTATION

This sub-section has a total of 7 marks allocated to it, which are spread out amongst its different aspects.

The documentation for this section should assume that the user is familiar with the various software packages used within the system and that instructions should deal with the various parts of the system that the candidate created.


USER DOCUMENTATION - Show a Potential User how to Enter, Amend and Save Data

This has a total of 2 marks allocated to it. Each marking point is in addition to the previous point. Candidates cannot achieve a particular marking point without meeting all the previous ones.

1 mark

  • Produce a basic user guide showing how to enter and save data.
    • This will be for any aspect of the solution. A competent user must be able to follow the instructions and be able to enter data and save the file.

2 marks

  • Produce a detailed user guide showing how to enter, amend and save data.
    • The candidate will produce a user guide, which enables a competent user to load your database, spreadsheet or standard letter. It will allow them to add new records. It will allow them to change data and then save the work. You will need to cover each piece of software you have used. You will use screen dumps to illustrate your work so that the user guide is easy to follow.

USER DOCUMENTATION - Show a Potential User how to Process and Output Data

This has a total of 3 marks allocated to it, which are spread out amongst its different aspects. Each marking point is an extension of the one above it. Each has to be achieved in succession.

1 mark

  • Produce a basic user guide showing how to process and output data.
    • This can simply be showing somebody how to perform a search on your database and print out the results.

2 marks

  • Produce a detailed user guide showing how to process and output data.
    • This will match the processing identified in the candidate’s Analysis section, which was also used to form the testing strategy, under the heading ‘Identify the inputs, outputs and processing required’. The candidate will produce descriptions of how to perform searches on their database, how to do calculations on their spreadsheet, and how to generate standard letters. Screen dumps will be included to illustrate the guide.

3 marks

  • Produce a detailed user guide showing how to process and output data for all aspects of the solution.
    • Candidates must produce a user guide which covers every aspect of the solution, as specified in the Analysis section. A variety of searches on the database and a variety of calculations on the spreadsheet will have to be illustrated. They will show how to produce different types of standard letter and different forms of output in terms of graphs and different layouts.
    • How to produce the output formats, which were created in the implementation section, should be demonstrated. Candidates should demonstrate how the output formats, which were created in the implementation section, were produced.

USER DOCUMENTATION - Show a Potential User How to Avoid Problems

To gain 2 marks candidates will just do everything for 1 mark and then describe how users can put errors right.

These errors are NOT error messages produced by the computer, such as the printer not working because it is out of paper, but errors produced by the candidate’s system e.g. errors generated by validation routines.

1 mark

  • List errors, which the user should avoid when using the system.
    • Two errors have to be listed that the user should avoid when using the system. This is not a trouble-shooting guide to the software or the hardware. A common error is mistyping search conditions. This can be avoided by writing down the search conditions before typing them in and then double-checking them prior to executing the search.

2 marks

  • List errors, which the user should avoid when using the system. Describe methods of rectifying the errors.
    • Candidates must now describe ways the errors can be corrected. For example, the wrong search conditions would result in wrong output. Putting this right is simply a matter of retyping the search conditions.

<Click to move to the top of the page>