You will use the Wiki feature in GitHub to write your user manual (or manuals).

1 Overview

Your team will complete a comprehensive Prototype User Manual. Depending on your Prototype, this may take the form of one large manual or multiple smaller manuals.

Each User Manual (UM) must be:

1. Comprehensive - all prototype functionality with which the user will interact must be documented.

2. Accurate - all prose, figures, and examples must document current functionality. Any time the prototype changes, the manual must change.

3. Approachable - know your audience. The target audience for your User Manual (UM) is made up of end users (i.e., not developers).

   • In some cases your audience may include external developers (e.g., if you provide a REST API or importable library)1.

   • Discuss any possible exceptions with your mentor and teacher.

2 Contributions

Everyone must contribute to the user manual (or manuals). At the top of each wiki page or section heading add an author block. Refer to the Lab 3 prompt.

This author block and the wiki edit history will be used to check individual contributions.

3 Requirements

Any part of your Prototype that involves user interactions must be documented in the user manual (i.e., have figures/screenshots, and step-by-step instructions).

3.1 Wiki Structure

The Wiki Structure will follow the same organization outlined in Lab 3.

4 Submission

There is no formal document submission required. However, your team must have all User Manual content finalized in the GitHub Wiki associated with your repository before the Lab 4 deadline.

Your Lab 4 grade will be based on the document as a whole. Adjustments may be made for individual students based on their contribution (or lack of contribution).