Week 7: Documentation (QA)

Goal

The goal of this session is to help students practice creating comprehensive documentation for their deliverables, including user and developer documentation, to ensure clarity and usability for end-users and future developers.

Expected Results until this Week

We will discuss expected results during the class on this week. So please make sure to be prepared! More about penalty and bonus points

Prepare to present the deliverable requirements and prioritisation details.

Title	Duration
Deliverable Requirements and Prioritisation	30 minutes
User Documentation	30 minutes
Developer Documentation	30 minutes

Notes for tutors: 🗒️

1: Deliverable Requirements and Prioritisation (30 minutes)

Each team presents their planned features, user stories, or use cases to the class. See related task for more details.
- During the presentation, teams must explain how they estimated the effort required for each feature, user story, or use case. See related task for more details.
- During the presentation, each team must explain how they prioritised their features, user stories, or use cases. See related task for more details.

Presentation Technical Requirements

Each team has no more than 5 minutes to present the whole deliverable to the class.
Use the created GitLab group and project to share information: issues, milestones, and boards.
Slides are not required for this session.

2: User Documentation (30 minutes)

Why is this useful for me?

Things you learn and experience in this session will help you to solve the following tasks:

User Documentation

Background

Activities

Long-Term Assignment

Cooperation

Teams may contract other teams to review their developer documentation in exchange for bonus points.

Check Other Teams' User Documentation

3: Developer Documentation (30 minutes)