DEV Community

Cover image for Documentation is highly valued, but often overlooked
Nicolas Lorenzi for Luos

Posted on

Documentation is highly valued, but often overlooked

In open source projects, documentation is highly valued, but often overlooked.

  1. When you encounter documentation problems, help a maintainer and open a change request to improve them.
  2. Licenses are by far the most important type of documentation for users and contributors.
  3. Documentation helps build engaged communities.
  4. When communicating about a project, use language that is clear and accessible to people who are not born English or do not read English fluently.

This survey was initiated by Github in 2017, but many issues are still relevant in 2022.

We are an open-source project; please feel free to comment if you have any tips for improving documentation.

Source : https://opensourcesurvey.org/2017

Top comments (0)