[Home]  [List]  [News]  [Docs]  [FAQ]  [Downloads]  [Resources]  [About]
Search :
/Home /List

list4xt : Mailing list for the XT users community.

[list4xt] Re: Volunteer : documentation

Subject: [list4xt] Re: Volunteer : documentation

User: Website

From: Ron Ten-Hove (rtenhove@forte.com)
Date: 02/06/2000 - 00:18

Paul,

Perhaps my use of the terms "primary" and "secondary" imply too much.
I meant that the largest effort would be to provide the detailed
implementation documentation that is sorely lacking in XT.

I would submit that the goal of the detailed documentation would be
to enhance understandability and thus maintainability.

My proposal to use JavaDoc for the detailed docs is motivated partly
by pragmatism, partly by force of habit, and partly company loyalty
(my company is owned by Sun Microsystems, after all). Have you
some other tool or document system in mind?

I agree that examples make such discussions more concrete. Let me
work on that...

-Ron

-----Original Message-----
From: list4xt-bounce@4xt.org [mailto:list4xt-bounce@4xt.org]On Behalf Of
Paul T
Sent: June 1, 2000 14:25
To: list4xt@4xt.org
Subject: [list4xt] Re: Volunteer : documentation

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://rvffcu.org)
(mailto:list4xt-request@4xt.org?Subject=unsubscribe to unsubscribe)

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

Archive générée par hypermail 2b28 le 06/11/2001 - 11:46 CET

webmaster@4xt.org