What's your go-to way to keep docs in sync with your code?
by•
Documentation has a way of going stale the moment code changes. Curious how teams here handle it. Is it manual updates, doc generators, CI hooks, something else?
Interested in what actually works at scale vs. what sounds good in theory.
15 views
Replies
Until recently, my answer would have been: "We handle this very poorly." Documentation is rarely prioritized and updated. It's kind of a trope that it gets neglected, along with Testing, Security, and Reporting. There are only so many hours per day. And writing takes time.
This year, it's one area where AI-assisted programming has made a tremendous difference for me. I can "scribe code": begin with full documentation from Day 1, and iteratively and continuously update docs with every commit.
ADRs, Design Docs, Requirements
Functional and Technical Code documentation
User-facing documentation
All of it quite a bit easier now.