• Semi-Hemi-Lemmygod@lemmy.world
    link
    fedilink
    English
    arrow-up
    66
    arrow-down
    2
    ·
    3 months ago

    It’s also why the humanities are important. Stemlords who brag about not doing literature classes write terrible documentation.

    • AlexWIWA@lemmy.ml
      link
      fedilink
      English
      arrow-up
      33
      ·
      3 months ago

      My CS major required me to take two upper division English classes and I think they helped me more in my career than my upper division CS classes. People forget that documentation is for ourselves too

      • Semi-Hemi-Lemmygod@lemmy.world
        link
        fedilink
        English
        arrow-up
        13
        ·
        3 months ago

        I’m really thankful that I had a great English teacher in high school, and that my degree required a technical writing class. Being able to write a coherent email got me further in my career than the technical stuff I learned in college.

        • AlexWIWA@lemmy.ml
          link
          fedilink
          English
          arrow-up
          5
          ·
          3 months ago

          I completely agree. Most peer feedbacks that I get mention my documentation. It has helped me so much

    • floofloof@lemmy.ca
      link
      fedilink
      English
      arrow-up
      13
      ·
      3 months ago

      I think this is why the “my code documents itself” attitude appeals, even though it’s almost never enough. Most developers just can’t write, nor do they want to.

      • Semi-Hemi-Lemmygod@lemmy.world
        link
        fedilink
        English
        arrow-up
        6
        ·
        3 months ago

        The problem with “It’s self-documenting” is that there are inevitably questions about what it says, and there’s no additional resources to pull from.

      • JackbyDev@programming.dev
        link
        fedilink
        English
        arrow-up
        1
        ·
        3 months ago

        “my code documents itself” and “no, our CI system doesn’t upload the source jars to Artifactory, why?”

    • ℍ𝕂-𝟞𝟝@sopuli.xyz
      link
      fedilink
      English
      arrow-up
      6
      arrow-down
      3
      ·
      3 months ago

      Maybe, just maybe, people have different strengths and weaknesses and cooperating around our differences is what makes us succeed.

        • ℍ𝕂-𝟞𝟝@sopuli.xyz
          link
          fedilink
          English
          arrow-up
          11
          ·
          3 months ago

          That’s exactly what I’m saying, sorry if it came across somehow askew.

          My point was there is no point in competing over whose job is “better”, we should be working together.

          • vividspecter@lemm.ee
            link
            fedilink
            English
            arrow-up
            5
            ·
            3 months ago

            There is a case to be made that people should be a bit more well rounded in general, and not just find a specific niche.

            So non-technical people should still have a decent familiarity with computers and maybe be able to do some very basic coding. And technical people should spend some time working on their written and verbal communication.

            Because in both cases, it makes people more effective in their roles.

          • Semi-Hemi-Lemmygod@lemmy.world
            link
            fedilink
            English
            arrow-up
            2
            ·
            3 months ago

            Totally agree. And I’d argue that we don’t even need technical writers. Even if all people do is correct grammar and spelling mistakes it would be helpful, let alone actually writing docs. It’s one of the easiest ways non-technical folks can get involved with open source projects.

            • JackbyDev@programming.dev
              link
              fedilink
              English
              arrow-up
              2
              ·
              3 months ago

              Every time I get stuck on something confusing I’m a README and figure it out I try to submit a patch that makes it more explicit.

        • GBU_28@lemm.ee
          link
          fedilink
          English
          arrow-up
          1
          arrow-down
          3
          ·
          3 months ago

          If the documentation is sufficient for the intended audience, it’s good enough.

    • Tja@programming.dev
      link
      fedilink
      English
      arrow-up
      1
      arrow-down
      2
      ·
      3 months ago

      Humanities are very important. Robots are not yet capable of flipping burgers!