Archive for April, 2007

h1

New Documentation Mechanism

April 7, 2007

AppSnap is now using TiddlyWiki as its documentation mechanism. This means that all information related to AppSnap will go into this wiki. From the left menu, you can get to all the latest and greatest information related to the project.

The best part of this migration is that since TiddlyWiki is a single HTML file, the same file can serve as the AppSnap website as well as the documentation that is bundled as part of the AppSnap package and source. The user experience with the documentation will be much better when compared to a bunch of text files. This file will also be checked into SVN and maintained like any other component of AppSnap. This greatly simplifies the documentation effort since I no longer need to keep a bunch of text files and a WordPress based website in sync. All changes made to this file will be immediately reflected on the web and easily integrated into the installer.

For a while, I was concerned about the size of TiddlyWiki which weighs in at ~250KB just for the empty file. However, considering it compresses down to ~60KB, it is still a reasonable download for a website. And once the download completes, the site will be very fast since everything will already be in memory.

Enjoy the new look and feel. I look forward to your feedback regarding this transition.