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

I agree, there was lot of effort put into python documentation i believe.

The scikit learn documentation is also really fantastic

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 it to be in (for example, the methods available for the list type aren't in the Built-in Types page even though lists are mentioned there, nor in its own dedicated list page, but are instead in a "More on Lists" section in the Data Structures page which apparently isn't linked in the types page at all)

But just because the Microsoft API documentation is always very meaningless. This could be from their docs:

  class SomethingProvider: "Provides functionality for communication with something"
  property string SomethingUrl: "Gets/sets the URL for the something endpoint"
  function Initialize(string[] roles): "Initializes Something-Provider with the given roles"

It's a shame that Google still seems to favour Postgres 9.x documentation and blogspam over the current documentation.

Yes, and the idea of using php.net/<function name> as a lookup (which has been the case for decades) makes it so painless

PHP does library documentation so much better than other languages. Compare: https://www.php.net/manual/en/function.ceil to https://docs.python.org/3/library/math.html#math.ceil for eg.

- Clear description, signature, types for parameters, return values.

- Examples, which will often cover edge cases.

- Separate page for each method

- A clear changelog section to document changes across versions.

Python on the other hand, gets a single sentence.

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

Django docs have much better examples than many of its "tutorials" out there.

I love Django. I was inspired this summer to start an open source project for gaps in their docs like setting up a local development environment, using React for the frontend, deploying to Heroku/AWS, adding Google Analytics, etc.

https://learndjangoreact.com/tutorial

https://learndjangoreact.com/docs/add-google-analytics