No video of the event yet, sorry!

Mastering technical writing for software docs: Canonical’s use case Presented by: Angel Fernandez, Senior Technical Author at Canonical

In this presentation, we will explore the role of technical writing in software documentation. I will begin by discussing the importance of high-quality documentation and its impact on user experience, product adoption, and developer efficiency. Next, I will examine the purpose, goals, and challenges of software documentation, emphasizing the need for clarity, structure, and accessibility. To illustrate these principles in practice, I will delve into Canonical’s documentation strategy, focusing on our processes, culture, and best practices. A key part of this discussion will be the Diataxis framework, which structures documentation into four distinct categories: tutorials, how-to guides, reference, and explanation. We will explore why this approach is effective and how it helps create more structured and user-friendly documentation. Additionally, I will introduce the open-source tooling we use to build our documentation, shedding light on its infrastructure and capabilities. Lastly, I will highlight our engagement with the open-source community, sharing the various initiatives and collaboration opportunities available. This session aims to provide insights into effective documentation strategies while showcasing Canonical’s commitment to it and open-source knowledge sharing.