3 ms·
I like API docs. Docs where each module, definition, function, etc. is documented. Then I can see the docs in my IDE. If the API docs have a good search functi
by armchairhacker 4y ago
I like API docs. Docs where each module,
definition, function, etc. is documented. Then I can see the docs in my IDE.
If the API docs have a good search function, then I can actually search directly from the docs instead of Google. They should also have lots of links because often I’m just clicking through references.
I also really like examples. Especially
when they’re examples of something i might actually do (e.g. how to use a file library to read a file), to the point where sometimes I just copy/paste them.
High-level theoretical documentation is good too, but make sure you have the API documentation and examples first. Also try to use graphics and diagrams where appropriate. People have garbage attention spans and most people won’t read a wall of text.
The best documentation I know so far is the Rust standard library in docs.rs. Lots of Cargo packages also have great documentation. The Rust / Cargo books are a great example of higher-level documentation. If you write docs like well-documented packages on docs.rs you should be good.