logo
Dates

Author


Conferences

Tags

Sort by:  

Authors: Nate Waddington
2023-04-20

We’re taking the TechDocs Office Hours on the road! If you have any questions about documentation, the writing process, or how the CNCF TechDocs team can help your project, come by and chat with us!
Authors: Jared Bhatti
2022-05-19

tldr - powered by Generative AI

The importance of writing good documentation for open source projects and best practices for quick approval
  • Good documentation has a profound impact on the visibility, quality, and inclusivity of open source projects
  • Developers prefer documentation to contacting support or talking to an actual person
  • Most developers see documentation and its incompleteness or its lack of existence to be a huge problem in the community
  • The goal is to write inclusive, accessible, high-quality documentation in pull requests designed for quick approval
  • Best practices include structuring documentation using content templates, writing with clarity and technical accuracy, and avoiding common pitfalls that trap PRs in prolonged reviews
  • Writing in second person and focusing on the user's perspective is the most useful thing you can do
  • Specify what kind of review you want and set context for your reviewer