Press "Enter" to skip to content

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.

2 Comments

  1. George Walkey
    George Walkey 2026-10-14

    where would you put said Code Kevin?

    • Kevin Feasel
      Kevin Feasel 2026-10-14

      Database code, I would put in the same version control system as application code. Database objects are code like anything else, so those definitions should be maintained as such.

Comments are closed.