Generating Documentation
High-quality code is not only well written, working, and tested—it is also thoroughly documented. Documentation allows us to share information that might otherwise get lost, draw a bigger picture, give context, reveal intent, and—finally—educate both external users and maintainers.
Do you remember the last time you joined a new project and got lost for hours in a maze of directories and files? This can be avoided. Truly excellent documentation leads a complete newcomer to the exact line of code they’re looking for in seconds. Sadly, the issue of missing documentation is often overlooked. No wonder—it takes considerable skill, and many of us aren’t very good at it. Furthermore, documentation and code can quickly become outdated. Unless a strict update and review process is implemented, it’s easy to forget that documentation needs attention too.
Some teams (in the interest of time or because they are encouraged...
