document your code

Over on Chris Shiflett’s blog is a guest post from Elizabeth Naramore, php/web developer, in which she talks about commenting and documenting code, using a dishwasher as a common analogy. The post is well-written and can apply not just to code documentation, but security process documentation as well. Many of my colleagues hate doing documentation and as such we have painfully little of it, but I’ll always do my best with it because I think it is especially valuable. I think some people think it is so simple, they never get around to it, and as such, this “simple” thing never gets done.