Questioning the doc

Here’s a VLOG about some changes we’re making to the MAAS documentation. It’s all about using questions at the top of articles to help direct attention.

This idea grew out of our frustration over long pages with lots of complex information. We tried a top table of contents, but that looks weird and requires a lot of policing to keep up-to-date.

A couple of highlights:

– Questions don’t necessarily point to sections in the current article. We wanted to collect pointers to relevant info, no matter where it might naturally reside in the docset. Think of it as a cheap way to achieve transclusion.

– Not all pages rate questions. Pages that provide linear instructions — or pages that are very short — won’t use questions, because they’re not appropriate.

– When questions are arranged in a “knowledge gradient” (still working on this), readers can use the questions to dive in at the right level, without feeling frustrated wading through tutorial information.

– Attempting questions also helps us force out pages that are overly long or poorly structured. If there are too many questions, or it’s hard to form questions to describe a page, those are useful red flags.

That said, have a look at this VLOG explaining the new look and the process by which we got there.

Ubuntu cloud

Ubuntu offers all the training, software infrastructure, tools, services and support you need for your public and private clouds.

Newsletter signup

Select topics you're
interested in

In submitting this form, I confirm that I have read and agree to Canonical's Privacy Notice and Privacy Policy.

Related posts

What has snapd ever done for other distros?

Snaps are self-contained applications designed with ease of use, security and portability in mind. They bundle their necessary dependencies, so they can work...

Publishing sonar readings with micro-ROS on the Raspberry Pi Pico

In this post, we will see how to wire up an HC-SR04 range sensor to the Raspberry Pi Pico and publish its readings to the ROS 2 graph using micro-ROS. This...

The story of a feature: “View my invoices”

In this blog post, I’ll do a deep dive into the process of designing a small feature on – from the original need, right through the design phase...