I was driving today and I saw a car with this bumper sticker. My wife was with me so I had to explain to her why I thought it was funny. Like all good humor, this bumper sticker is rooted in truth. In my job, I have had the opportunity to work in a wide range of industries. It is an almost universal truth, that as a practitioners, we do a poor job documenting our code.
Why don’t we (and I do mean we) document our code?
Sometimes it is just laziness. I know that when I write code and it works, I consider the task done. I often view documentation as a separate task, a burden.
Often we as project leaders, fail to plan and budget for documentation. Doing it right takes work.
In some cases, it is precisely this sentiment. Since the code is the truth why should I document it? In fact one of the problems with documentation is that it must be maintained, just like the code. The only thing worse than no documentation is bad documentation.