Class Central is learner-supported. When you buy through links on our site, we may earn an affiliate commission.

YouTube

Encouraging Engineers to Write Their Own Documentation - Open Documentation Hour

Ubuntu OnAir via YouTube

Overview

Save Big on Coursera Plus. 7,000+ courses at $160 off. Limited Time Only!
Explore strategies for encouraging engineers to write their own documentation in this 55-minute Open Documentation Hour session from Ubuntu OnAir. Learn how to rethink framing, define scope, address limitations, and challenge false assumptions about technical writing. Discover various approaches including enforcement, education, collaboration, and incentivization. Engage with discussions on teaching strategies, diplomacy, soft skills, and the importance of collaboration in documentation. Understand the challenges of avoiding "happy paths" in documentation and how to help engineers grasp the role of technical authors. Gain insights from the Technical Authors team at Canonical on improving documentation practices within engineering teams.

Syllabus

Welcome
Updates
Submit your documents!
Artem starts
Encouraging engineers to write their own documentation
Outline
Build-up: rethink the framing
Build-up: scope
Build-up: limitations and prerequisites
Build-up: toppling false assumptions
Strategies: mix and match
Strategies: enforce!
Strategies: educate
Strategies: collaborate
Strategies: grease
Fun stuff time!
Surrender your shadow docs!
Questions
Strategies for teaching
Diplomacy and soft skills
Collaboration is key
Avoiding the happy paths
Happy paths aren't always intentional
How to you help engineers understand the role of a TA

Taught by

Ubuntu OnAir

Reviews

Start your review of Encouraging Engineers to Write Their Own Documentation - Open Documentation Hour

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.