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?

  • hperrin@lemmy.world
    0·
    5 months 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.

    • abhibeckert@lemmy.world
      0·
      5 months ago

      Here’s a tip on good documentation: try to write the documentation first. Use it as your planning process, to spec out exactly what you’re going to build. Show the code to people (on GitHub or on a mailing list or on lemmy or whatever), get feedback, change the documentation to clarify any misunderstandings and/or add any good ideas people suggest.

      Only after the docs are in a good state, then start writing the code.

      And any time you (or someone else) finds the documentation doesn’t match the code you wrote… that should usually be treated as a bug in the code. Don’t change the documentation, change the code to make them line up.

  • magic_lobster_party@kbin.run
    0·
    5 months ago

    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.