Ask HN: What is example of good documentation in your opinion?

Post by zasdffaa » Sun, Nov 20, 2022, 9:34 PM UTC

thiht wrote: post #56

bakugo wrote: post #37

Earlier quoted context omitted.

I'll have to disagree. Many things about it are a constant source of annoyance for me, such as the fact that function arguments and return types aren't listed in a standard format with a short description of each and instead they expect you to read the entire (often quite large) paragraph of text below each function to find that information, and the fact that a lot of information isn't found in the page you'd expect…

Completely agree. The Python docs are almost unreadable to me. Every time I’m looking for something (a function parameter, example usage, etc.) it’s the same: - I Google it - I look for the official docs page (usually 5th or 6th result) - I tried to find my answer but don’t understand the organization and cannot find the correct keywords to Ctrl-F - I go back to my Google search frustrated and try to find a suitable…

Post by mmusc » Sun, Nov 20, 2022, 9:58 PM UTC

Post by jfornear » Mon, Nov 21, 2022, 3:29 AM UTC

leetrout wrote: post #17

Django is one of the gold standards for me. Great examples. Clearly noting what versions things changed. Ability to switch versions at the click of a button. https://docs.djangoproject.com/en/4.1/

Post by fm200 » Mon, Nov 21, 2022, 8:55 AM UTC

btschaegg wrote: post #51

thanatos519 wrote: post #29

Earlier quoted context omitted.

I've never used Arch but I always find the best (and mostly distro-agnostic) documentation there!

This. You know your distro has great documentation when you constantly use it to fix problems in other distros…

Post by Crono » Mon, Nov 21, 2022, 3:28 PM UTC