manual.md

#User Manual There are 10 marks available for this section.

In this section you must produce documentation that will enable the user to operate your system.

To do this you will need to include:

• An introduction that specifies the purpose of the system and who the intended audience are
• Instructions to install and start the application
• A tutorial that describes all of the functions of the application, including:
  • Leading the user through the application and explain the menu options, dialogue boxes and printed reports
  • Explain possible error messages from the system and from your own error-trapping routines and what to do about them
  • Explain how to save data
• Describe any limitations, input validation and things the system will not do
• Say when and how to use back-up and recovery procedures

##Introduction In the introduction clearly state the purpose of the system and who are the intended audience for the system. Be sure to give an overview of the functionality and not just an idea of what type of system it is.

##Installation You system has been most likely designed for a particular platform therefore you must make clear any assumptions you are making about the existing hardware and software configuration required to install your system.

In most cases you will need to identify:

• The hardware configuration required (refer to your design where you specified this)
• The operating system version
• Any required applications:
  • Please see below for details on your particular environment
• How to install the required applications (if necessary)

###Required Applications Your system requires at least the following applications to be installed (there may be more for your particular implementation):

• PyQt Python Projects:
  • Qt
  • SIP
  • PyQt
  • Python 3
• Python Server-side Projects:
  • Apache Web Server
  • MySQL
  • MySQL.connector
  • Python 3

###Evidence You should give clear step-by-step instructions with annotated screenshots explaining how to install and then launch your system on the configuration given in the prerequisites.

##Tutorial You must demonstrate how to operate each function of your system. If you are making assumptions about the abilities of the user then you should state these clearly before starting the tutorial.

Generally, it is better to make no assumptions about prior knowledge but this will depend on your user.

Arrange the tutorial by task, imagine the user were asking you questions that you are going to answer - like a FAQ - Frequently Asked Questions. For example:

• How do you add a new order?
• How can I see a report of all the student grades?

When evidencing each question you must use annotated screenshots. It is important that the user can visualise what you are describing. Be sure to describe the process of completing a given task step-by-step - don’t be tempted to miss any stages out.

##Saving Explain clearly how data is saved in your system. In most cases it happens automatically when a database query is executed.

##Limitations. Is there anything that the system doesn’t do that might be expected of it? Be sure to explain briefly why this is the case.

##Errors. There will be several places in your system where errors can result from user actions. These may be down to:

• User error
• Program bugs
• Incomplete sections of code

You must explain step-by-step with annotated screenshots how to reproduce each error and also how to recover from these errors.

##Back-up/Recovery. Provide a tutorial that explains how to back-up any data that the system stores and also how to restore the system from a provided back-up.

Again, make sure you explain clearly and provide step-by-step instructions with annotated screenshots.

##Mark Scheme The user manual is assessed based on two criteria:

- the **complexity** of your project
- the **quality** of your written communication.

You can only score in a particular mark band if your project is appropriately complex for that mark band and you meet the quality of communication criteria for the same mark band.

If you meet the complexity criteria but not the quality of communication criteria then your mark will drop by one mark band.

###Quality of Communication Criteria

Projects in Mark Band 1-2	Projects in Mark Band 3-4	Projects in Mark Band 5-6	Projects in Mark Band 7-8	Projects in Mark Band 9-10
QWC1 Text has been word processed.	QWC1 Text has been word processed.	QWC1 Text has been word processed.	QWC1 Text has been word processed using appropriate headers and footers.	QWC1 Text has been word processed using appropriate headers and footers.
QWC2 There may be some errors of spelling, punctuation and grammar.	QWC2 There are few, if any, errors of spelling, punctuation and grammar.	QWC2 There are few, if any, errors of spelling, punctuation and grammar. If there are, the meaning is just about clear.	QWC2 There are few, if any, errors of spelling, punctuation and grammar. If there are, the meaning is mostly clear.	QWC2 There are few, if any, errors of spelling, punctuation and grammar. If there are, the meaning is still clear.
QWC3 The candidate may have selected and used a form and style of writing which has many deficiencies. Ideas are not always clearly expressed.	QWC3 The candidate has selected and used a form and style of writing which may have many deficiencies.	QWC3 The candidate has selected and used a form and style of writing which may have some deficiencies.	QWC3 The candidate has selected and used a form and style of writing appropriate to the purpose and has expressed ideas clearly and fluently.	QWC3 The candidate has selected and used a form and style of writing appropriate to the purpose and has expressed ideas clearly and fluently.
QWC4 Sentences and paragraphs may not always be well- connected.	QWC4 Sentences and paragraphs may not always be well- connected.	QWC4 Sentences and paragraphs may not always be well- connected.	QWC4 Sentences and paragraphs follow on from one another clearly and coherently.	QWC4 Sentences and paragraphs follow on from one another clearly and coherently.
QWC5 Specialist vocabulary has been used sparingly or not at all.	QWC5 Specialist vocabulary has been used sparingly.	QWC5 Specialist vocabulary has been used but not always to the best effect.	QWC5 Appropriate specialist vocabulary has been used.	QWC5 Appropriate specialist vocabulary has been used.

##User Manual Criteria

0 marks	1-2 marks	3-4 marks	5-6 marks	7-8 marks	9-10 marks
Candidate has not provided anything useful	Meet 3/5 quality of written communication criteria	Meet 4/5 quality of written communication criteria	Meet 4/5 quality of written communication criteria	Meet 4/5 quality of written communication criteria	Meet 4/5 quality of written communication criteria
	An inadequate description of how to use the system	A description of how to use the system provided but of a nature that would not enable easy use of the system	A description of how to use the syste that is just about adequate and which includes at least one of the following:	A fairly detailed description of how to use the system, some samples of actual screen displays in use and some samples of error messages and error recovery procedures, but without being comprehensive	A detailed description of how to use the system including the necessary number of samples of actual screen displays in use
	At least one of the following:	At least one of the following:	some samples of actual screen displays in use	At least two of the following:	Samples of error messages
	A contents page	A contents page	Some samples of error messages	A contents page	Error recovery procedures appropriate for prospective user
	A brief introduction	A brief introduction	Error recovery procedures	A brief introduction	A contents page
	Installation instructions	Installation instructions	At least one of the following:	A brief introduction
			A contents page	Installation instructions	A brief introduction
			Installation instructions		Installation instructions