5 ms·
For the languages I've used (Node and Python), I'm just comparing the ease of finding documentation on the language homepage. A typical flow is: Homepage > docs
by lloyd-christmas 9y ago
For the languages I've used (Node and Python), I'm just comparing the ease of finding documentation on the language homepage. A typical flow is: Homepage > docs > reference/api
Node is very straightforward:
https://nodejs.org/api/index.html https://nodejs.org/api/index.html
Python has a library reference and a language reference:
https://docs.python.org/3/library/index.html https://docs.python.org/3/library/index.html
https://docs.python.org/3/reference/index.html https://docs.python.org/3/reference/index.html
All 3 of these pages are blatantly obvious index pages. For Rust, this is where I assume you're supposed to end up (there are way too many links on the "Documentation" page, I'll address this at the end):
https://doc.rust-lang.org/std/index.html https://doc.rust-lang.org/std/index.html
You have to navigate/scroll to see the actual list of modules/types/macros or minimize the "about" section. The first thing that I think I should see on an API docs page is an index with maybe a very short blurb/link in regards to the prelude. If the API reference needs a "How to read this documentation" that is long enough to block you from seeing the index itself, something is wrong. Any user that clicks into an API specification either knows how to read it or knows how to click a link that says "about these docs". If they didn't, they would likely be in the "learning" section. Beyond that, the section has a list of 4 links, 3 of which are anchors (that are both out of order and already listed on the left nav) while the prelude link goes to a completely separate page.
To address the Documentation landing page, you have "Learning Rust" and "References". Learning Rust > The Rust Programming Language and References > Syntax Index effectively both go to the same page. At the bottom you have a "Project Policies". Are those really part of "Documentation"? I generally think of "language" documentation, not "organization" documentation when I see the header. I would expect a documentation landing page to be a lot more minimal and easier on the eyes, similar to:
https://doc.rust-lang.org/nightly/ https://doc.rust-lang.org/nightly/
What that page has in common with almost every other language documentation page that I just visited: Bullet points and/or indentation.
EDIT: I should add that I browsed around various language pages while writing this. To add some context for my opinions, I found the Elm docs to be far and away the easiest to navigate excluding the fact that they don't have links to the source code per method. I made it to their API docs without ever hitting an incorrect link. Julia was similar, but I mis-clicked on the manual rather than the standard library because everything is on the same page and neither section collapses.
- steveklabnik 9y agoThank you! It's a bit late here, so I'm going to bookmark this and get back to it when I can fully appreciate all the detail <3