Slash Boxes

SoylentNews is people

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: 4, Interesting) by The Mighty Buzzard on Monday June 05 2017, @10:55AM (3 children)

    Yup. It's pulling teeth to get anyone on staff except audioguy to even document our own setup. Yes, this includes me.

    My rights don't end where your fear begins.
    Starting Score:    1  point
    Moderation   +2  
       Interesting=2, Total=2
    Extra 'Interesting' Modifier   0  
    Karma-Bonus Modifier   +1  

    Total Score:   4  
  • (Score: 2) by JoeMerchant on Monday June 05 2017, @01:13PM

    by JoeMerchant (3937) on Monday June 05 2017, @01:13PM (#520707)

    Documentation is a thankless job - you do a great job of documenting the existing setup, then the coders and testers change it all and your documentation is broken, but nobody cares enough to help you fix it.

    Autogenerated documentation like doxygen at least moves the problem closer to the source... still impossible to get coders to slow down and update the comments even when they're right there in the header of the subroutine, but when it's broken, the git-blame function at least gives you a name to go after to try to get some "what the hell were you thinking here" to go with the obvious stuff.

    Україна досі не є частиною Росії. Слава Україні 🌻
  • (Score: 0) by Anonymous Coward on Monday June 05 2017, @01:39PM

    by Anonymous Coward on Monday June 05 2017, @01:39PM (#520725)

    It's the least fun part of your job. I barely do it when they pay me, why do it for free?

  • (Score: 0) by Anonymous Coward on Monday June 05 2017, @02:38PM

    by Anonymous Coward on Monday June 05 2017, @02:38PM (#520756)

    I would love to write documentation if someone payed me to do it.
    but I'm actually payed for running the code I write and analyzing the results.