bbb4.jpg


  Section d - Documentation (10 marks)

You need the following mark scheme headings in section d of your project:

    • On-screen help
    • Technical documentation
    • User documentation

You will lose marks for examples of poor spelling, grammar, punctuation and communication. You will lose marks for poorly presented work. Use a spell checker. Get your work proof-read properly.

On-screen help
Start this section by providing evidence that you have included on-screen help for your user. Your user needs to be able to quickly get help when there is a problem. This is best done by your user clicking on a help button, or accessing an on-screen manual, or by providing help for a function from a menu. How have you done it? Does it work? Has your user seen and tested it? Provide evidence of a working and effective on-screen help system.

Technical documentation
Produce a coherent technical document that will aid future maintenance. This document should be aimed at technical people and should use appropriate technical language and jargon as appropriate. Start by explaining the purpose of the document. Include a title page, a contents page and copies of all design documents and relevant development documents. Include the final Requirements Specification. Make sure that you use a consistent style to present this document. All pages need a page number.

User documentation
This is a document aimed at non-technical people. It should keep technical terms to a minimum and where they need to be used, they should be clearly explained. Use must produce a coherent user manual. It should have a consistent style. Use a template. It should contain a title page, a contents page, a quick start guide including installation information, a guide to using features and functions with diagrams and / or screendumps, an FAQ, a troubleshooting section, a section dealing with backing up data, a glossary, an index and how to get further help using forums, the Internet and email addresses. All pages should have page numbers.

CHECK:

ARE YOU USING YOUR TEMPLATE(S)?

ARE YOU USING REPORT WRITING STYLE?

HAVE YOU BEEN UPDATING YOUR DIARY?