Engineering Documentation • Lorna Jane Mitchell • GOTO 2022

From the creator

This presentation was recorded at GOTO Copenhagen 2022. #GOTOcon #GOTOcph https://gotocph.com Lorna Jane Mitchell - Head of Developer Advocate at Aiven & Writer for a Number of Outlets @LornaMitchell RESOURCES https://docs.aiven.io https://github.com/aiven/devportal https://docsfordevelopers.com https://idratherbewriting.com Lorna https://lornajane.net https://twitter.com/lornajane https://github.com/lornajane https://linkedin.com/in/lornajane ABSTRACT Every technology is made better and more delightful when it has excellent documentation, but producing the documentation can be a painful process. In this session, you will learn how to borrow what you know from good engineering practice and apply it to creating great documentation. Using docs-as-code for simple change management, pull request workflows for familiar and powerful collaboration and build previews, and CI to ensure quality by checking the prose and formatting, we will cover how to make documentation projects a fun place to work. Best of all, we'll look at what makes great documentation for engineers, and how we can supercharge the developer experience for our users. This session is recommended for anyone who wants to make sure that technical users can build great things, and wants to use the best of their existing toolchain to do it. [...] TIMECODES 00:00 Intro 02:06 What engineering is about 04:10 What documentation is about 05:47 Colleague enablement 10:02 Diataxis 13:41 Content structure 15:57 Style gui

Published 2023-05-19 · Watch on YouTube ↗
Availability and playback restrictions are controlled by the original channel.