webwork-devel

[Webwork-devel] Suggestion

[Francois B. <fbe...@py...>]

Since I have not been directly involved in the development of WebWork, I may
not be entitiled for the following suggestion but I will make it anyway.

It has been identified that there is some room for improvement in WebWork's
documentation. Lately, there has been some new features introduced which is
very good but documentation ...

To prevent the situation related to documentation to worsen, I suggest the
following rule :
No feature can be commited in the cvs repository unless it has been
documented.

Cheers,
___________________________
François Beauregard, b.ing.
Vice-président
Recherche et développement
Pyxis Technologies
www.pyxis-tech.com

T : (450) 681-9094, poste 102
F : (450) 681-5758
fbe...@py...

Re: [Webwork-devel] Suggestion

[Matt B. <ma...@sm...>]

Well, I would say that you shouldn't release until documentation is brought
up to date. The current CVS will have work-in-progress code that may not be
documented until released. But, hopefully moving docs to HTML will allow
easier input.

-Matt

----- Original Message -----
From: "Francois Beauregard" <fbe...@py...>
To: <web...@li...>
Sent: Tuesday, July 16, 2002 7:53 PM
Subject: [Webwork-devel] Suggestion


> Since I have not been directly involved in the development of WebWork, I
may
> not be entitiled for the following suggestion but I will make it anyway.
>
> It has been identified that there is some room for improvement in
WebWork's
> documentation. Lately, there has been some new features introduced which
is
> very good but documentation ...
>
> To prevent the situation related to documentation to worsen, I suggest the
> following rule :
> No feature can be commited in the cvs repository unless it has been
> documented.
>
> Cheers,
> ___________________________
> François Beauregard, b.ing.
> Vice-président
> Recherche et développement
> Pyxis Technologies
> www.pyxis-tech.com
>
> T : (450) 681-9094, poste 102
> F : (450) 681-5758
> fbe...@py...
>
>

Re: [Webwork-devel] Suggestion

[Rickard <ri...@dr...>]

Matt Baldree wrote:
> Well, I would say that you shouldn't release until documentation is bro=
ught
> up to date. The current CVS will have work-in-progress code that may no=
t be
> documented until released. But, hopefully moving docs to HTML will allo=
w
> easier input.

I agree. Francois' suggestion is not good, since we need to "try out"=20
features in CVS before saying that they stay. Features that have been=20
added have a tendency to change between initial import to CVS and a=20
release, which is good.

Document before release is all we need.

/Rickard

--=20
Rickard =D6berg

Suggestion: Test before release [Was: Re: [Webwork-devel] Suggestion]

[Philipp M. <me...@me...>]

On Wed, Jul 17, 2002 at 08:37:10AM +0200, Rickard wrote:
> Matt Baldree wrote:
> >Well, I would say that you shouldn't release until documentation is brou=
ght
> >up to date. The current CVS will have work-in-progress code that may not=
 be
> >documented until released. But, hopefully moving docs to HTML will allow
> >easier input.
>=20
> Document before release is all we need.

I want to add: unit test before release is what we need, too. At least
for the central parts of ww (actionstack, servlet dispatcher) and for
every new code.

-billy.

--=20
Meisterbohne       S=F6flinger Stra=DFe 100          Tel: +49-731-399 499-0
   eL=F6sungen       89077 Ulm                     Fax: +49-731-399 499-9