Writing Documentation

Funnily enough, for someone who generally likes writing stuff, (regardless of whether it’s webpage, letter, PHP functions, fiction, blog posts, etc.) I hate doing documentation for things I’ve already created. Going back over these things is (in my opinion) usually a pain in the bum, and it’s all- well- old. Been there, done that.

I know, I shouldn’t feel like that, but I do. I admit it. And of course this week I’ve been writing loads of bits of documentation for all the stuff I’ve been doing over the last year or so. In some ways it’s actually been quite useful because it’s reminded me of some of the groovier functions that I’ve created for the site, and some of the bits of arcane esoteric hackery without which the site wouldn’t even function. This is also useful for when I rewrite the client page on the business site, and also the “what I’ve been doing” bit on my CV.

But it’s still so dull. I can’t even really think of any way to brighten it up or lighten the work a little – it’s just dull. No two ways about it. Useful to people in the future, of course, and it’s all written in a way that should make sense to even the most numpty of newbies (I get to test that on some of my colleagues. Heh.) but still, dull.

Of course, on this occasion I’ve actually also been looking at older stuff and also suddenly clicked with a way to rewrite it that makes life lots easier all round, and removes the elusive point-of-failure that was lurking in there for the unwary. So in that case writing documentation had an added bonus which I wasn’t expecting.

It’s still piggin’ dull though. *sigh*