Red Hat Finds Teaching Technical Writing to Students Requires Adjusting Tools and Methods
Red Hat’s four-year partnership with Masaryk University to train technical writers revealed that command-line tools and peer grading often fail in academic settings.
Key points
- Red Hat has partnered with Masaryk University for four years to teach a technical writing course unit.
- Instructors found that shell-based assignments failed because many students lacked command-line experience or admin access.
- Peer grading exercises struggled due to time constraints, despite mimicking professional review workflows.
Red Hat presented findings from its long-running technical writing course at the Open Source Summit in Prague, revealing significant challenges in teaching university students. Jiří Herrman, a senior member of Red Hat’s documentation team in Brno, delivered a talk titled "Diagrams & Dragons: Teaching Technical Writing to University Students the Open Source Way." The presentation highlighted lessons learned from instructing students at Masaryk University’s Faculty of Informatics.
The collaboration between Red Hat and the university began four years ago, though Herrman noted the launch was delayed by the global events of 2020. Red Hat maintains a large office in Brno, the second-largest city in Czechia, which hosts a substantial documentation team. The company has been actively cultivating technical writing talent in the region, focusing on the human interaction aspects of the profession that are difficult to automate or teach in isolation.
Course Design Challenges
Herrman’s slide deck detailed several aspects of the curriculum that did not perform as expected, according to The Register. Although the course targeted students with existing technical knowledge, the assumption that they could comfortably use shell-based tools proved incorrect. Many participants had never used the command line, creating a barrier to entry for the practical exercises designed to simulate professional documentation workflows.
Infrastructure limitations further complicated the coursework. Some students arrived with borrowed laptops that lacked administrator-level access, preventing them from installing necessary software or configuring environments. Others attended classes using only smartphones, which are ill-suited for the detailed technical writing and editing tasks required by the course. These hardware and access disparities made it difficult to deliver a uniform learning experience.
Assessment and Review Methods
The course also attempted to replicate professional workflows by having students grade each other’s work, similar to peer reviews in industry documentation teams. This approach did not yield the desired results, largely due to the speed required to complete the assessments. The time pressure likely compromised the quality of the feedback, making the exercise less effective as a learning tool for both the reviewers and the authors.
Red Hat’s focus on the "tricky part" of technical writing involves interacting with other humans, a skill that is hard to teach through isolated exercises. The difficulties encountered with peer grading suggest that structured, time-bound collaborative exercises require careful design to be effective in an academic setting. The company continues to refine its approach based on these observations.
What should you do?
Organizations looking to train technical writers should assess the technical proficiency of their trainees before assigning command-line tasks. Ensure all participants have access to devices with sufficient permissions and capabilities for the required software. Consider adjusting peer-review timelines to allow for thorough feedback rather than rushed assessments.
What to do and how to stay safe: Red Hat
- Audit trainee hardware and software access levels before assigning technical writing exercises that require specific tools or admin rights.
- Provide foundational training on command-line interfaces if your curriculum assumes prior familiarity with shell-based environments.
- Structure peer-review activities with clear time allowances to ensure feedback quality is not sacrificed for speed.
- Evaluate whether mobile-only users can adequately complete documentation tasks and provide alternative access methods if necessary.
Step-by-step guide: Prompt Injection Warning Signs: How to Spot AI Manipulation
General security guidance from the Threat Times newsroom. It is not confirmed advice from the organisations named in this story.
Frequently asked questions
Why did Red Hat partner with Masaryk University?
Red Hat has been working with Masaryk University for four years to teach a course unit in technical writing and cultivate talent in its Brno office.
What technical barriers did students face in the course?
Many students lacked command-line experience, had borrowed laptops without admin access, or used only phones, making shell-based assignments difficult.
Did peer grading work as intended in the course?
No, peer grading did not work well, partly due to the speed required to complete the reviews, which likely impacted the quality of feedback.
