Thoughts on wiki based documentation

  1. Low barrier to documentation reduces risk of obsolescence
  2. Cross referencing links improves usability and reduces duplication (i.e. inline wiki content is superior to attachments)
  3. Effective search and lightweight tagging works better than elaborate structure
  4. Audit trail and ability to rollback via version history reduces the need for elaborate access control
  5. A good way to keep documentation up to date is to make it easy to update it in small chunks while at work. (e.g. being able to email additions to a page)
  6. Content subscriptions and notifications are effective ways of keeping interested parties informed.
  7. Regular cleanup helps to keep it from turning into a hairball.

4 comments:

Ash said...

I have been an avid user of Wiki. However, I think that Wiki based documentation fall way short on printing. Though I am not much for printing unnecessary hard copies, however, nothing beats old fashioned paper when you are taking a train ride home.

Aroj said...

I found dokuwiki a really nice and simple to use wiki engine, especially for documentation... and unlike mediawiki, this does not use a mysql db but stores data in text files....

Chris said...

We have just started doing this at work using the the wiki that comes as part of SharePoint. The issue is that in some cases people really want word docs or PDFs. The best solution I think is a way to structure the content in the wiki and at some point extract it to document form

CHOI, Jae-Hoon said...

We are using a wiki based management for more than 6 months. It has reduced the communication loads.

Post a Comment