Documentation
The software solution should be self-documenting with suitable on-screen help and support for the end user(s). All necessary supporting documentation required to enable the end user to make effective use of the solution.
How will I be marked?
(i) Documentation [10 marks]
Much of the technical documentation will have been produced as a by-product of design and development work and also as part of writing up the report to date. The software solution should also include sufficient on-screen help to enable the end user to make use of the system. Some additional supporting documents will be necessary including initial set-up, getting started and troubleshooting guides, to ensure the end user can implement the solution.
How will I be marked?
(i) Documentation [10 marks]
Much of the technical documentation will have been produced as a by-product of design and development work and also as part of writing up the report to date. The software solution should also include sufficient on-screen help to enable the end user to make use of the system. Some additional supporting documents will be necessary including initial set-up, getting started and troubleshooting guides, to ensure the end user can implement the solution.
- 1-2 marks - Some limited on-screen help or badly produced supplementary user documentation covering few aspects of the system.
- 3-5 marks - The on-screen help is limited but sufficient to be able to make use of the system. The supporting documentation has significant omissions.
- 6-8 marks - There is clear on-screen support to enable the end user to use the system. The supporting documentation and on screen help is well presented and covers most aspects of the system operation with only one or two omissions e.g. troubleshooting, back-up.
- 9-10 marks - The documentation covers all aspects of the system with no omissions including installation, typical use, troubleshooting, back-up. The on-screen help and supplementary documentation makes a complete guide to the solution which is well presented and easy to follow.