list4xt : Mailing list for the XT users community.

[list4xt] Re: Volunteer : documentation

User: Website

New Message
• Reply
• Next message: Eric van der Vlist: "[list4xt] Re: Volunteer : documentation"
• Previous message: Ron Ten-Hove: "[list4xt] Volunteer : documentation"
• Next in thread: Eric van der Vlist: "[list4xt] Re: Volunteer : documentation"
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

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

# Agree. The packages are not messy, re-engeneering on per-package basics makes sense to me.

2) The primary internal documentation should be JavaDoc.

# Not sure. I think that the first thing needed could be a 'view from top' ( package meaning, purpose, 'entry point' e t.c. could help alot ). Of course this is a subset of JavaDoc, but ... I don't know ... JavaDoc rarely provides the 'view from top' ... I found JavaDoc to be good for describing detailes of the package .... I may be wrong...

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).

# Hm... To me this is first, but javadoc is secondary ;-)

Rgds.Paul.

# PS. Ah - this will be great to get some examples... After I'l look at one example - I may try writing down some things ....

Eric's

"It would fit in the documentation I have begun to write about SAX and XT
(/docs/000421-0001.xml

Was realy very hepful. If some day we get some ( outline, 'sample' ) document from you regarding XT internals - that could be realy great, I think.

Just 2c.

---------------------------------
Do You Yahoo!?
Send instant messages & get email alerts with Yahoo! Messenger.

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

• Next message: Eric van der Vlist: "[list4xt] Re: Volunteer : documentation"
• Previous message: Ron Ten-Hove: "[list4xt] Volunteer : documentation"
• Next in thread: Eric van der Vlist: "[list4xt] Re: Volunteer : documentation"
• Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]