Explore a casual yet insightful discussion on improving technical documentation in this 28-minute video from Ubuntu OnAir's Documentation Office Hours. Delve into nine practical tips for better writing, covering topics such as getting started, allowing time for reflection, embracing imperfection, and striving for simplicity. Learn about the additive and subtractive nature of writing, the benefits of forgetfulness, and the importance of variety and hooks in your work. Discover the concept of "documentation as code" and contemplate the privileged position of writers. Gain unique perspectives on technical writing, including unexpected analogies to anti-aliasing algorithms and the movie Tenet. Join the Technical Authors team from Canonical as they share their informal thoughts and engage in a discussion about creativity's role in documentation.
Overview
Syllabus
Welcome
Plan for future office hours
9 tips for better writing
Beginning to write
Give yourself time to think
Your writing will never be finished
Simplicity is key, but it's difficult
Writing is both additive and subtractive
Be forgetful
Variety is essential
Ideas need a hook
Documentation as code
writing is a position of privilege
Words are a serial interface
Discussion on the role of creativity
Taught by
Ubuntu OnAir
