list4xt : Mailing list for the XT users community.

[list4xt] Volunteer : documentation

User: Website

New Message
• Reply
• Next message: Paul T: "[list4xt] Re: Volunteer : documentation"
• Previous message: Eric van der Vlist: "[list4xt] Re: TODO"
• Next in thread: Karen Lease: "[list4xt] Volunteer : documentation"
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

All,

I've spent the last 8 months burrowing through the internals of XT,
so I'd be happy to help with the documentation effort. A few
thoughts come to mind:

1) This effort can be easily partitioned, as Java packages, so we
    can enlist the aid of other enlightened individuals.

2) The primary internal documentation should be JavaDoc.

3) Secondary documentation should include an overview of the system
    architecture, primary design patterns, etc. (the stuff that won't
    change much as we evolve XT).

On a separate topic, the bug tracking system ought to also track
enhancement requests.

-Ron

--
Mailing list for the XT users community.     (http://freelinkbuildingtools.com)
(mailto:list4xt-request@4xt.org?Subject=unsubscribe to unsubscribe)

• Next message: Paul T: "[list4xt] Re: Volunteer : documentation"
• Previous message: Eric van der Vlist: "[list4xt] Re: TODO"
• Next in thread: Karen Lease: "[list4xt] Volunteer : documentation"
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]