• Croquette@sh.itjust.works
    link
    fedilink
    arrow-up
    24
    arrow-down
    1
    ·
    23 hours ago

    The documentation is usually dog shit.

    The corporate culture does not allow appropriate time for the documentation as it is considered something that cost money without a quantifiable gain.

    It permeates in the FOSS space as well since writing good documentation is a skill and it is not fostered in corporations. So devs start great projects with terrible documentation.

    • raspberriesareyummy@lemmy.world
      link
      fedilink
      arrow-up
      15
      ·
      22 hours ago

      One way to contribute to FOSS is to improve bad documentation. You are correct, of course, and lazy devs write bad code if they do not cultivate good documentation - imho.

    • ChogChog@lemmy.world
      link
      fedilink
      arrow-up
      5
      ·
      19 hours ago

      Does anyone know of any good resources on writing good documentation? It’s a thing I’m weirdly passionate about and absolutely want to get better at for my own sanity and for others as well if I can contribute.

      But it seems like it’s a very under discussed subject…

      Veronica Explains has a really good video talking about how much of a dead skill it is now from the standards it used to be.