Documentation Office Hours 17th May 2024

Live from Madrid, Part 2

Our second live in-person recording from Madrid with several technical authors from Canonical. This time we’re discussing how to approach writing a tutorial.

Big thank you to @keirthana for putting together the talk on tutorials!

00:05 Introduction
00:30 Let’s create a tutorial
01:30 Scope definition
02:30 Avoiding pitfalls
06:00 Final plans
07:40 Questions
07:45 At what stage does a set of documentation need a tutorial?
09:40 Should a tutorial contain details not documented elsewhere?
12:40 How do you integrate basic and advanced tutorials?
14:00 How do you sync tutorial content?
15:40 Is it safe to have both basic and advanced tutorials in the same section?

3 Likes