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!
