Explore engineering documentation best practices in this 42-minute conference talk from YOW! 2022. Learn how to apply good engineering practices to create excellent documentation, including docs-as-code for change management, pull request workflows for collaboration, and CI for quality assurance. Discover the key elements of great documentation for engineers and how to enhance the developer experience. Gain insights on colleague enablement, the Diataxis framework, style guides, content structure, and text-based markup. Delve into automating documentation platforms, continuous integration and deployment, and open-source operations. Ideal for anyone looking to improve technical documentation and leverage existing toolchains to create user-friendly resources for developers.
Overview
Syllabus
Intro
What engineering is about
What documentation is about
Colleague enablement
Diataxis
Style guide
Content structure
Docs as code
Source control
Text-based markup & diagrams
Tooling
Automating a docs platform
Continuous integration
Vale
Continuous deployment
Open source operation
Contributors
Maintainers
Engineering documentation
Resources
Outro
Taught by
GOTO Conferences
