My hot take is that auto-generated docs from static types usually suck. Getting a randomly sorted list of function signatures is about as useful as just reading the source code.

Docs should get to the point and show people how to use the thing and fall back to type signatures for the nitty gritty bits when the examples don't suffice.

Golang/Java/Etc projects often just dump their types into an HTML page and call it a day without any context given to how to use it.

Follow

In my experience the best docs for the average codebase I encounter are their unit tests. At least there you can see how the devs expect their library to be used even if they don't provide actual examples or actual docs for how to use it.

· · Web · 0 · 2 · 2
Sign in to participate in the conversation
Mauvestodon

Escape ship from centralized social media run by Mauve.