The answer is to create some documentation for your code, preferably good, comprehensive documentation. Or someone wants to use the code from your repository and keeps submitting issues asking questions about it.
Or when the colleague who wrote that code leaves the team and now you're responsible for maintaining it. Creating even the most simple documentation - notes in work tickets, comments in code, a README file - helps us remember what we created, how it works, and why we coded it that way months later after we've written thousands of lines of completely unrelated code. It happens all the time and I've seen it over and over. and now you'll spend the better part of a day relearning the code you wrote in the first place. Hey, I bet you've even written code that, six months later, you forgot how it works. We've all written code that works perfectly fine for us, because we wrote it, but other users need help knowing what it does and how to put it to work.
It's no secret that I believe documentation is a crucial element of quality software - and not just because I've spent most of the last 25 years working on end-user and developer documentation.
0 kommentar(er)
