Keeping Documentation with Code

Andy Mallon shares some advice:

For years, I’ve advocated for keeping developer documentation in the same code repository as the code it describes. In the age of AI, that practice has become even more important.

The reason is simple: the easier we make it to maintain documentation, the more likely it is to stay current.

I do agree that having documentation live separately from code, most of the time, leads to outdated code. But then again, having documentation live with the code, most of the time, also leads to outdated code.