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 wants to use your system.

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 to demonstrate what it is capable of. It should include:

• How to install your code, and any dependencies, onto an appropriate platform
• An overview of your robot from the perspective of a potential user, including
  • structural information such as how it can move, what sensors it is equipped with, and other functionality such as grabbers if appropriate
  • 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 software, including how to get it running, any necessary calibration, and how to actually operate it in order to use the robot to acheive its task
• 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 are 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 Friday 23rd March. This document should be submitted electronically by one group member using the submit command:

submit sdp ug [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.

The report should be submitted by a group member nominated for this purpose, and also emailed to the group mentor and TA (Ludovica Luisa Vissat) at the time of submission.

Assessment

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

The marking will be based on the following elements:

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

You may find it useful to look at this general feedback for last year's user guide, noting that some of the points are specific to last year's robot football task.

Return to the course webpage.