this post was submitted on 29 Oct 2025
53 points (98.2% liked)

Programming

24135 readers
464 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev



founded 2 years ago
MODERATORS
 

I’ve been switching from Vim to Helix recently. I did the built-in tutor, and whenever I need to configure something, I look it up in the docs. The problem is, I only find what I already know to look for. Without reading the documentation more broadly, I don’t really know what I can configure in the first place.

So I’m curious, do you sit down and read documentation to understand a tool, or do you just search it when you hit a specific problem?

top 15 comments
sorted by: hot top controversial new old
[–] Album@lemmy.ca 24 points 2 months ago (1 children)

Depends on the docs but if they're written well you're best served by reading them in full. Rftm before looking at best practices and tips.

Problem is a lot of people don't understand how to read a doc. There's a terminology, phraseology, syntax. I have so many instances of people who say they didn't see the answer in the docs and then you look and it's right there. But the human mind tends to discard info it doesn't understand how to process.

If you think you know how the Internet works but haven't read the RFCs you might not know as much as you think you do. Read pretty much every one on ipv6 because the second hand resources are absolutely garbage.

[–] JustEnoughDucks@feddit.nl 5 points 2 months ago* (last edited 2 months ago)

Yes, but I am also of the opinion that not one single acronym should be used without at least once in the section saying what the acronym is. Many many programing docs with say what am acronym is exactly once, somewhere in the docs, and then never again.

Also, if there are more complex concepts that they use that they don't explain, a link to a good explanation of what it is (so one doesn't have to sift through mountains of crap to find out what the hell it does). Archwiki docs do this very well. Every page is literally full of links so you can almost always brush up on the concepts if you are unfamiliar.

There seem to be 10 extremely low quality, badly written, low effort docs for every 1 good documentation center out there. It is hard to RTFM when the manual skips 90% of the library and gives an auto-generated api reference with no or cryptic explanations on parameters, for example.

[–] bjoern_tantau@swg-empire.de 13 points 2 months ago

I read the part I'm using. So if I'm configuring something I look through all the available options. But I wouldn't look through every functionality that's available.

Or if I'm working with a library I look at an overview of what classes are available and when I'm using a class I look at what that can do. But I won't look at every single part. That would overwhelm me.

[–] ExLisper@lemmy.curiana.net 10 points 2 months ago

If it's some new tool I want to learn I will read the docs.

If I have to implement/fix something I just search when necessary.

[–] olafurp@lemmy.world 9 points 2 months ago

Depends. In the case of Angular the docs are very good so I read large sections of it. Doing the hero intro was really good at getting me up to speed.

For dotnet I don't like them. It's 50% reference manual and has few examples for the more niche things.

[–] sbv@sh.itjust.works 6 points 2 months ago

If it's readable and well organized, I read it. I did the vim tutorial because it was very easy to run through. Ditto for some of the Android lifecycle docs.

But there are a lot of bad docs out there.

[–] GammaGames@beehaw.org 5 points 2 months ago* (last edited 2 months ago)

Good question! When I’m learning a new tech usually try to search for best practices in configuration, then read the docs to see why the settings are being recommended.

Other than that I just try to remember where to find what I need

[–] aev_software@programming.dev 4 points 2 months ago (1 children)

I love documentation if it's written well and if it's helpful.

I can't say I find vim's documentation meeting either of those criteria.

So I reach out to other sources who figured things out and regurgitate their experiences in ways that fit how my brain likes to consume them.

[–] crimsonpoodle@pawb.social 2 points 2 months ago

The GDB manual is an example of well written and helpful documentation. All of android is not.

[–] realitista@lemmus.org 4 points 2 months ago* (last edited 2 months ago)

If it's something I will be using a lot and in depth (such as your editor case), it's worth RTFM. For other stuff just try to find the bit I need. It also depends to some degree how similar it is to other stuff I've used before. I may be able to grok a lot of stuff intuitively if it's similar to stuff I've done elsewhere. For instance jumping between versions of Unix was like this.

[–] Feyd@programming.dev 3 points 2 months ago

I read it. Saves a lot of time in the long run

[–] thedeadwalking4242@lemmy.world 2 points 2 months ago

I read, when you read you gain very deep insight if it’s written well

[–] InternetCitizen2@lemmy.world 2 points 2 months ago

I tend to search.

[–] arty@feddit.org 2 points 1 month ago

If I know that’s a tool I will use a lot, I will try to read its documentation. I’ll just look up the basic info for basic tasks otherwise.

Reminds me how times ago I would install a new GUI application and then would just go through every menu, every setting, every dialog it had. This was much quicker than documentation and still gave me an outline of what’s possible.

[–] Sxan@piefed.zip -2 points 2 months ago

Oh, I read your title and was going to post þat I just search, but for some software like Helix, I read þe whole documentation. I read tutorials, for Helix.

Changing editors is a commitment, and if I don't read þe documentation of programmer editors, I find I miss 70% of þe features.

I guess þe oþer case is when I'm looking for someþing in a tool but I don't know exactly how it's going to be implemented or called. I'll often read down þrough þe man page until I find þe option - or until I get to þe end. I've read þe whole ripgrep and fd man pages several times þis way. But zshall - it's huge. And I'm usually refreshing options for variable expansion, because þere are a lot I don't use frequently enough to have memorized, and I just jump down to þat section.