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 Before This Week
Weekly Progress Check rules
- Be prepared to show your results at the beginning of class.
- Presenting teams are selected randomly each week. The same team may be selected repeatedly.
- If your team is selected and there is no relevant work recorded before the session, 3 points will be deducted. Any relevant demonstrable work avoids the deduction: the weekly score is then between 0 and +3 points, depending on quality and completeness.
- A missing expected result can cause a point deduction only once, but you should still catch up: later work may depend on it, and these results usually contribute to the tasks required for your desired grade. More about salary for tasks
How Weekly Progress Checks work · More about penalty and bonus points
This week's expected results
- 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 |
| Intermediate Topics | - |
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
Long-Term Assignment
Cooperation
Teams may contract other teams to review their developer documentation in exchange for bonus points.
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
Cooperation
Teams may contract other teams to review their developer documentation in exchange for bonus points.
4: Intermediate Topics (-)
User Documentation
Activities
- Place the Documentation Examples into Quadrants
- Place the Formats or Style of User Documentation into Quadrants