Making a great Project 2Making a great Project 2

OCR 1994/2360OCR 1994/2360

User DocumentationUser Documentation

Your User Documentation is the Your User Documentation is the instructions for how to use the instructions for how to use the systemsystem you you have createdhave created

It is NOT simply a guide to how to use the It is NOT simply a guide to how to use the software!software!

Creating a well-designed system makes Creating a well-designed system makes this section easierthis section easier

User Documentation 1User Documentation 1

You need to explain how to open the file. You need to explain how to open the file. But remember it will not be in the same But remember it will not be in the same place on the user’s system as it is on the place on the user’s system as it is on the school system!school system!

It is a good idea to describe opening the It is a good idea to describe opening the file from a desktop shortcut or from a USB file from a desktop shortcut or from a USB drivedrive

User Documentation 1User Documentation 1

You need to explain, with reasonable detail, You need to explain, with reasonable detail, how to ENTER new datahow to ENTER new data

How to AMEND the dataHow to AMEND the data

How to SAVE the dataHow to SAVE the data

You should illustrate your explanation with You should illustrate your explanation with screenshotsscreenshots

User Documentation 2User Documentation 2

The second section needs to describe how The second section needs to describe how you get OUTPUT from the systemyou get OUTPUT from the system

Explain, with reasonable detail, how to run Explain, with reasonable detail, how to run the queries and reports you have createdthe queries and reports you have created

If you have included a mail merge, describe If you have included a mail merge, describe how to run that too (the one you have how to run that too (the one you have created, not just how to mail-merge)created, not just how to mail-merge)

Describe how to print themDescribe how to print them

User Documentation 2User Documentation 2

You could, for advanced users, describe You could, for advanced users, describe how to create new queries, reports, and how to create new queries, reports, and mail merges.mail merges.

But note that an end user should never be But note that an end user should never be expected to change the data structure!expected to change the data structure!

User Documentation 3User Documentation 3

This does not need to be a separate This does not need to be a separate section if you build it into U1 and U2section if you build it into U1 and U2

You must explain at least 2 errors that can You must explain at least 2 errors that can occur while using your occur while using your systemsystem

You should also explain how to avoid the You should also explain how to avoid the errorserrors

User Documentation 3User Documentation 3

The errors should arise from things you The errors should arise from things you have built into the system, such as have built into the system, such as validation checksvalidation checks

Errors in spellings, or in creating queries, Errors in spellings, or in creating queries, are not system errorsare not system errors

Neither are problems with hardware, such Neither are problems with hardware, such as printers, or operating systems, such as as printers, or operating systems, such as Windows errorsWindows errors