Today I learnt that Rust has an API guidelines book, with a ton of helpful advice on idiomatic style. For example, naming: https://rust-lang.github.io/api-guidelines/naming.html
Readers expect `to_foo()` to do more work than `as_foo()`, which was new to me.
miniblog.
Related Posts
I'm increasingly doubtful that commit messages should be entirely immutable.
I sometimes find myself editing or commenting on merged pull requests, to help future readers.
Phabricator appended a URL to commit messages, which helped. In principle PR merging could do the same thing.
You can learn a lot about your readers by looking at their referral links. In this case, the author can see different company-internal bug tracking URLs!
This enables you to learn about who has a problem that you're blogging about
Arbital is a really neat website design intended to help readers learn concepts.
Unlike e.g. Wikipedia, it can present the same content at different levels of complexity and dynamically show you the prerequisites for learning a given topic!
https://arbital.com/learn/Arbital_author_basics