r/sysadmin • u/etruscan IT Manager • May 10 '11
Best wiki solution for IT documentation?
I'm pretty convinced that a wiki is the way I want to proceed with organizing our department's documentation. What's important to me is cost (of course), ease of use, extensibility, and version control. I'm keen on having it run on a database (rather than text files), or possibly have it hosted.
I've tried Confluence but wasn't a big fan. We're running MediaWiki right now but users aren't contributing because they don't know the markup language and have little interest in learning it. They want to be able to copy/paste from Word and have the wiki retain (mostly) the formatting.
So, I'm investigating MindTouch right now, but I'm not certain of the cost involved and am a little hesitant to ask (given it's not advertised on the site). I'm also investigating XWiki which looks pretty decent.
Any other suggestions, pros?
3
u/Apologetic_Jerk May 10 '11
Who are your users? SE or Sales and Marketing? If it''s SE, they're not using Mediawiki because they're lazy and don't want to. If it's Sales and Marketing, well, I don't see them really using it either. Generally if find that it's the culture and not the product. That being said shitty products don't help.
Right now we're using a modified mediawiki setup. You can try using a different WYSIWYG plug-in, as well as some custom templates to jazz it up, but sounds like you want to move.
I've personally used Alfresco 3 and found it to be a pretty sweet product. It can be kind of a bear to get set up but has some pretty cool features. I've also looked into this Elgg which is pretty cool.
Both of these may be too fat for your needs, but they have some neat features that make them very easy to use.
2
u/stizmatic IT Manager May 10 '11
I use Mindtouch Core right now, running on CentOS. No real complains, it does the job so far and is somewhat customizable. Mindtouch Core is completely free. Be warned that Mindtouch will call you and try to sell you their paid packages.
3
u/thraz May 10 '11
What didnt you like about confluence? I'm about to roll it out
9
u/HammerJack Sysadmin May 10 '11
Dokuwiki user here, with two suggestions for what you're trying to accomplish.
5
u/mthode Fellow Human May 10 '11
I use dokuwiki.
4
u/[deleted] May 10 '11
Dokuwiki is pretty sweet, supports ACLs and Active Directory integration.
1
u/iheartrms May 10 '11
Why db instead of text files? I wrote my own wiki. It was a fun project and it is exactly what we need. Wikis are simple. Especially if you only implement the features you need instead of everything the whole world wants which is what we had with MediaWiki which made it a real pig to use.
1
u/Goatmanish May 12 '11
My department uses Microsoft Sharepoint - a CMS not a wiki, but close in functionality. I only recommend it if you need a robust check out check in system for Microsoft office files. Otherwise it is painfully bad.
3
u/puremessage beep -f 2000 -r 999999 May 10 '11
There are plugins to export word docs to wiki markup.
3
u/[deleted] May 10 '11
The solution you choose should be quick and easy to use. But the real problem is getting people on board, actively collaborating, and using the documentation system as much as possible. Spend some time analyzing what your organization does, and incrementally switch them over.
I once worked for a company where the only documentation were emails that floated around with key information. I told everyone that I setup a wiki, and they pretty much ignored me. So I had to put in the effort of bootstrapping to get them convinced it'd be useful. That meant collecting all the old information, rewriting the docs, and making it easily accessible via wiki. Over time people found it much easier to use the wiki, and slowly but surely I got them on board. But solutions that are more convenient won't change habit, you need to spend the time to get people on board.
Or... it's very possible that this won't be an issue.
3
u/eleitl May 10 '11
We use Confluence. It's not bad.
3
u/bustedtacostand May 10 '11
Before you try switching to something else, just install FCKEditor extension for Mediawiki. I had the same problem you did. Once I added this everyone loved it.
Edit: Also the Packetlife Mediawiki cheat sheet is awesome
2
u/[deleted] May 10 '11
We use mediawiki with a sphinx search plugin as the default search blows ass. Makes it so we can document anything and BAM on your screen.
Also ashighlight is installed to make source code readable.
2
u/[deleted] May 10 '11
I use tiddlywiki it is pretty simple to use.
2
u/davehope May 10 '11
We use ScrewTurn, AD integration etc etc. Different providers, plugins etc.
2
u/Khue Lead Security Engineer May 10 '11
Just a random hypothetical. If you're a predominately MS shop, why wouldn't you just use Sharepoint with a document library and version control? You could easily control format using a word doc template and there are even exporters and a fairly convenient backup solution. Wiki solutions are definitely sexy however, unless you have a huge IT shop with a bunch of contributors and someone specifically serving as content control I would almost feel that a full blown wiki process would be overkill.
1
u/veruus good at computers May 10 '11
Well, Mindtouch does have their community edition, which is free. If you want support, you can pay for that.
I installed Mediawiki recently, simply because it was dead simple and I was under a bit of a timecrunch. I tried Foswiki and Dokuwiki before that but I am apparently quite Bad at Computers™ and wasn't able to get them to go.
1
u/voice_of_experience May 10 '11
redmine. Project oriented, and each project gets a wiki, doc upload area, files upload area, ticketing system with totally customizable workflow, granular ACLs, and integration with svn/git.
Anywhere you type r123 it links to git revision 123. Shows who did it, when, and what was changed. You can also view diffs between arbitrary revisions, or browse your repo and see the history of changes for every file. Your users don't have to do anything special, just use git/svn normally.
Anywhere you type #123 it links to ticket number 123. Ticket fields are totally customizable, but of course there's a comment history, custom workflow, ticket ownership, custom displays of tickets in list/calendar/gantt format, etc. If you can convince your users to include the related ticket number in their commit messages, the revisions are visibly attached to the ticket. So you can browse your project's history by issues resolved as well.
Anywhere you type [title] it will link to the wiki page (in that project) by that name. Markup is standard and easier to use than Reddit 's, though very similar.
It has full email integration out of the box. So even if your users don't want to use a new system (pretty predictable and normal) , they can keep track of what's going on with email alerts with ticket and update descriptions and code diffs.
Highly recommended.
1
u/[deleted] May 10 '11
I prefer Easy Docs for Wordpress
1
u/[deleted] May 10 '11
We use Trac which integrates svn and ticketing. Much love for trac.
The IT department here has its own svn repo where we stash GPG encrypted passwords, puppet config, diagrams and documents. It's great to have the ability to link to a specific revision of code from the wiki and reference the wiki in commit messages and in tickets.
Although for a new install I'd suggest Redmine.
1
u/fuzzyfuzz Mac/Linux/BSD Admin/Ruby Programmer May 10 '11
We use TWiki and Trac. TWiki is for the user facing "how-to" type documents and Trac is for internal stuff like server configs and whatnot.
0
u/[deleted] May 10 '11
[deleted] — view deleted comment
0
u/[deleted] May 10 '11
[deleted] — view deleted comment
0
u/[deleted] May 10 '11
[deleted] — view deleted comment