Ask HN: How do your teams keep docs and code in sync?

2 points by iampotatoman92 142 days ago | 1 comment

1. Any war stories on how big of a problem can it be? 2. How did you/your team/org solve the knowledge rot problem?

Context: In my $DAYJOB, we have just started documenting. Its proven useful for humans and AI tools alike. However, code being pushed to prod doesn’t always mean docs are also updated. And we are soon heading towards a place where docs become meaningless.

From people who feel this day-to-day, I want to know: 3. What seems like it will work but doesn’t? (common pitfalls) 4. What solutions have you developed that work? 5. What ends up being the hardest part?

I’ve seen lots of discussion online about this problem, but extremely few concrete approaches.

Or maybe I am approaching this problem fundamentally the wrong way?

tacone 141 days ago |

Documentation is never really in sync, thus it's an heuristic. Henceforth, you could setup a pipeline to use AI for that. Not everything will be correct, but it never really is (unless the project is very small and focused or is very old and changes slowly).

Depending on your needs it might be a viable solution.