How we intend to use the Wiki

A Wiki Web is not intended to replace the email list communications. In fact, it is a very poor design to capture "threads"--email threads not java.util.Thread kind. That is a feature that the Wiki was never designed for. Below is a list of some simple guidelines for the Wiki:

  • Keep It Simple, Stupid (KISS). All we want to do is keep the most current draft of a proposal on the Wiki. We want to use the list as the chief collaboration tool.
  • If it can be discussed on the list, don't put it here. 9 times out of 10, we can adequately satisfy our needs with the list.
  • If it is a document or a formal proposal, put it here. It can be confusing after 20 emails or so are exchanged regarding a document to keep track of the latest version, and all the erata that needs to be applied to it. By keeping the latest draft on the Wiki, we know where the current discussion is.
  • If you don't need it, get rid of it. Nothing worse than wading through mountains of cruft to find a few nuggets of gold. When a proposal has been voted on, convert it to XDocs and incorporate it into the project. This is just a scratchpad.

Actually, there are a lot of things worse than wading through mountains of cruft to find a few nuggets of gold; at least you've found gold. IMO, Wikis are best at compiling lots of raw ore – admittedly, much of it cruft – then refactoring and cleaning it until it becomes almost pure gold.

What would not be good here

  • A copy of our web site. We already have one.
  • A 60 page document (like "Developing With Avalon").
  • Stale information. Use it or lose it.
  • No labels