- **Epistemic status:** #seedlings Some engineers treat documentation as an unfortunate necessity or a low-priority task, but documentation is an integral part of the process. Writing documentation can be made easier by keeping it on the code itself. It is quite easy to produce documentation from source code by using comments. Once example is by adding comments to modules or exported functions, helping other engineers when they most need it. That being said, don't comment in a mechanical way on every function, data structure, type declaration, etc. about what the source code is doing. The source code already says that, and it violates the DRY principle. Instead, restrict your non-API commenting to why something is done, trade-offs, why decisions were made, etc. --- ## References - Thomas, David, and Andrew Hunt. _The Pragmatic Programmer, 20th Anniversary Edition: Journey to Mastery_. Second edition. Boston: Addison-Wesley, 2019.