Wikis as Documentation Tools

Within the last week I implemented a Wiki as a documentation tool for our department. Right now I am the main one dumping content into it. I see it was being a central place for server config information, tips and tricks on various services we have running and even up to and includng contact information for various vendors. I have a fair amount of it documented already – just in a myriad of text files, word docs, spreadsheets and my mail client’s address book. This should allow us to have all of that in one place for others in the department to look at when needed.

For our case I was trying to decide between MoinMoin and MediaWiki. MoinMoin is Python based, while MediaWiki is your more typical LAMP (Linux, Apache MySQL and PHP) app. I was tempted to go the MoinMoin route as it does get good reviews and it would have been an excuse to get more familiar with Python. But… many of our open source apps currently in use are of the LAMP model. So in trying to keep things grouped together where the expertise is, I chose MediaWiki for our documentation Wiki.

Currently I try to update a little bit in the Wiki three times a week. I have also been using it as a scratch pad of sorts while troubleshooting various issues. Sometimes having those notes from troubleshooting prove quite worthwhile.

It will be interesting to see how well it works for us over time.

Advertisements

One Response to Wikis as Documentation Tools

  1. […] August 8, Friday, 12:00 — monado Jeffrey Tadlock at Cognitive Confusion has written about Wikis as documentation tools: as being a central place for server config information, tips and tricks on various services we […]

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: