views:

1391

answers:

5

What's a good Wiki (or other browser based collaborative tool) for technical documentation? Both as a programmers reference and more general "How to perform this reoccurring tasks on a computer" documents.

I'm looking for Wikis with features specifically geared towards documenting system, framework and application development. I'm not general purpose Wikis.

Finally, yes, I know about Trac ;)

+3  A: 

We've used Dokuwiki for this purpose and are happy with it. It's a lightweight install, requiring no database.

Turnkey
+5  A: 

We heavily use twiki which can be enhanced with a ton of available plugins (like spreadsheet, drawings etc.) I don't know if it really fits your usecase, but it's IMO worth a try, as we have good experience with it.

André
+10  A: 

We are using MediaWiki for our developer documentation and how-tos. We are also using it to publish schedules, milestones, contact information, etc. MediaWiki has a number of extensions and is fairly easy to create content for. MediaWiki extensions we're using here include;

This is the same Wiki Mozilla originally went out with for their Mozilla Developer Center documentation. They have since moved on to the MindTouch Deki product.

TomC
MediaWiki always struck me as more a general purpose wiki that had to be hammered into shape for whatever purpose you want. Do the extensions you're using trump that? If so, what extensions are you using?
Alan Storm
Don't know if the extensions we are using necessarily trump that but they do add in some functionality that makes it just a little easier to create documentation. The general purpose nature seems to suit our needs. It's also important to get started correctly by setting the expectations for content.
TomC
I find it annoying that you have to use verbose <code></code> syntax and there isn't anything more compact, like backtick in markdown. Did you solve that problem? (none of the plugins listed seem to address that).
porneL
While not shorter, here we are using the SyntaxHighlight GeSHi extension for MediaWiki for the purpose of properly marking up various source code (XML, Java, Delphi, etc.) - http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi
TomC
+1  A: 

I was faced with a similar question myself not too long ago, and I settled on ScrewturnWiki. It was simple enough for our non-technical users to use, didn't require complex database setup - or, actually, any database setup (it "just works" which is nice).

The plugins/extensions that are available for it work well and are easy to install.

I use it for exactly the same reasons you mentioned: a programmers' reference and a more general "How to perform recurring tasks on the computer" reference.

Keithius
FYI, this is ASP.net
meme
+5  A: 

Check out what appears to be the rising star among wikis, MindTouch DekiWiki.

It's open source (although they do have commercial licenses and offerings). It is highly extensible, which is great for your technical desires - there are plugins to connect to issue trackers, source control, etc. -- or you can build your own.

We are using it for internal documentation and also client-facing docs. It has been great for us, so far.

pc1oad1etter