Friday, October 22, 2010

Re: Documentation missing

Writing documents is considered by many all to be a boring activity. But they are useful, and I learned this the hard way. A certain amount of documentation always helps, no matter how great your code is. (If you disagree, you are probably thinking about documents as those written using MS Word and seven different fonts. Not necessarily. Remember, a manpage is also a document. And if you can code without RTFMing, congratulations, You are God, so see if you can do something about World Peace). Anyway, as I was saying, good documentation is very important for any project. But as can be seen by worthy souls still lurking around here (I am hoping there are still some left), this aspect of the all important project called life (also known by the alias Journey) is being increasingly ignored (The last patch was released more than three weeks ago) by its lead developer (that is yours truly) (and despite claims to the contrary, see here). Of course he is not the only developer, lots of contributors being vital to the development, but bearing the ultimate responsibility for how the project turns out, it is also his responsibility to provide relevant documentation. So here is he announcing that even though the powerful bugs of boredom, laziness and nihilism (present in module cerebral_cortex) have not been entirely eradicated, they have been tamed enough to allow for at least a few releases of the missing documentation. The team (that is your's truly again, with all his alter egos) sincerely hopes that those interested in the project will find the documentation useful (in at least some sense of the word).

Enjoy!!

No comments: