Quantcast
Channel: Code:Q
Viewing all articles
Browse latest Browse all 50

Merging JavaDoc and wikis

$
0
0


I have for the last few years been in projects where much of the documentation was written in the form of wikis. I rather like writing documentation, but many others don't. Oddly enough, when a wiki is installed many developers who hate writing docs suddenly empty their minds in earnest through wiki-markup.

An unfortunate problem is that, however good wikis are, they aren't attached to the source in a natural way. So, I'd like the next version of JavaDoc to include wiki pages for classes, packages and applications.

Contrary to common belief, wikis don't need a server! The history behind it all isn't all clear to me, but Jeremy Ruston created TiddlyWiki, which is a wiki implemented as an HTML file, with some clever CSS and JavaScript behind. The wiki text is saved through JavaScript in the HTML page itself. This makes it ideal for inclusion into JavaDoc. No server is needed, just a web browser. I prefer a version of TiddlyWiki called GTD TiddlyWiki, mostly bacause I like its layout. But there are tons and tons of variations to the original project.

All this could, of course, be added to the IDE, but I'd like us all to have a portable solution, that can be moved from one IDE to another, without problems. Therefore I'd like a JSR to be created and submitted to the JCP. I can't do it myself, so perhaps someone else could pick up this banner and run?


Viewing all articles
Browse latest Browse all 50

Trending Articles