Best Practice
I am not sure why, but out of the set of all anti-patterns, drive-by coding is the one I am personally most disturbed by.
Perhaps that's because it's so unnecessary. Perhaps because it's indicative of laziness on behalf of the developer.
Perhaps because it is, itself, a smell of much more serious cultural issues. For exactly this last reason, if not for
any other, I feel very strongly that this particular anti-pattern should be uprooted mercilessly whenever noticed, before
it becomes endemic…
In a previous post I promised to write an article about the shortcomings of Agile. I recently had an exchange
with a former colleague that convinced me the time has come to have an honest discussion about what Agile does
not do well. Through the years, Agile seems to have acquired a cult status, where people seem to think that it
can, not only, do everything, but do it superlatively well. Anyone who has actually used Agile methodologies
knows that neither of those points are true, yet Agile…
How do you document units, modules, libraries, and APIs in your system, so that people know how to use them?
Note that for the purposes of this discussion we are not referring to code comments, which are mainly directed
at the team constructing and maintaining the module, but rather to client documentation for those who will use it.
