• harc@szmer.info
    link
    fedilink
    arrow-up
    54
    ·
    2 days ago

    I’ve spent some 5 hours just today documenting and writing instructions on some IT tools for my collective. One person said its cool though, so not bad.

    • early_riser@lemmy.world
      link
      fedilink
      arrow-up
      2
      ·
      edit-2
      2 hours ago

      The ability to write clear documentation is an invaluable skill. So many open source projects have terrible docs. The docs are probably written by the devs themselves, who perhaps don’t realize that end users won’t have the intimate knowledge of the thing they’re documenting as they do, so they leave a lot unsaid that should really be explicit.

      In IT, at least in networking, systems quickly become black boxes even to the person that designed it, and good docs are just as useful to the person writing them.

    • slazer2au@lemmy.world
      link
      fedilink
      English
      arrow-up
      22
      ·
      2 days ago

      You sir are a champion. So few of us do documentation and wonder why we have to fix the same problems over and over.

      • harc@szmer.info
        link
        fedilink
        English
        arrow-up
        2
        ·
        1 day ago
        unsolicited comradery

        Hey, u wanna share some means of reproduction?