this post was submitted on 24 Jun 2024
59 points (94.0% liked)

Programming

17450 readers
78 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
snowe@programming.dev
Ategon@programming.dev
MaungaHikoi@lemmy.nz
59
What is the deal with API documentation that can seem so terse to a hobbyist? (lemmy.world)
submitted 4 months ago by j4k3@lemmy.world to c/programming@programming.dev
25 comments fedilink hide all child comments
 

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
[–] magic_lobster_party@kbin.run 13 points 4 months ago (3 children)

When someone writes API docs, should they assume the reader knows nothing or can they assume the is already experienced?

It takes a lot of effort to write documentation towards newbies, at the cost of making it more difficult for already experienced to find the answer they need.

[–] calcopiritus@lemmy.world 6 points 4 months ago

Docs should be written for someone experienced in programming but inexperienced with the API. If it is about a niche subject (for example VR).

Whenever an explanation contains something about that niche subject, you don't need to explain everything, but maybe provide a link towards another place (for example wikipedia) that explains it.

[–] ShaunaTheDead@fedia.io 5 points 4 months ago* (last edited 4 months ago)

Usually API docs are tucked away inside a "developer dashboard" or whatever they decided to call it. So I think you can assume at least moderate API and web development knowlege and programming skills.

[–] Aquila@sh.itjust.works 2 points 4 months ago (2 children)

Write multiple versions of docs for different audiences

[–] unique_hemp@discuss.tchncs.de 6 points 4 months ago

No way they will ever be in sync.

[–] magic_lobster_party@kbin.run 2 points 4 months ago

Which doubles the maintenance work to keep docs in sync