The Joy of Documentation

Posted September 11, 2005 at 10:24 am in cat4

So today’s the day I finally hunker down and being work on the full documentation for the upcoming YaBB2. Needless to say, I’m far from thrilled. Doc writing has all the excitement of watch cows eat grass without all the fun and hot cow on grass action. What’s worse, as a writer, I have to assume the reader is a complete idiot. Not that I mind that part, of course, but it can become so mind numbing.

However, I do it anyhow. YaBB is one of my first online loves. It’s not just the fact we’ve stayed strong in the face of the exodus towards PHP, but the dedication of the end users and the rest of our staff is simply overwhelming. I honestly could not imagine not working on or with YaBB.

Back on subject (before I start singing 80’s power ballads), I’ve been going over the documentation for several other applications. Most notable of them is the WordPress Codex. That’s imply an astonishing manual and I think YaBB would be well served to use that as a model for it’s own. Though, I’m highly torn about actually making the Wiki portion of open to the public. We’ve had our share of asshats over the years and I’d rather not have to worry about a massive cleanup (granted, MediaWiki does make it easy). On the other hand, it could prove highly useful to have the whole community keep up on things. After all, look at how well the Wikipedia turned out…lol.

RSS 2.0
No Comments Chicks Dig First Posters!
Leave a Comment