Explore best practices for creating excellent engineering documentation in this 47-minute conference talk from GOTO Copenhagen 2022. Learn how to apply good engineering practices to documentation, including docs-as-code for change management, pull request workflows for collaboration, and CI/CD for quality assurance. Discover the Diataxis framework for structuring content, implement style guides, and leverage text-based markup and diagrams. Dive into automating documentation platforms, using continuous integration tools like Vale, and managing open-source documentation projects. Gain insights on colleague enablement, content structure, and maintaining documentation as code to enhance the developer experience and create more delightful technical resources.
Overview
Syllabus
Intro
What engineering is about
What documentation is about
Colleague enablement
Diataxis
Content structure
Style guide
Docs as code
Source control
Text-based markup & diagrams
Automating a docs platform
Continuous integration
Vale
Continuous Deployment
Open source operation
Contributors
Maintainers
Engineering documentation
Resources
Outro
Taught by
GOTO Conferences
