Gang, Rickard and I met yesterday to discuss the future of Qi4j, and one of the critical points was around how can we improve the documentation of Qi4j in a organized and cohesive manner.
One issue was about engaging the rest of the community to help, and I raised the issue (think Rickard concurred) that the interactive SiteVision tool is a barrier for this to occur. SV also introduces a problem around "versioning", in that we would need to start pay attention to when features started, and potentially finished, its life. The conclusion was that we *should* pay much more attention to Javadocs, which solves both of these problems. So, I (hopefully with Rickard's help, Edward?) will make a big effort making sure that every package, class and public method have more or less comprehensive and cohesive javadoc, which will be published per version to the website, and when appropriate the Javadocs will be linked into other pages in SiteVision. I also hope that people will assist in documenting, in the same fashion, all the libraries and extensions as well. We think that this will both solve the authoring and versioning problems as well as retaining the nice looking website we already have. What does everyone else think? Cheers -- Niclas Hedhman, Software Developer http://www.qi4j.org - New Energy for Java I live here; http://tinyurl.com/3xugrbk I work here; http://tinyurl.com/24svnvk I relax here; http://tinyurl.com/2cgsug _______________________________________________ qi4j-dev mailing list [email protected] http://lists.ops4j.org/mailman/listinfo/qi4j-dev
