Engineering Documentation
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.