views:

318

answers:

9

I'm looking for some system to create documentation for my software. I'd like something with as many as possible of the following properties:

  • I can install it on my own server
  • Wiki-style editing
  • I can create an export (PDF/Word doc/CHM/web site archive/sth. else) by just clicking a button or similar.
  • Cheap/free

Is there such system out there? I've seen this question, but it is focused on turning doc-comment into documentation files, whereas what I'm looking for is more of a free-text system for higher level documentation.

A: 

Take a look at TddlyWiki http://www.tiddlywiki.com/

Here is a YouTube tutorial http://www.youtube.com/watch?v=ezNScBd7_h4

srini.venigalla
Very great tool, but no exporting capabilities.. and can only marginally be "installed" on your own server. It depends on if he wants write access from his server.
Earlz
A: 

As a roll-your-own solution, I propose that you:

  1. Install your own copy of MediaWiki (software behind Wikipedia)
  2. Use a tool like WikiType to convert the articles you write into PDF's
Dolph
A: 

Trac is free and has a "wiki" function that also allows you to link to files in a SVN/CVS repository that it manages (or is aware of). I think there are some plug-ins that allow for easy export as well but I wouldn't bet on this.

Romain
A: 

Why not use MediaWiki?

VirtuosiMedia
+2  A: 

How about MindTouch Core?

It's built on top of MediaWiki, and tries to take advantage of the good parts of that platform, but also provides a solid RESTful API if you need to get fancy.

It has a rich-text editor if you want to use it, has built in export to PDF (but not the other formats you asked about, which is a negative, though you could extend it...), and is completely free.

It also runs as a ready-to-go VMware image, so you can download that, and run it in VMware player/server within your server...

Noah Heldman
+3  A: 

For a Wiki, I like Dokuwiki the best. It fulfills all your criteria, is simple, nice, and very easily extendable. It requires a bit of manual work until everything works well and smoothly, but it's worth it. It can export ODT and PDF.

I asked a similar question - about good documentation tools in general - a while back and got very good results. There is a number of suggestions not based on Wikis that may nevertheless be worth a look.

Then I remember these:

Pekka
Thanks, it looks very promising.
erikkallen
A: 

I like PmWiki, requires no database, uses PHP, and there is a Cookbook that exports to PDF.

Wayne In Maine
This might be just what I was looking for.We are using PmWiki and export to PDF was also something that we needed. Thanks.
Patrick
A: 

Confluence should satisfy all your requirements. You can have hosted or in-house version (for only 10$).

Major companies use it. Those include JetBrains, VMWare, Sun etc.

I personally, as a visitor of the sites based on confluence, am vary happy with the experience.

Dmytrii Nagirniak
A: 

Maybe the MediaWiki is the best choice if what you need is a well-formed WikiStyle page.

Couto