The first interaction new users have with an open source project is documentation. Documentation is a key adoption driver for open source projects, and the professionalism, completeness, and presentation of your documentation has a dramatic impact on how your project is perceived by potential users. How do you get your project’s docs to shine? How do you set your tooling up to support you as you grow? What metrics can we use to evaluate the quality of a project’s documentation? In this talk we use data from the CNCF’s documentation assessment service to give an overview of common issues we see with open source project’s documentation and how to resolve them. She breaks out these issues by project maturity and community size, and discusses how a given project’s documentation needs change as it grows. Finally, we discuss how projects can best get documentation done as they grow, based on what we’ve seen work in various CNCF project communities.
Click here to view captioning/translation in the MeetingPlay platform!
