63

I've encountered this many times where I simply don't understand the context and use of an API based of the API documentation unless I can find an example that already utilizes it in a working project. The first thing that comes to mind is Py Torch. I've tried to figure out how some API features work, or what they are doing in model loader code related to checkpoint caching but failed to contextualize. What harebrain details are obviously missing from someone who asks such a silly question?

you are viewing a single comment's thread
view the rest of the comments
[-] hperrin@lemmy.world 31 points 1 week ago

It’s because the same people who wrote the code usually write the docs, and people who are really good at writing code usually aren’t good at writing docs. It’s two different skill sets that usually don’t coincide.

Case in point: my own documentation for https://nymph.io

I know it’s bad, but I don’t know how to make it good. The code, however, is pretty good. It runs my email service.

Open source projects also aren’t very good at attracting people who both want to volunteer their time writing technical documentation and can.

[-] Carighan@lemmy.world 8 points 1 week ago

It’s because the same people who wrote the code usually write the docs, and people who are really good at writing code usually aren’t good at writing docs. It’s two different skill sets that usually don’t coincide.

This is why companies ought to employ technical writers if they have enough documentation. Of course, few ever do, but it'd by the Right Thing™️ to do.

load more comments (4 replies)
this post was submitted on 24 Jun 2024
63 points (94.4% liked)

Programming

16210 readers
162 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 1 year ago
MODERATORS