Why is the documentation incomplete?
Asks every programmer since the dawn of time.
this post was submitted on 24 Jun 2024
64 points (94.4% liked)
Programming
17364 readers
179 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
Pretty busy at the moment, I'll get back to this later when I have sone free time.
API documentation isn't a tutorial, it's there to tell you what the arguments are, what it does and what to expect as the output and just generally, what's available.
I actually have the opposite problem as you: it infuriates me when a project's documentation is purely a bunch of examples and then you have to guess if you want to do anything out of the simple tutorial's paved path. Tell me everything that's available so I can piece together something for what I need, I don't want that info on chapter 12 of the example of building a web store. I've been coding for nearly two decades now, I'm not going to follow a shopping cart tutorial just in the off chance that's how you tell how the framework defines many to many relationships.
I believe an ideal world has both covered: you need full API documentation that's straight to the point, so experienced people know about all the options and functions available, but also a bunch of examples and a tutorial for those that are new and need to get started and generally learning how to use the library.
Your case is probably a bit atypical as PyTorch and AI stuff in general is inherently pretty complex. It likely assumes you know your calculus and linear algebra and stuff like that so that'd make the API docs extra dense.
Agree. I find “get started” usually is the best way to give an example of “entry point” to API. After that API documentation should get anyone covered for most of the cases. If API is big then it probably has primary and secondary set of features. Secondary then can be covered as tutorials.
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.
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.
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.
Don’t change the documentation, change the code to make them line up.
Unless the documentation is wrong
Sure - but in the real world that mostly only happens when the documentation is an afterthought.
I do find that everything related to Python is especially badly documented and/or maintained. Maybe I'm just not looking the in right place though? I don't generally use Python as my primary language.
Untyped function definitions + *args + *kwargs + args that can be of many types + strings used as enums don't help. The language that imo needs the most documentation is at the same time the one that lacks it the most.
I also don't generally use Python as my primary language, but NumPy has pretty good docs in my opinion!
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.
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.
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.
Write multiple versions of docs for different audiences
No way they will ever be in sync.
Which doubles the maintenance work to keep docs in sync
It's really hard writing software and knowing every bit of it then seeing it as a new user to write docs.
How do I get better at understanding API docs without a tutorial to walk me through the basics of how the library works in the first place? Once I have an idea of some of what the library does and how a few commonly-used functions work I can somewhat handle the rest, but getting to that point in the first place is pretty hard for me if no getting started or tutorial section exists. And so I'm very intimidated by a lot of libraries…
If there's no getting started section I usually go on GitHub to see how other projects use the library or API.
Reading the API docs with no prior knowledge or context is hard unless they're very well written.
Because usually if you end up at the API reference in that situation it's a code / project smell that other stuff is going wrong.
If I want to use a library to do something, you should be able to search for what you want to do + language / framework, find the library's docs, follow the install instructions and then look through the highest level API / instructions and then just go from there.
If you find yourself confused at unhelpful API references that just means that they have badly written top level API docs, badly written intros, or quite probably just badly written APIs.
I find that this is best explained by the four types of documentation theory. Often when you're starting out, you need a tutorial or how-to guide (or even just an overview of what the purpose and design language of the API is), rather than a reference, which is what nearly all API documentation is.
I often use grep.app to look for example. It's fulltext search for code on GitHub, and just get information about the parameters and output by looking at the library's code.