| Title | Free Software is Suffering Because Coders Don’t Know How to Write Documentation | |
| Date | Monday June 05 2017, @10:15AM | |
| Author | n1 | |
| Topic | ||
| from the git-gud dept. | ||
The Open Source Survey asked a broad array of questions. One that caught my eye was about problems people encounter when working with, or contributing to, open source projects. An incredible 93 percent of people reported being frustrated with “incomplete or confusing documentation”.
That’s hardly a surprise. There are a lot of projects on Github with the sparsest of descriptions, and scant instruction on how to use them. If you aren’t clever enough to figure it out for yourself, tough.
[...] According to the Github Open Source Survey, 60 percent of contributors rarely or never contribute to documentation. And that’s fine.
Documenting software is extremely difficult. People go to university to learn to become technical writers, spending thousands of dollars, and several years of their life. It’s not really reasonable to expect every developer to know how to do it, and do it well.
-- submitted from IRC
| Links |
printed from SoylentNews, Free Software is Suffering Because Coders Don’t Know How to Write Documentation on 2024-12-03 11:55:57