Sharing Knowledge: Writing Good Docs for Quick Approval
Offered By: CNCF [Cloud Native Computing Foundation] via YouTube
Course Description
Overview
Discover effective strategies for creating high-quality documentation that gains swift approval in this 38-minute conference talk by Jared Bhatti from Waymo. Learn how to enhance the visibility, quality, and inclusivity of open source projects through well-crafted documentation. Explore best practices for structuring content using templates, writing with clarity and technical precision, and avoiding common pitfalls that delay pull request reviews. Gain insights from Bhatti's experience leading Kubernetes SIG Docs from 2016 to 2020, and understand how good documentation impacts project onboarding, shared understanding, and overall reliability. Apply these techniques to create inclusive and accessible documentation that streamlines the approval process and contributes to the success of open source initiatives.
Syllabus
Sharing Knowledge: Writing Good Docs for Quick Approval - Jared Bhatti, Waymo
Taught by
CNCF [Cloud Native Computing Foundation]
Related Courses
Liderando el Desarrollo Sostenible de las CiudadesInter-American Development Bank via edX Letteratura latina 2 - L’idea dell’Altro in età imperiale
University of Naples Federico II via Federica Communication Skills for Dialoguing Across Difference
Catalyst via edX What does it mean to identify as Transgender or Gender Non-Conforming (TGNC)?
University of Minnesota via Coursera Volunteering in the Classroom: Adapting Resources for STEM Activities
National STEM Learning Centre via FutureLearn