Form Of Documentation In Addition to JavaDoc

[jlpoolen]

JavaDoc is great, but for a project with several hundreds of classes, it's only helpful when you're ready to dive into the code. Something more is needed.

For the uninitiated, there needs to be documentation that familiarizes the reader with the concepts and approaches taken in the project. In addition, there are a lot of mathematical terms which need explaining and possibly have some diagrams to drive home their meaning.

I've been using the open source KeepNote, http://keepnote.org/, because it allows you to pop in screen shots and images into a notebook. The notebooks can be exported into HTML; however, that is not really a good working solution for a collaborative project.

It looks like the wiki approach would be best, but chime in if you have other suggestions.