Your submission was sent successfully! Close

You have successfully unsubscribed! Close

Thank you for signing up for our newsletter!
In these regular emails you will find the latest updates about Ubuntu and upcoming events where you can meet our team.Close

Questioning the doc

This article was last updated 2 years ago.

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

Get the latest Ubuntu news and updates in your inbox.

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

Related posts

Bare metal Kubernetes as a Service: Canonical MAAS and SpectroCloud Webinar

Developers want Kubernetes infrastructure that is fast, consistent, and without limits! Platform engineering, IT, and DevOps teams are adopting Kubernetes as...

Understanding bare metal Kubernetes

Bare metal Kubernetes is a powerful set of technologies that builds on the best ideas behind the public and private cloud, yet abstracts away some toilsome...

Bare metal Kubernetes: The 6 things you wish you knew before 2022

2022 is right around the corner, and it’s not just time to prepare for Christmas, play video games, buy presents, or share anti-Christmas memes. It’s time to...