University Homepage School Homepage School Contacts School Search

User Guide

The user guide for your group should be between 4 and 6 pages long. It is intended to provide information on the design and implementation of your robot which will be useful to anyone who want to use your system. You are encouraged to include diagrams and tables to make things clear, rather than just use textual descriptions.

The document should be targeted towards somebody at the level of a first year CS student, and should let this person fully understand how to take your code and your robot and get it playing football following the current rules. It should include:

• How to install your code, and any dependencies, onto a standard DiCE machine
• An overview of your robot from the perspective of a potential user, including
  • structural information such as how it can move, grab and kick, and what sensors it is equipped with
  • usage information such as how to turn it on, swap batteries, etc. This should include all the issues that a user might have to deal with when using your robot.
• An overview of your DiCE-resident software, including how to get it running, including any necessary calibration, and how to acutally operate it in order to play a match
• A troubleshooting guide (perhaps best presented as a table)

You are encouraged to include diagrams and tables in your report in order to make things clear, rather than just use textual descriptions. Reports may contain appendices beyond the strict page limits but markers are not required to read these appendices and in any case you advised to use them sparingly. Large illustrations and references will not count towards the page limits.

The deadline for the user guide is 4pm on Wednesday 5th April. These two documents should be submitted electronically by one group member using the submit command:

submit sdp 6 [filename]

where [filename] is the name of your user guide file; the filename must be group-[g]-userguide.pdf, where [g] is the group number.

Both reports should be submitted by a group member nominated for this purpose, and notified to the group mentor at the time of submission.

Assessment

The user guide will contribute 20% of the marks for the course, and will be marked out of 20.

The marking will be based on the following elements:

• up to 4 marks for clarity of the installation instructions
• up to 8 marks for comprehesiveness of the usage information
• up to 3 marks for the troubleshooting guide
• up to 5 marks for the quality of the presentation.

Return to the course webpage.