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

Linux.com

Using a wiki for FOSS application documentation

Posted by: Anonymous [ip: 143.166.255.41] on May 09, 2008 04:28 PM
When I started putting together the documentation for <a href="http://appsnap.gentrance.com">AppSnap</a>, I came up with a similar idea. I used <a href="http://www.tiddlywiki.com">TiddlyWiki</a>, which is a single file Javascript based Wiki engine. The result is a single HTML file that is bundled along with the app as the documentation as well as the official website for AppSnap easily maintained in source control.

There are some disadvantages to this approach such as having one perspective (official website in AppSnap's case) dominate over the other. The advantage is that the time spent in expansion and maintenance is much much lower, allowing for more time to be spent on development.

This approach is especially helpful for projects just starting out and can be enhanced once the project is established and more resources are available.

#

Return to Using a wiki for FOSS application documentation