Mailing-List: contact geronimo-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: geronimo-dev@incubator.apache.org
Date: Wed, 13 Aug 2003 16:48:50 +0100
Subject: Re: documentation
Content-Type: text/plain; delsp=yes; charset=US-ASCII; format=flowed
Mime-Version: 1.0 (Apple Message framework v552)
From: James Strachan <james_strachan@yahoo.co.uk>
To: geronimo-dev@incubator.apache.org
Content-Transfer-Encoding: 7bit
In-Reply-To: <EC614DF367A4EF499E33886E0FF028822F25@agilmail.vtic.com>
Message-Id: <A2354794-CDA5-11D7-A504-000A959D0312@yahoo.co.uk>


On Wednesday, August 13, 2003, at 04:11  pm, Nanduri, Amarnath wrote:

> Hi James,
>
>      I think there should be at least a group of developers that deal
> exclusively with the documentation.

Sure. Anyone who turns up and contributes would belong to this group of  
developers.

>          Also if any person is interested in knowing the internals,  
> they
> should have the necessary documentation with UML diagrams in place and
> how everything fits together. I suggest that every group specified in
> this link
> http://nagoya.apache.org/wiki/apachewiki.cgi?ApacheJ2EE/Volunteers- 
> _Topi
> cs take care of the necessary design documentation (of the source code
> along with UML diagrams) on the stuff they are working on. This will  
> let
> any new person joining the group (to contribute) get a head start on  
> the
> design and implementation. This way they will be more productive and
> also be encouraged, by having fewer hurdles to cross...

I'd be more than happy if someone found an open source tool to  
auto-generate nice UML diagrams and whatnot as part of the build  
process so that they never became stale.. Or if someone fancies doing  
it by hand now and again with some tool thats cool too.

Its a personal thing but FWIW I find the best way to learn new software  
is to browse the javadoc and look at the JUnit tests - then you see  
blocks of example code, which works, using the code.

James
-------
http://radio.weblogs.com/0112098/