Here are some suggestions on how best to use the wiki.
- Best Uses
Use the Wiki for content generation. Once a Wiki page seems extremely well written and informative, consider rolling it into the project's FormalDocumentation.
Avoid duplicate effort - Before documenting something new, look in RecentChanges and perhaps do a search. Someone else may be thinking the same thing!
Wiki != Apache Website - Don't Use the Wiki just to duplicate or replace the actual website. It is also important to note that a Wiki page that simply points to an existing website, is rarely necessary.
It is probably best to hold discussions on the appropriate MailList; however, the wiki is a great place to collaborate on proposals, preliminary design, etc. Those things tend to get muddled into a long series of ">>>>" on the mail list with everyone trying to figure out what it says..
- You can use it to gather input from the community: most wanted features, who is using such framework, resource/link page.
- Technical Tips and Best Practices
Use Redirects - Make ample use of redirects to link acronyms and abbreviations to full topics (i.e. EU and EuropeanUnion point to the same page... ) If you move a page, you should change all the references to that page, or provide a redirect.
Keep it simple - Don't try to get fancy with formatting, the idea of the wiki is to let you brainstorm/collaborate on documentation with others.
Use Subpages - Use subpages for project and subproject specific pages. Example, "Struts/FrequentlyAskedQuestions", "JakartaProject/PMC"
Choose descriptive wiki titles - TheProposal means nothing. AntV2Proposal is better, but since it isn't plural it makes new contributers feel unwelcome (although MikesAntV2Propsal would be just fine). AntV2Proposals is descriptive and invites community input (why else use a wiki?). Even better than AntV2Proposals = AntProject/V2Proposals