Ted Husted wrote:
> NEW BUSINESS
>
> Documentation and testing requirements
>
> As a starting point for documentation requirements, I would suggest the
> following:
>
> (0) substantial JavaDocs (of course),
of course... +1
> (1) a standard catalog entry, outlining the package's "high concept"
> (purpose and scope), prerequisites, release history, mailing list and
> archive links, FAQ and Bugzilla links, and active committers
> ("whoWeAre"),
Yep.
> (2) a developer's guide, that explains how to use the package in more
> detail, developer to developer,
+1 : required
> (3) a quick-start installation page for people who just want to plug it
> in,
+1 : required
> (4) obligatory quick-start FAQ,
sure, if needed.
> --
>
> As to the Web site documentation requirements, my first thoughts are
>
> (0) Mission statement
Can we call it 'charter'? I have too many bad feelings about the words
'mission statement'. Reminds me of #7 of the 10 Best Things to Say When
Caught Napping :
"I wasn't sleeping! I was meditating on the mission statement and
envisioning a new paradigm."
> (1) General guidelines (part (1) of recent poll)
>
> (2) Catalog (collection of (1) above)
>
> (3) Primer (package creation, use, and abuse)
>
> (4) Standards - naming hierarchy, testing requirements; sample directory
> layout, build file, documentation
+1 on requiring building with Ant.
> (5) Interactive FAQ (Jyve, if it can be fixed)
>
> (6) Omnibus index to mailing lists, archives, bugzilla, and master list
> of committers
>
> --
>
> As to testing requirements, the obvious starting points are Junit,
> J2EEUnit, and HttpUnit.
>
> < http://junit.org/ >
We use JUnit very effectively in Velocity to exercise the parser et al.
It's been a literal ${DEITY}-send.
> < http://j2eeunit.sourceforge.net/ >
>
> < http://sourceforge.net/projects/httpunit >
>
> To the extent possible, we should try an integrate testing with Ant.
> This could lead to a gump that not only builds code, but tests it as
> well.-)
>
> There's some initial background on this at
>
> <
> http://www.mail-archive.com/struts-dev%40jakarta.apache.org/msg00481.html
> >
>
> -Ted.
--
Geir Magnusson Jr. [EMAIL PROTECTED]
Developing for the web? See http://jakarta.apache.org/velocity/
