3 ms·
I find documentation as a hygiene practice like washing my hands. Most of it is unread, and when it is, I don’t know about it. But it helps me to write it as I
by prepend 5y ago
I find documentation as a hygiene practice like washing my hands.
Most of it is unread, and when it is, I don’t know about it. But it helps me to write it as I can revise the code that the docs are supposed to reflect. I try, whenever possible to embed docs directly in source or at least the repo.
I generate static sites from them and a few years ago added our web analytics to find that the docs are actually read. So they are used, but it’s jot like the readers send me notes saying “great docs, they helped me X.”