I think it would be better for freenet if the documentation is improved 
before version 5.0.  When the version is put on slashdot and freshmeat, there 
will be a surge of interest, but that interest will probably die quickly if 
people don't know how to use freenet or where to find out how to use it.  
Installation instructions are somewhat smooth, but for website publishing it 
gets a little harder to find current documentation.  Because of the surge a 
5.0 release will bring, keeping the interest of those newcomers will be very 
helpful to freenet.  If would-be publishers leave because of the lack of 
documentation on freenet, readers would also leave because of the lack of 
content.  Maybe the website developers could grab newer documentation and 
link in from the main part of the website and purge the old links.

For the few 1337 h4x0r5 that want to get into the internals, I pity them.  I 
have recently tried to figure out the internals, and it's giving me a 
headache.  Documentation on the internals is just as important as 
documentation on the externals, because documentation on the internals of 
freenet helps developers learn and debug the code easier.

Tip for developers: when you're stuck on a bug, having trouble getting code 
to work the way you want it to, or don't know what to do next, take your mind 
off from it for a while by documenting your code.  It could even help you 
solve the problem.


Just my 2 cents,
Scott Young

P.S.  @see directives in javadoc are helpful for the people using the 
javadocs.

_______________________________________________
Devl mailing list
Devl at freenetproject.org
http://lists.freenetproject.org/mailman/listinfo/devl

Reply via email to