Self documented development through inch-pebble checkins

Friday, May 01, 2009 1 Comments

Developers hate writing documentation. But when you find a weird bug or need to understand why a certain change was done, then you wish you had proper documentation. The problem seems hard to solve. Good comments can help and techniques like diff debugging and proper code review tools can help too. But what every developer does on a regular basis is checking in code to his repository. What if the way in which you check in could help self documenting the code?

Side note: I find the technique I describe here not only good for self documenting changes but also to capture the way in which lead programmers work in such a way it can be used to teach the newcomers...

Read more...

1 comment:

  1. Sadly, Dr Dobbs flushed this article from it's archive. Any chance you could post the article in full here?

    ReplyDelete