Engineering Documentation

A presentation at YOW! London in in London, UK by Lorna Jane Mitchell

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.