Towards Great Documentation: Behind a CNCF-Led Docs Audit - Jorge Lainfiesta, Rootly

Don't miss out! Join us at our next Flagship Conference: KubeCon + CloudNativeCon North America in Salt Lake City from November 12 - 15, 2024. Connect with our current graduated, incubating, and sandbox projects as the community gathers to further the education and advancement of cloud native computing. Learn more at kubecon.io
Towards Great Documentation: Behind a CNCF-Led Docs Audit - Jorge Lainfiesta, Rootly
Documentation is hard, especially for large Cloud native projects. In 2022, the CNCF commissioned an audit for the Backstage docs with a team of expert technical writers. The process resulted in a re-structuring and re-writing of a lot of the fundamental documentation in the project, passing through alignment with maintainers and a multitude of contributors. In this talk, I’ll explain the process and lessons learned from renovating the existing documentation of a large project. My goal is to provide OSS maintainers and contributors actionable insights to write better documentation for everyone using their projects.