Stories
Slash Boxes
Comments

SoylentNews is people

SoylentNews is powered by your submissions, so send in your scoop. Only 17 submissions in the queue.
posted by n1 on Monday June 05 2017, @10:15AM   Printer-friendly
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.

2017 Open Source Survey

-- submitted from IRC


Original Submission

 
This discussion has been archived. No new comments can be posted.
Display Options Threshold/Breakthrough Mark All as Read Mark All as Unread
The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.
  • (Score: 2) by turgid on Monday June 05 2017, @02:33PM (3 children)

    by turgid (4318) Subscriber Badge on Monday June 05 2017, @02:33PM (#520753) Journal

    None of my programs have man pages. That would be another boring and stupid markup language to learn and more stuff to keep up to date :-) And if you write a man page some poor soul might get the mistaken impression that your code actually works and can be used...

    Starting Score:    1  point
    Karma-Bonus Modifier   +1  

    Total Score:   2  
  • (Score: 0) by Anonymous Coward on Monday June 05 2017, @07:15PM (1 child)

    by Anonymous Coward on Monday June 05 2017, @07:15PM (#520916)

    FWIW, if you write documentation in almost any form, your build scripts can use pandoc to change it to man pages.

    • (Score: 2) by kaszz on Monday June 05 2017, @11:43PM

      by kaszz (4211) on Monday June 05 2017, @11:43PM (#521048) Journal

      That is time spent learning the idiosyncrasy of those build scripts and pandoc that could been spent on writing code.

  • (Score: 2) by kaszz on Monday June 05 2017, @11:39PM

    by kaszz (4211) on Monday June 05 2017, @11:39PM (#521047) Journal

    Make a simple text file. It solves a lot for very little effort.