Documenting the many small conventions of a project

The bigger the project the more the devil is in the details: how you handle exceptions, how you log errors, how you setup your VSS connection, etc., etc. There are dozens (several dozens) of small conventions that a team must follow and many times people don't follow these conventions simply because they don't know about them or because it's 3 AM and go figure in which lost manual is the standard for connecting to a SMTP server (*if* such a standard exists for our project) so we just fire up or own solution (or, if we are clever, cut&paste and example from MSDN) and there goes the standard, that's one of the many beginnings of the end of the normalization.

Thus, big projects badly need a very easy way to post and search for team related information. Enter the WikiWikiWeb, a really-easy, no-frills tool for creating informational sites. Today, I talked about it to my team (well, actually, our customer's team) and showed them a few pages created with FlexWiki. They were simply amazed  (one of them even started to keep his to-do list in our wiki) and now we have more chances that our team conventions are posted, so may be read, so hopefully followed. There are a number of implementations of the WikiWikiWeb, I chose FlexWiki mainly because it requires no database or XML file or anything else for storing the pages (we are a small team, we don't want our efforts deviated at all). My fellow RD Eric Groise has also implemented SushiWiki, both wikis are ASP.NET based of course. Do give a try to any of them, your project manager will thank you.

No Comments