|
|
|
|
|
by cborenstein
2301 days ago
|
|
In my experience, code documentation is painful because people often try to maintain perfectly comprehensive formal docs and the expectation is too high. Aiming for perfection instead of iterative improvements can feel intimidating and painful. I recently wrote this blog post on how you can use lightweight daily habits in git and https://bytebase.io (I'm one of the creators) to avoid the dreaded "Docs Overhaul" that seems to happen every couple of months. Blog Post: https://medium.com/better-programming/daily-habits-to-turn-y... The main idea is to capture small chunks of context as part of your regular coding routine. This can be in a git commit message if it closely relates to code or in an external knowledge sharing tool if it is higher level context. |
|