• ExcessShiv@lemmy.dbzer0.com
    link
    fedilink
    English
    arrow-up
    269
    ·
    edit-2
    2 months ago

    Yeah the documentation (if it even exists) of most projects is usually clearly written by people intimately familiar with the project and then never reviewed to make sure it makes sense for people unfamiliar with it. But writing good detailed documentation is also really hard, especially for a specialist because many nontrivial things are trivial to them and they believe what they’re writing is thorough and well explained even though it actually isn’t.

      • Semi-Hemi-Lemmygod@lemmy.world
        link
        fedilink
        English
        arrow-up
        66
        ·
        2 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
          ·
          2 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
            ·
            2 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
              ·
              2 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
          ·
          2 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
            ·
            2 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
            ·
            2 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
          ·
          2 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
              ·
              2 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
                ·
                2 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
                ·
                2 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
                  ·
                  2 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
              ·
              2 months ago

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

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

        You have to assume some level of end user knowledge, otherwise every piece of documentation would start with “What a computer does” and “How to turn your computer on.”

        I’ve found the best practice is to list your assumptions at the top of the article with links to more detailed instructions.

        • Flax@feddit.ukOP
          link
          fedilink
          English
          arrow-up
          16
          ·
          2 months ago

          I do agree, manies have I found documentation saying “make a fresh install of Raspbian” as if I’m using the computer for this single issue

          (Disclaimer: I am not running matrix on a Raspberry Pi)

          • vividspecter@lemm.ee
            link
            fedilink
            English
            arrow-up
            6
            ·
            2 months ago

            Another case is listing a huge number of steps to do some task, without acting describing what the end goal for each set of instructions is (common in “how to” guides, and especially ones that involve a GUI).

            This means that less technical users don’t really understand what is going on and are just following steps in a rote way, and it wastes the time of technical users since they probably know how to achieve each goal already.

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

          I agree with this. When I publish my code, it is documented for someone in my field with around my level of knowledge. I assume you know DNS, I assume you know what a vector is, I assume you know what a dht is, I assume you know what O(log n) is.

          I’m not writing a CS50 course, I’m helping you use the code I wrote.

          Might be different for software like libre office which is supposed to be used by anyone, but most software on earth is built with other developers in mind.

    • bl_r@lemmy.dbzer0.com
      link
      fedilink
      English
      arrow-up
      24
      ·
      2 months ago

      This is why I did a “walkthrough test” when I had to write documentation on this sort of thing. I’m a terrible technical writer, so this shit is necessary for me.

      I grabbed my friend who knows enough about computers to attempt this, but not enough about infrastructure to automatically know what I meant when I was too vague.

      Took two revisions, but the final document was way easier to follow at the end

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

      Reminds me of the time I asked a question about a Magic: The Gathering card tomy local game store’s Facebook page. The card was Sublime Archangel. I asked what happened if it gave a creature Exalted that already had one. Someone sarcastically replied that it already says it on the card. I was a new player, how was I supposed to parse the phrase “If a creature has multiple instances of exalted, each triggers separately”? For all I knew that could mean that they didn’t stack because they would need to trigger together. I didn’t have the vocabulary to understand those things.

      I try to remember this when explaining what I might believe are simple concepts to people because that person really upset me.

    • sugar_in_your_tea@sh.itjust.works
      link
      fedilink
      English
      arrow-up
      9
      ·
      2 months ago

      That’s why blog posts rock. Most popular projects will have a dozen blog posts for different configurations. For example, when looking to set up NextCloud, I found docs for almost all combinations of the following:

      • Apache and Nginx configuration
      • running through Docker or directly on the host
      • MariaDB and Postgres configs (and SQLite, with proper disclaimers)
      • Collabora and OnlyOffice config

      It does take some knowledge of each of the above if you need one of the few configs that’s not available on a blog post, and some of the posts are outdated, but with a bit of searching almost everything is documented by someone on the internet.

      This shouldn’t be necessary (official docs should be more comprehensive), but at least it’s available.

      • cron@feddit.org
        link
        fedilink
        English
        arrow-up
        15
        ·
        2 months ago

        I’d rather have a great documentation than five different blog posts, where some of them might be outdated, wrong or insecure (and you only find out later).

        But yes, they are helpful and easily available for popular software.

      • harsh3466@lemmy.ml
        link
        fedilink
        English
        arrow-up
        5
        ·
        2 months ago

        Okay, please point me to the blog posts that helped you with collabora/onlyoffice. Thanks have NEVER been able to get that to work with my nextcloud (currently using the Docker AIO).

        • mesamune@lemmy.world
          link
          fedilink
          English
          arrow-up
          2
          ·
          edit-2
          2 months ago

          Same with me. I played around with the setup a few times on my local machines. It took quite a bit to get it set up, then I saw an error after a couple of days and gave up. Its easier to just pull down the file and run it locally than use collabora.

        • sugar_in_your_tea@sh.itjust.works
          link
          fedilink
          English
          arrow-up
          1
          ·
          2 months ago

          I’m not at the same computer I used to look it up, so I don’t have my search history, but I think this one was pretty decent. I don’t use Traefik, but the rest describes the important bits w/ docker compose. I don’t know much about the AIO image though (I used separate images).

    • marcos@lemmy.world
      link
      fedilink
      English
      arrow-up
      4
      ·
      2 months ago

      That’s just sloppiness.

      The information that familiarity gives you is “WTF does this field means”, and it’s the only thing that’s actually there. How you get a value and how a value is formatted are things no amount of expertise will save you from having to tell the computer, and thus you can’t just forget about.

      (And let me guess, the software recommended install is a docker image?)

    • Presi300@lemmy.world
      link
      fedilink
      English
      arrow-up
      2
      ·
      2 months ago

      100% Agree, it feels like most documentation is written in a way that expects you to already know what it’s talking about… When it’s the documentation’s job to teach me about it.

    • hperrin@lemmy.world
      link
      fedilink
      English
      arrow-up
      2
      ·
      edit-2
      2 months ago

      I don’t think it’s (just) that. It’s also a different skill set to write documentation than code, and generally in these kind of open source projects, the people who write the code end up writing the documentation. Even in some commercial projects, the engineers end up writing the docs, because the higher ups don’t see that they’re different skill sets.

  • AstralPath@lemmy.ca
    link
    fedilink
    English
    arrow-up
    92
    ·
    2 months ago

    Honestly, as a newbie to Linux I think the ratio of well documented processes vs. “draw the rest of the fucking owl” is too damn high.

    The rule seems to be that CLI familiarity is treated as though its self-evident. The exception is a ground-up documented process with no assumptions of end user knowledge.

    If that could be resolved I think it would make the Linux desktop much more appealing to wider demographics.

    That said, I’m proud to say that I’ve migrated my entire home studio over to linux and have not nuked my system yet. Yet… Fortunately I have backups set up.

    • sugar_in_your_tea@sh.itjust.works
      link
      fedilink
      English
      arrow-up
      33
      ·
      2 months ago

      Linux on the desktop almost never needs CLI interaction though. Maybe you’ll need to copy/paste a command from the internet to fix some sketchy hardware, but almost everything works OOTB these days.

      However, self-hosting isn’t a desktop Linux thing, it’s a server Linux thing. You can host it on your desktop, but as soon as you do anything remotely server-related, CLI familiarity is pretty much essential.

      • AstralPath@lemmy.ca
        link
        fedilink
        English
        arrow-up
        12
        ·
        2 months ago

        That depends on your use case for desktop linux of course. For me, yabridge is the tool I needed to run VSTs on Linux. Its CLI only as far as I know.

        Don’t get me wrong; I’m not afraid of the CLI. Its just some tools are assuming the end user is a server admin or someone with deeper than the upper crust knowledge of how Linux works.

      • Damage@feddit.it
        link
        fedilink
        English
        arrow-up
        3
        ·
        2 months ago

        I always update via CLI 'cause most GUI tools are slow and buggy, so…

    • hactar42@lemmy.ml
      link
      fedilink
      English
      arrow-up
      20
      ·
      2 months ago

      Don’t forget the situations where you find a good blog post or article that you can actually follow along until halfway through you get an error that the documentation doesn’t address. So you do some research and find out that they updated the commands for one of the dependency apps, so you try to piece together the updated documents with the original post, until something else breaks and you just end up giving up out of frustration.

      • Someonelol@lemmy.dbzer0.com
        link
        fedilink
        English
        arrow-up
        6
        ·
        2 months ago

        That sounds an awful lot like modifying an ESP32 script I’ve been trying to follow from a YouTube tutorial published a while back. Research hasn’t uncovered anything for me to troubleshoot the issue so it’s a really shit experience.

        • winterayars@sh.itjust.works
          link
          fedilink
          English
          arrow-up
          1
          ·
          2 months ago

          That shouldn’t be too bad if you understand systemd though, right? Or is there something weird i’m missing? Do you have an example guide that illustrates the problem?

    • Flax@feddit.ukOP
      link
      fedilink
      English
      arrow-up
      9
      ·
      2 months ago

      CLI familiarity is fine. CD, Nano, mkdir, rm. I am proficient with that. But I am not necessarily proficient with Docker (went with it because it worked nicely for another thing which was well documented and very straight forward). It’s just I’m trying to self host stuff. Some things like Wordpress and Immich are straightforward. Some things aren’t like Matrix and Mastodon. Lemmy is also notoriously bad.

    • desentizised@lemm.ee
      link
      fedilink
      English
      arrow-up
      2
      ·
      2 months ago

      I think if you’re talking wider demographics your model OSs are (obviously) Windows and macOS. People buy into that because CLI familiarity isn’t required. Especially with Apple products everything revolves around simplicity.

      I do dream of a day when Linux can (at least somewhat) rival that. I love Linux because I am (or consider myself) intricately familiar with it and I can (theoretically) change every aspect about it. But mutability and limitless possibilities are not what makes an OS lovable to the average user. I think the advent of immutable Linux distros is a step in the right direction for mass adoption. Stuff just needs to work. Googling for StackOverflow or AskUbuntu postings shouldn’t ever be necessary when people just want to do whatever they were doing on Windows with limited technical knowledge.

      However on another note, if you’re talking a home studio migration, not sure what that entails, but it sounds rather technical. I don’t want to be the guy to tell you that CLI familiarity is simply par for the course. Maybe your work shouldn’t require terminal interaction. Maybe there is a certain gap between absolutely basic linux tutorials and the more advanced ones like you suggest. Yet what I do want to say is that if you want to do repairwork on your own car it’s not exactly like that is supposed to be an accessible skill to acquire. Even if there are videos explaining step by step what you need to do, eventually you still need to get your own practice in. Stuff will break. We make mistakes and we learn from them. That is the point I’m trying to get at. Not all knowledge can be bestowed from without. Some of it just needs to grow organically from within.

  • Voroxpete@sh.itjust.works
    link
    fedilink
    English
    arrow-up
    61
    ·
    2 months ago

    I write technical documentation and training materials as part of my job, and the state of most open source documentation makes me want to stab people with an ice pick.

    • Anonymouse@lemmy.world
      link
      fedilink
      English
      arrow-up
      15
      ·
      2 months ago

      You’re doing God’s work!

      Over my career, it’s sad to see how the technical communications groups are the first to get cut because “developers should document their own code”. No, most can’t. Also, the lack of good documentation leads to churn in other areas. It’s difficult to measure it, but for those in the know, it’s painfully obvious.

      • vonbaronhans@midwest.social
        link
        fedilink
        English
        arrow-up
        6
        ·
        2 months ago

        Jesus, technical people are some of the worst communicators I’ve ever worked with.

        It’s not necessarily their fault though. Y’know who goes into technical jobs? People who often prefer to work with machines, physical stuff, laws of nature, that’s who. And often because it’s MUCH easier than working with people, at least for them.

        On top of that, soft skills are HARD. Communication is HARD. It comes easier for some, but it’s a skill like any other. It’s the technical socialites, the diplomatic devs who become the best managers and leaders, due to the rarity of their hybrid skillsets.

        I’m in the middle. Just technical enough to mostly understand the devs and understand the implications of plans, and just enough soft skills to turn that into decent documentation, emails, and working with clients.

        SUCKS that I’ve gotten a taste of project management and hated the absolute fuck out of it. I probably would’ve been decent at it otherwise.

        • Entropywins@lemmy.world
          link
          fedilink
          English
          arrow-up
          6
          ·
          2 months ago

          “Well–well look. I already told you: I deal with the god damn customers so the engineers don’t have to. I have people skills; I am good at dealing with people. Can’t you understand that? What the hell is wrong with you people?”

        • corsicanguppy@lemmy.ca
          link
          fedilink
          English
          arrow-up
          3
          ·
          2 months ago

          SUCKS that I’ve gotten a taste of project management and hated the absolute fuck out of it. I probably would’ve been decent at it otherwise.

          Good PMs are rare, and precious. You could maybe give it another …

          emails

          oh, nevermind. :-P

    • matzler@lemmy.ml
      link
      fedilink
      English
      arrow-up
      13
      ·
      2 months ago

      Do you have some reading recommendations on how to write good documentation, e.g. readmes for end users?

      • SynopsisTantilize@lemm.ee
        link
        fedilink
        English
        arrow-up
        18
        ·
        2 months ago

        Yes. Here: "1.You aren’t writing an SOP for smart or even capable people., every. Single. Person. Needs their hand held all the way through every step regardless of technical skill. "

        “2.if you didnt state it needed to be done in the SOP, it will not be done when the end user follows the SOP”

        “3.MAKE someone else run through your SOP without you being involved. If they can successfully achieve what they needed using your SOP > congrats. If not > fix the errors that brought you to this mess.”

        “4. Everyone is fucking stupid, be clear, and verbose.” We’re talking about where the start menu is, clicking on the “OK” for prompts, how to spell and type things out.

        Change my given values per SOP and what it’s for. But those are my main tenants.

        • brognak@lemm.ee
          link
          fedilink
          English
          arrow-up
          9
          ·
          2 months ago

          In elemental school we had to write instructions on how to make a pb&j sandwich. The teacher then acted out your instructions literally, without adding or removing a step. I don’t think there was a single sandwich made that day.

        • sunstoned@lemmus.org
          link
          fedilink
          English
          arrow-up
          3
          ·
          edit-2
          2 months ago

          Excellent notes. If I could add anything it would be on number 4 – just. add. imagery. For the love of your chosen deity, learn the shortcut for a screenshot on your OS. Use it like it’s astro glide and you’re trying to get a Cadillac into a dog house.

          The little red circles or arrows you add in your chosen editing software will do more to convey a point than writing a paragraph on how to get to the right menu.

          • funkless_eck@sh.itjust.works
            link
            fedilink
            English
            arrow-up
            3
            ·
            2 months ago

            I would also add that you need to explain out-of-home steps, too.

            I’m not an idiot but I didn’t go to school for compsci or similar and I don’t do it as a job. So frequently the instructions will go

            • Get your IP address by entering this command
            • Type your IP address in this line
            • Now forward any chosen port to your proxy of choice and don’t forget to check your firewall settings!

            My sibling in Eris, most people dont know any of those words.

          • IronKrill@lemmy.ca
            link
            fedilink
            English
            arrow-up
            2
            ·
            2 months ago

            I agree, but I don’t think images should be relied on as the primary communicator. I have seen far too many forums/websites/docs with broken images because the host went down. That and archivers are more likely to fail at saving images. Explain it using text and give a reference image to further display the point.

      • Voroxpete@sh.itjust.works
        link
        fedilink
        English
        arrow-up
        9
        ·
        edit-2
        2 months ago

        I’ll see about digging up recommendations if I can, but I’m on my phone right now.

        My biggest single piece of advice would be this: Understand that your reader does not share your context.

        What this means is that you have to question your assumptions. Ask yourself, is this something everyone knows, or something only I know? Is this something that’s an accepted standard, or is it simply my personal default? If it is an accepted standard, how widely can I assume that accepted standard is known?

        A really common example of this in self-hosting is poorly documented Docker instructions. A lot of projects suffer from either a lack of instructions for Docker deployment, because they assume that anyone deploying the project has spent 200 hours learning the specifics of chroot and namespaces and can build their own OCI runtime from scratch, or needlessly precise Docker instructions built around one hyper-specific deployment method that completely break when you try to use them in a slightly different context.

        A particularly important element of this is explaining the choices you’re making as you make them. For example a lot of self-hosted projects will include a compose file, but will refuse to in any way discuss what elements are required, and what elements are customisable. Someone who knows enough about Docker, and has lots of other detailed knowledge about the Linux file system, networking, etc, can generally puzzle it out for themselves, but most people aren’t going to be coming in with that kind of knowledge. The problem is that programmers do have that knowledge, and as the Xkcd comic says, even when they try to compensate for it they still vastly overestimate how much everyone else knows.

        OK, I said I’d try for examples later, but while writing this one did come to mind. Haugene’s transmission-openvpn container implementation has absolutely incredible documentation. Like, this is top tier, absolutely how to do it; https://haugene.github.io/docker-transmission-openvpn/

        Starts off with a section that every doc should include; what this does and how it does it. Then goes into specific steps, with, wonder of wonders, notes on what assumptions they’ve made and what things you might want to change. And then, most importantly, detailed instructions on every single configuration option, what it does, and how to set it correctly, including a written example for every single option. Absolutely beautiful. Making docs like this is more work, for sure, but it makes your project - even something like this that’s just implementing other people’s apps in a container - a thousand times more usable.

        (I’ve focused on docker in all my examples here, but all of this applies to non-containerized apps too)

      • IronKrill@lemmy.ca
        link
        fedilink
        English
        arrow-up
        6
        ·
        2 months ago

        Well a good indicator is if I have to check the source code of a packaged program to understand what something does, the documentation is not good enough. And yes I’ve had to do this far too much.

        • corsicanguppy@lemmy.ca
          link
          fedilink
          English
          arrow-up
          4
          ·
          2 months ago

          have to check the source code

          Use the source, Luke.

          But yeah: disappointing. I just swapped out my Chef ZFS module because, looking at the source, it was incomplete in ways I didn’t want to rat-hole and extend while this other two-piece kit was there.

          I should use the source earlier.

      • KillingTimeItself@lemmy.dbzer0.com
        link
        fedilink
        English
        arrow-up
        5
        ·
        2 months ago

        as a chronic documentation reader, the best advice i can give is to document everything Anything that the user can and will potentially interact with, should be extensively documented, including syntax and behavior. Write it like you’re coming back to the project in 5 years after having done nothing and you want to be able to skip right to using it. When we build something ourselves, we often hold a bit of internal knowledge from the design process that never quite goes away, so it’s almost always a lot easier for us to reverse engineer something we’ve made, than it is for someone else with zero fore-knowledge to do it themselves.

        Generally this can be a bit of a nightmare, but if you minimize the user facing segment it’s not all that bad, because it’s usually pretty minimal, and what would otherwise be a handful of pages, turns into 10 or maybe 15.

        as for existing documentation, the i3wm user guide is really good, it’s pretty minimalist but it leaves you enough to be able to manage.

        • ByteOnBikes@slrpnk.net
          link
          fedilink
          English
          arrow-up
          4
          ·
          edit-2
          2 months ago

          as a chronic documentation reader, the best advice i can give is to document everything Anything that the user can and will potentially interact with, should be extensively documented, including syntax and behavior.

          I don’t know about that. I’ve read some terrible documentation that had everything under the sun. Right now in the library I’m using, the documentation has every available class, every single method, what it’s purpose.

          But how to actually use the damn thing? I have to look up blog posts and videos. I actually found someone’s website that had notes about various features that are better than the docs.

          There’s a delicate balance of signal vs noise.

          • KillingTimeItself@lemmy.dbzer0.com
            link
            fedilink
            English
            arrow-up
            1
            ·
            2 months ago

            yeah, it also helps knowing how to use the thing, but i consider that to be “basic documentation” personally.

            Knowing how to set something up is nice, but knowing how to use it properly after setting it up is even nicer.

    • ByteOnBikes@slrpnk.net
      link
      fedilink
      English
      arrow-up
      10
      ·
      2 months ago

      I used to mock people who make YouTube videos that literally just walk through the documentation. Like bro, get some reading comprehension!

      But then when I fumbled with some self hosting tutorials, those YouTube videos were the only thing that made sense, because they’re explaining why and how.

      Sorry y’all.