This is a read-only archive. Find the latest Linux articles, documentation, and answers at the new Linux.com!

Linux.com

wiki makes sense

Posted by: Anonymous [ip: 66.114.78.90] on May 10, 2008 05:40 PM
For an open source project run by volunteers, using a wiki for documentation just makes sense. It doesn't even have to look like a wiki, and it doesn't have to be editable by the general public. We did the web site for <a href="http://www.citadel.org">Citadel</a> using DokuWiki, after finding Joomla a bit too cumbersome for the task. DokuWiki was very easy to customize -- we were even able to convert our Joomla theme with about an hour of template editing.

Wiki editing controls do not appear unless you're logged in, and only the developers and site maintainers are allowed to log in. But we're very, very diligent about one thing: whenever someone asks a good question in the support forum, we add another wiki page documenting the answer. By doing this, we've ended up with a Knowledge Base for the program. And if you ask me, that's more comprehensive than a "FAQ" -- let's face it, the FAQ's for most open source projects aren't made up of actual questions that were asked -- they're more like a README written in question-and-answer format.

#

Return to Using a wiki for FOSS application documentation