Key points
- Red Hat’s Brno office has partnered with Masaryk University for four years to teach technical writing.
- Course tutors found that shell-based tool requirements failed because students lacked admin access or laptops.
- Peer grading exercises also struggled due to the speed required for meaningful feedback.
Red Hat discovered that requiring command-line tools for a university technical writing course created barriers for students who lacked proper equipment or administrative rights on their devices.
How it unfolded
- The partnership between Red Hat’s Brno office and Masaryk University’s Faculty of Informatics began four years ago, with the course launch delayed by the 2020 pandemic.
- At the Open Source Summit in Prague, Red Hat documentation team member Jiří Herrman presented lessons learned from teaching the PV177 Technical Writing course.
- Tutors reported that assigning shell-based tasks failed because some students never used the command line, used borrowed laptops without admin access, or only had phones.
Who is affected
The primary impact was on the students enrolled in the PV177 Technical Writing course at Masaryk University in Brno, Czechia. According to The Register, the participants included individuals with varying levels of technical preparation and hardware access. The course aimed to train future technical writers, a role Red Hat has been cultivating in the region for some time. The challenges observed during the class sessions highlighted gaps in the assumed technical baseline of the student body.
What happens next
Red Hat tutors presented what they learned from the students at the Open Source Summit. The company specifically wants to focus on the human interaction aspects of technical writing, which Herrman described as the tricky part of the profession. The presentation at the Open Source Summit detailed what did not work, including the peer grading system that failed due to time constraints. The Register reports that these findings were shared as part of the talk on teaching technical writing the open source way.
The background in plain language
Technical writing requires more than just grammar skills; it demands an understanding of the tools users employ. When educators assume all students have identical hardware and software permissions, they risk excluding those who do not. Peer review is a standard industry practice to ensure accuracy, but it requires sufficient time and clear criteria. Without these elements, feedback becomes superficial. Instructors must align assessment methods with the actual resources and experience levels of their participants to create effective learning environments.
What to do and how to stay safe: Red Hat
- Check whether your course materials assume specific hardware privileges that students may not have.
- Ensure that all students can access the necessary software environments on their personal devices.
- Provide alternative ways to complete tasks for students who lack administrative rights on their computers.
- Review peer review timelines to ensure they allow for thorough and meaningful feedback.
Step-by-step guide: Injection attacks examples: how prompt leaks break AI systems
General security guidance from the Circuit Observer newsroom. It is not confirmed advice from the organisations named in this story.
Frequently asked questions
Why did the technical writing course face difficulties with shell-based tools?
Some students had never used the command line, while others used borrowed laptops without admin access or only had phones.
Who presented the lessons learned at the Open Source Summit?
Jiří Herrman, a senior member of Red Hat’s documentation team in Brno, presented the talk.
What specific aspect of technical writing does Red Hat want to focus on?
Red Hat wants to work on the interaction with other humans, which Herrman described as the tricky part of technical writing.
