Tailscale's documentation: https://tailscale.com/kb/
Ask HN: What is example of good documentation in your opinion?
11–20 of 71 posts
Re: Ask HN: What is example of good documentation in your opinion?
#12FreeBSD & OpenBSD documentation are pretty good in the OS space.
Re: Ask HN: What is example of good documentation in your opinion?
#13PHP: https://php.net/manual/function.str-contains
Yes, and the idea of using php.net/ as a lookup (which has been the case for decades) makes it so painless
Re: Ask HN: What is example of good documentation in your opinion?
#14The best I've seen were the Tandem manuals. This was 30 years ago.
Re: Ask HN: What is example of good documentation in your opinion?
#15The built-in documentation of QBASIC.
Re: Ask HN: What is example of good documentation in your opinion?
#16IMO the numpy docs are great: https://numpy.org/doc/stable
There’s always good explanation and examples within their docs
Re: Ask HN: What is example of good documentation in your opinion?
#17Django 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.
Re: Ask HN: What is example of good documentation in your opinion?
#18Re: Ask HN: What is example of good documentation in your opinion?
#19PHP: https://php.net/manual/function.str-contains
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.
Re: Ask HN: What is example of good documentation in your opinion?
#20I love the documentation for Ansible. You have a good amount of well thought out examples, very well written explanations for things, and links to other related functions.
https://docs.ansible.com/ansible/latest/collections/ansible/...