2 ms·
There is a lot hidden in the "idea that writing tests and documentation is actually worthwhile." Few (any?) will argue against that. The problem is there are
by taeric 9y ago
There is a lot hidden in the "idea that writing tests and documentation is actually worthwhile." Few (any?) will argue against that. The problem is there are actually three skills embedded there.
I am coming to view it in three parts:
Testing code typically benefits most from being able to think about how the code is not supposed to act.
Writing code is typically describing what you want.
Documenting code is talking about how all of the code is supposed to work together.
I think most examples online that try and get folks better at any one of these, pick an example that is worthless for the other two skills. In particular, writing solid tests for a function or unit does little to help document how it will work with all of the other parts. Writing good documentation for a unit is trivial, so not often applicable to a person's day job. And then seeing the documentation for a full piece is often too much to include the code and tests. (I'm talking specifically about "blog" level articles.)