Skip to main content

Blog posts tagged
"documentation"

Yanisa Haley Scherber
17 February 2026

A year of documentation-driven development

Ubuntu Article

For many software teams, documentation is written after features are built and design decisions have already been made. When that happens, questions about how a feature is understood or used often don’t surface until much later.  A little over one year ago, our team began to recognize this pattern in our own work. Features generally ...

Graham Morrison
18 December 2025

Design and Documentation clinics at FOSDEM Fringe 2026

Ubuntu Article

FOSDEM is one of the biggest and most exciting open source events of the year, held at the Solbosch campus of the Université Libre de Bruxelles (Brussels), Belgium. Thousands of open source contributors and enthusiasts attend, often with several folks from Canonical among them. The next one is coming quickly, with FOSDEM 2026 being held ...

Erin Conley
10 July 2025

In pursuit of quality: UX for documentation authors

Documentation Article

Canonical’s Platform Engineering team has been hard at work crafting documentation in Rockcraft and Charmcraft around native support for web app frameworks like Flask and Django. It’s all part of Canonical’s aim to write high quality documentation and continuously improve it over time through design and development processes. One way we i ...

Daniele Procida
3 December 2024

Documentation, development and design for technical authors

Documentation Documentation

Typically, a technical writer takes the product created by a development team, and writes the documentation that expresses the product to its users. At Canonical we take a different approach. Documentation is part of the product. It’s the responsibility of the whole team. Documentation work is led by a technical author, who is part of the ...

Graham Morrison
26 February 2024

Introducing Canonical’s Open Documentation Academy

Community Article

tldr; Our Open Documentation Academy starts this week with our first weekly Documentation Office Hours on Friday 1st March 2024 at 16:00 UTC. Everyone is welcome! Keep reading, or see our forum post for more details and to leave questions. Many of us at Canonical wouldn’t be here if it wasn’t for Linux and open ...

Bill Wear
17 March 2023

Help us build better doc

Canonical announcements Article

We want you to join our Ubuntu circle, and help us document MAAS. More minds, more eyes, more hands make better doc. ...

Teodora Mihoc
28 October 2022

Humans may be rational, or how to collect better documentation feedback with linguistic theory

People and culture Article

Anyone who has ever built a product wants user feedback – and we in open source want it more than anyone else, and place higher demands on it than anyone else. However, this feedback can be hard to give, hard to receive, and hard to act upon. My product is open source software documentation, and ...

Daniele Procida
5 October 2022

Engineering transformation through documentation

People and culture Article

To help bring our ambitious documentation plans to fruition, we’re going to be hiring people to work in documentation – over the next couple of years, we’ll be increasing the number of Technical Authors at Canonical four-fold. This isn’t about documentation alone. If documentation is part of a product, and documentation work is part of ...

Nathan Hart
29 June 2022

Multipass documentation: proudly a work in progress

Ubuntu Article

In February of this year the Multipass team took on a challenge: completely overhauling our documentation. Canonical has put a renewed emphasis on documentation in recent months, led by Daniele Procida and his Diataxis framework, and we wanted to be an early adopter of this methodology. We had no idea where to start, but fortunately ...

bethcollins
26 January 2022

Vanilla’s accessibility documentation process

Ubuntu Article

Following on from our previous post about accessibility by design, we’d like to share our accessibility documentation process here in the Web & Design team. In the Vanilla squad, we work hard to make sure the Vanilla framework is as accessible as possible. We don’t claim to be perfect, but accessibility is a real priority ...

Daniele Procida
25 January 2022

The idea of a tutorial

Community Article

Sooner or later, almost everyone who looks at some software that they or their team have created imagines a user getting to grips with it, and a pang of empathy for that unknown person prompts them to think: what we need here is a tutorial. And they are always absolutely right. In the Diátaxis documentation ...

  1. Previous page
  2. 1
  3. 2
  4. Next page