3 ms·
> Because the Rust docs seem to be more aligned with the 4doc model than the Python docs, and the Rust docs are more praised than the Python docs. I can't spe
by steveklabnik 3y ago
> Because the Rust docs seem to be more aligned with the 4doc model than the Python docs, and the Rust docs are more praised than the Python docs.
I can't speak to the Python docs. Sadly, it seems that Mozilla has lost the recording of me in 2013 laying out my vision for Rust's docs, which is what became reality.
I had never heard of the four-document model, but instead presented a "three document model":
* Tutorials: long form documentation that explained concepts. This became The Book, but pre that, there were a number of ~5 page tutorials on various things.
* Language Reference: specific documentation that's closer to a specification
* API Documentation: documentation per module, function, whatever specific unit, unconnected to other stuff.
I had come to understand documentation in this way based on my time with Ruby and Rails. Tutorials are Rails Guides. Reference is a language spec (of which Ruby doesn't really have one but I thought that was pretty sad). API documentation is rubydoc.
Eventually, "tutorials" kinda morphed into "the bookshelf," thanks to mdbook.
- kaycebasques 3y agoOh, great! Super valuable to go "back to the source" and learn how exactly the Rust docs came about. I don't know why I never thought to just ask you, hah. Thanks for sharing.