Encouraging Engineers to Write Their Own Documentation - Open Documentation Hour

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.

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