In-person + Virtual
16 -20 May
Learn More and Register to Attend

The Sched app allows you to build your schedule but is not a substitute for your event registration. You must be registered for KubeCon + CloudNativeCon Europe 2022 to participate in the sessions. If you have not registered but would like to join us, please go to the event registration page to purchase a registration.

Please note: This schedule is automatically displayed in Central European Summer Time (UTC +2). To see the schedule in your preferred timezone, please select from the drop-down menu to the right, above "Filter by Date." The schedule is subject to change.
Back To Schedule
Thursday, May 19 • 11:00 - 11:35
Sharing Knowledge: Writing Good Docs for Quick Approval - Jared Bhatti, Waymo

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Feedback form is now closed.

The goal of this talk is to increase your ability to write good documentation that gets approved quickly. Good documentation has a profound impact on the visibility, quality, and inclusivity of open source projects. Documentation creates a shared understanding of work, helps onboard new developers, and improves the overall quality and reliability of the project.

Based on Jared's experience leading Kubernetes SIG Docs from 2016 to 2020, this presentation walks developers through best practices for creating inclusive, accessible, high quality documentation in pull requests designed for quick approval. This demonstration includes how to structure documentation using content templates, write with clarity and technical accuracy, and avoid common pitfalls that trap PRs in prolonged reviews.

Click here to view captioning/translation in the MeetingPlay platform!

avatar for Jared Bhatti

Jared Bhatti

Staff Technical Writer, Waymo
Jared Bhatti is the author of Docs for Developers: An Engineer's Field Guide to Technical Writing. He is a Kubernetes SIG-Docs Chair Emeritus, having served as a Kubernetes SIG-Docs Chair from 2016-2020. He currently leads the documentation team at Waymo. He loves talking about how... Read More →

Thursday May 19, 2022 11:00 - 11:35 CEST
Pavilion 3, Room D | Level 2 | Central Forum Feria Valencia