Engineering Documentation • Lorna Jane Mitchell • GOTO 2022

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 guide 17:51 Docs as code 19:13 Source control 22:00 Text-based markup & diagrams 26:57 Automating a docs platform 27:20 Continuous integration 33:53 Vale 37:27 Continuous Deployment 39:10 Open source operation 41:29 Contributors 43:10 Maintainers 45:38 Engineering documentation 46:08 Resources 46:20 Outro Download slides and read the full abstract here: https://gotocph.com/2022/sessions/2168 RECOMMENDED BOOKS Kevlin Henney • 97 Things Every Programmer Should Know • https://amzn.to/2Yahf9U Henney & Monson-Haefel • 97 Things Every Software Architect Should Know • https://amzn.to/3pZuHsQ Matthew Skelton & Manuel Pais • Team Topologies • http://amzn.to/3sVLyLQ Michael Jackson • Software Requirements and Specifications • https://amzn.to/3ql2T14 Geoffrey West • Scale • http://amzn.to/3eKMbpc Donald G. Reinertsen • The Principles of Product Development Flow • https://amzn.to/3hJ2Ye2 https://twitter.com/GOTOcon https://www.linkedin.com/company/goto- https://www.instagram.com/goto_con https://www.facebook.com/GOTOConferences #EngineeringDocumentation #Documentation #Diataxis #Automation #CICD #Vale #Teams #Team #ColleagueEnablement #SoftwareEngineering #Programming #LornaJaneMitchell CHANNEL MEMBERSHIP BONUS Join this channel to get early access to videos & other perks: https://www.youtube.com/channel/UCs_tLP3AiwYKwdUHpltJPuA/join Looking for a unique learning experience? Attend the next GOTO conference near you! Get your ticket at https://gotopia.tech Sign up for updates and specials at https://gotopia.tech/newsletter SUBSCRIBE TO OUR CHANNEL - new videos posted almost daily. https://www.youtube.com/user/GotoConferences/?sub_confirmation=1