CSE 403 Course project: Implementation and Documentation

Overview

Make progress on the implementation of your project and solidify the documentation for end-users and developers.

Set up

Work with your project group to (1) make progress towards the final release, (2) provide a comprehensive user documentation, and (3) provide a comprehensive developer documentation.

Instructions

1. Make progress in your public GitHub repository (40%)

Complete this in the main branch of your repository by 02/21 EOD.

2. Write user documentation (30%)

Your public repository must contain a complete user manual. Anyone looking at your repository should be able to easily find the user manual. The user manual is focused solely on people who want to use your project.

The user manual should describe the functionality of your project as you expect it to be at the end of the quarter. For this assignment, indicate missing functionality as work in progress.

The user documentation should include at least the following information:

Complete this in the main branch of your repository by 02/21 EOD.

3. Developer documentation (30%)

Your public repository must contain developer guidelines. Anyone looking at your repository should be able to easily find these guidelines. The developer guidelines are focused solely on people who want to contribute to your project.

The developer documentation should include at least the following information:

Complete this in the main branch of your repository by 02/21 EOD.

Clarifications

What if info needed in my user or developer documentation already exists in my living document?

The documentation in your repository should be largely self-contained, and anyone looking for documentation should find it, or a link to it, in the repository.

You may link to sections of your living document from your user/developer documentation, or you may move these sections to the repository and put a link to it in your living document.

Do not maintain two parallel versions of any documentation.

Is there anything to submit to Canvas for this assignment?

There is nothing to submit to Canvas for this assignment; complete all tasks on the main branch of your repository on GitHub.