3 ms·
It has happened to me multiple times that I’ve been writing the documentation for a system I’ve created, and found that it’s hard to even describe how to use th
by teddyh 4y ago
It has happened to me multiple times that I’ve been writing the documentation for a system I’ve created, and found that it’s hard to even describe how to use the system, let alone to actually use it. I think “why can’t the system do all this automatically for me?”, and I fix the system to do exactly that, and then I’m relieved of the burden of having to write any documentation for how to do it manually. And as a result the system is better and easier to use for everyone.
- sandruso 4y agoThis. Everybody should try call API / functions without actual implementation to see if it feels right.
- teddyh 4y agoNote: This is a noted positive side effect of doing TDD.
- MattPalmer1086 4y agoWriting documentation is one of the best ways to realise that you never thought much about using it :). I do this all the time too.
- euroderf 4y agoDocumentation, too, needs debugging.