4 ms·
You stop writing code for a 'week'. Don't 'touch' the codebase during that time. Come back after that duration has passed, re-discover the code and write the do
by Link- 12y ago
You stop writing code for a 'week'. Don't 'touch' the codebase during that time. Come back after that duration has passed, re-discover the code and write the documentation then.
- superice 12y agoI didn't touch the code for about 'two weeks', but sadly the code base is small enough to remember pretty much everything.
- Link- 12y agoI understand, there's a threshold beyond which the details of your code become somewhat blurry. I shouldn't have emphasized the duration as I'm not entirely sure what it amounts to, usually a week is enough for me :) The point is, find something that will distract you enough to forget these details, allowing you to become your target audience while writing the documentation. This is one way to zoom out and discover what is important and what is not.