The easy Weblog and Wiki Software
[ start | index | login ]
start > Documentation Discussion

Documentation Discussion

Created by hotmaz. Last edited by hotmaz, 4 years and 208 days ago. Viewed 214 times. #1
[edit] [rdf]
labels
attachments
SnipSnap is a great work and I appreciate you for all the effort.

As a Newbie I had some problems to get the right informations and to figure out which functionality is built in and which is in work. Many times the information in the snip itself is outdated and one has to follow all the comments to figure out the current state. This is not what I expected under knowledge management.

Many macros (even image) are not documented right and one has to search for a snip using this macro to get an idea of the power of some macros.

I would suggest to take a namespace documentation and put all documentation snips there and have the documentation index page indexing all documentation relevant snips.

The documentation snips should be kept up-to-date. That means every time a comments/answers brings more light in the darkness, this should be followed up in the snip itself.

Some concepts are not clear or have been implemented different from the content in the snip. (i.e. the label concept, it was not possible to figure out the meaning of all the LabelTypes).

I hope this call for discussion will help to improve the quality of the documentation and easy up the life of the users and the developers. Maybe someone will start a documentation initiative?

2 comments (by carsten, funzel) | post comment

What is SnipSnap?
SnipSnap is a free and easy to install weblog and wiki tool written in Java.

SnipSnap download
Current version: 1.0b3-uttoxeter
Try our >>Web Start Demo!

Resources

5567 Users and 13713 Snips. Installed 6 years and 41 days ago

Logged in Users: (2)
… and 20 Guests.

snipsnap-changed for older changes.

< August 2008 >
SunMonTueWedThuFriSat
12
3456789
10111213141516
17181920212223
24252627282930
31

snipsnap
Listed on BlogShares
XHTML 1.0 validated
CSS validated
RSS 2.0 validated
RSS Feed

pico-powered

Powered by SnipSnap 1.0b3-uttoxeter
YourKit >>Java Profiler

Fraunhofer FIRST

snipsnap.org | Copyright 2000-2006 Fraunhofer FIRST