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:
Background
Activities
- Place the Documentation Examples into Quadrants
- Define a Recipient for Your Project's User Documentation
- Place the Formats or Style of User Documentation into Quadrants
Long-Term Assignments
Extra points
Teams can earn up to 5 extra points for providing helpful, constructive, and specific reviews of other teams' user documentation. Reviews must be submitted via GitLab issues in the respective team's project repository. Also, notify the tutor in person to verify and award the points, and assign the tutor to the issue. Each team can only earn these extra points once.
Gratitude
The other teams (those whose use cases you are reviewing) could decide to pay up to 5 extra points from their own extra points if they find your review particularly helpful.
3: Developer 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:
Background
- Clean Comments Matter
- Clean Code by Robert C. Martin (Book)
- Most of the Diataxis Concepts Still Apply
- Diataxis Homepage
Activities
Long-Term Assignments
Extra points
Teams can earn up to 5 extra points for providing helpful, constructive, and specific reviews of other teams' developer documentation. Reviews must be submitted via GitLab issues in the respective team's project repository. Also, notify the tutor in person to verify and award the points, and assign the tutor to the issue. Each team can only earn these extra points once.
Gratitude
The other teams (those whose use cases you are reviewing) could decide to pay up to 5 extra points from their own extra points if they find your review particularly helpful.