• Lka1988
    link
    fedilink
    20
    edit-2
    2 years ago

    Looking at you, Docker compose files.

    Docs: “make a docker-compose.yaml, it’s so easy!”

    Me: “How?? Where?? What’s the syntax?? ANYTHING AT ALL?”

    Some corner of a dusty website only three people have visited in the last two years: “here’s the syntax you need to use for these specific use cases, and you can put it anywhere as long as it’s consistent”

    Jesus Fucking Christ is it really that difficult to be a little more specific with this kind of thing? This is why I didn’t start using Docker until very recently. Their docs absolutely suck balls for someone who isn’t already familiar with it.

  • @alcasa@lemmy.sdf.org
    link
    fedilink
    -22 years ago

    No, instead just read the source. Documentation lies and you might learn some useful tricks by just learning how the figurative cake is made.

  • @danc4498@lemmy.world
    link
    fedilink
    302 years ago

    I feel like memes like these are written by documentation writers. I usually fine what I need way faster in stack overflow than the documentation.

    • jeff 👨‍💻
      link
      fedilink
      72 years ago

      There’s really good documentation out there and there’s bad/nonexistent documentation. So stackoverflow is going to be a more consistent experience.

      Also I think it is a bit of a skill to be able to read documentation well, especially for Jr. Devs that might not have fully grasped OOP.

      • @spauldo@lemmy.ml
        link
        fedilink
        32 years ago

        Totally agree on the skill part. The ability to read documentation and understand it is extremely important. Especially if you need to coordinate with nonprogrammers like engineers, or if you work in fields that SO doesn’t cover well like I do.

    • @lackthought@lemmy.sdf.org
      link
      fedilink
      22 years ago

      I use chatgpt to get me pointed in the right direction and have it provide some basic boilerplate code for smaller tasks

      I needed to go through a bunch of .json files and modify various elements

      I was able to implement what I needed without google/documentation/stackoverflow

  • @crucifix_peen@lemmy.ml
    link
    fedilink
    92 years ago

    working on a project in python now

    first ~30 lines are just comment lines with hyperlinks to all the places I’ve stolen uhhh I mean, sourced, code from. And a solid 40% of them are stackoverflow

  • Jee
    link
    fedilink
    112 years ago

    When it comes to things that I am not familiar at, going through documentation is quite tedious and feels like walking blind just feeling things. Having a small easy to understand explanation helps a lot even if I have to then further look it up on documentation.

    • @xpinchx@lemmy.world
      link
      fedilink
      52 years ago

      I do things probably the stupidest way imaginable and find someone’s git project using a library I need to use and see how they used it.

      People that release libraries with demos and use cases are angels, in my eyes at least.

  • @rf_@lemmy.world
    link
    fedilink
    252 years ago

    Documentation is more often than not quite bad. Very abstract, hard to understand, few examples if any. Good writing is a skill.

    • MischievousTomato
      link
      fedilink
      122 years ago

      Sometimes you need a quick/clear fix and the documentation doesn’t help with that. SO, though, is.

  • @nxfsi@lemmy.world
    link
    fedilink
    102 years ago
    $ sudo Pacman -S <package>
    $ man <package>
    

    Turns out the executable is a different name entirely

  • r00ty
    link
    fedilink
    192 years ago

    To be fair, documentation is very often a much longer route to understanding your specific use case. At the same time, SO is responsible for far too much cargo cult programming and I fear ChatGPT will be the same for this.

    • @Kryomaani@sopuli.xyz
      link
      fedilink
      English
      10
      edit-2
      2 years ago

      And there are way too many projects where the documentation is nonexistent or bare to the point of being counterproductive to wade through. I’ve seen way too many open source projects that purport to have documentation but when you open it, it’s just doxygen run over the raw source files with barely any documenting comments in them. If I wanted to see only the names of the classes and functions I’d just pop the source in an IDE, the point of documentation is to point out everything that isn’t immediately obvious just looking at names and to give examples.

      “Self-documenting code” is the biggest lie we tell ourselves to get out of writing actual, necessary documentation.

  • arc
    link
    fedilink
    22 years ago

    I’ve been using chatgpt lately, super helpful. Basically Google on steroids