I guess, I don't want to extend this thread to much and make other people bored to death but my take on documentation is a little different. You can NOT expect newcomers to start writing a lot of documentation without knowing well a fairly large framework like Avalon, this approach will add even more to the existing confusion around this project. Those that want to research code themselves will be OK for their projects and probably would not be able to put even more time into making it easier for others. You see, when you work for your employer, you usually start with at least some form of design document that can be, consequently, converted into documentation. Nature of most open-source projects do not support this development model since majority of participants come from a "hacker mentality" crowd. ...so, probably we will not find any immediate solution, unless one wants to write a book (see Struts project as an example).
Well, Aaron is an exception to this rule. He seems to be dedicated to making things better (hmm, I still haven't heard from him regarding putting pp doc on the Avalon's site). Thanks to all other participants in this thread for good suggestions. I will try to move on with some improvements and also create smaller presentations dedicated to different Avalon products. They should include solid examples on top of architectural details (...with Aaron's help). Thanks, Pawel From: "Niclas Hedhman" <[EMAIL PROTECTED]> on 03/02/2004 01:01 AM ZE8 Please respond to "Avalon framework users" <[EMAIL PROTECTED]> To: "Avalon framework users" <[EMAIL PROTECTED]> cc: Subject: Re: PowerPoint presentation On Tuesday 02 March 2004 00:20, Pawel X Karendys wrote: > Possibly, people still miss the fact that in order for Avalon > framework to be successful it has to be well documented. I guess, I > shouldn't start another nasty thread on code vs. document & code topic. Not to diminish Aaron's hard work in the documentation field, we all committers are "guilty" of "too much code, and too little docs", and docs are a somewhat low quality as well. How can this be overcome? That's the million dollar question for our community. Simply put, we are inviting anyone with documentation interest to help out in this area. Anything from filling in a line or two on the Wiki, to patches of the official documentation and to full-scale re-writes of the official documentation are most welcome and treated with outmost respect. Cheers Niclas -- +---------//-------------------+ | http://www.bali.ac | | http://niclas.hedhman.org | +------//----------------------+ --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] American Express made the following annotations on 03/02/2004 10:21:03 AM ------------------------------------------------------------------------------ ****************************************************************************** "This message and any attachments are solely for the intended recipient and may contain confidential or privileged information. If you are not the intended recipient, any disclosure, copying, use, or distribution of the information included in this message and any attachments is prohibited. If you have received this communication in error, please notify us by reply e-mail and immediately and permanently delete this message and any attachments. Thank you." ****************************************************************************** ==============================================================================
