WikiMatrix

#1 2007-03-04 21:09:11

dunxd
Member
Registered: 2007-03-04
Posts: 2

New Feature - Documentation Quality

The quality of documentation is something that I am sure many people would like to compare on.  A poorly documented wiki system wastes peoples time, and doesn't provide a stepping stone to learning more.  Some great wikis have terrible documentation.

Great documentation takes newbies through the whole installation process including installing web server and database.  Takes a howto achieve task approach.  Keeps the learning curve shallow.

Good documentation points to sources of information that the documentor hasn't got time to write specifically.  Learning curve might be steep, but isn't unmanageable.

Terrible documentation assumes the reader wrote the wiki system and just needs reminding what they called the functions.  The learning curve is a brick wall on which the documentor is sat on top, laughing at the poor fools who dare to think they can master their system.

Offline

 

#2 2007-03-05 13:24:01

dartar
Member
From: London, UK
Registered: 2005-11-29
Posts: 64
Website

Re: New Feature - Documentation Quality

dunxd, interesting suggestion, but I assume this feature is very hard to implement at WikiMatrix (unless some spam-free polling system is added). How do you translate "good documentation" into something measurable?


DarTar
Wikka Development Team
WikkaWiki @ wikimatrix
wikkawiki.org

Offline

 

You are not logged in.


Board footer

Forum powered by PunBB (© 2002–2005 Rickard Andersson)