[Zope3-dev] Development methodology (Re: [Zope-CMF] Future CMF) (rant)

Chris Withers chrisw@nipltd.com
Thu, 10 Oct 2002 10:40:45 +0100


R. David Murray wrote:
>>That said, I'm not sure long and convoluted proposals (which I never have time
>>to read properly ;-) help either.
> 
> But they help more than not having them would. 

Yeah, but my perception is that the difference would be pretty marginal in many 
cases, but that might well just be me...

> discussion it is time to have (again).  Right now I like seeing the
> "official" documentation (ie: not the proposals, but docs about how
> things really work right now) in the cvs in stx format.

Fair enough. Perhaps ViewCVS would be a good enough way to make it accessible 
through the web?

> object to having an "official book" like the Zope Book, but I don't
> think we have enough of an information framework to *write* that
> book for Zope3 yet.

I think we could make a start...

> too squishy for that to me <grin>.  The other advantage of CVS is
> that one can check in changes to the docs when one checks in changes
> to the code, and thus the two are more likely (I think) to stay in
> sync.

I'm nto sure how many people would do this in practice ;-)

> You know, that brings up a question.  I'd *actually* like to move
> my meta configuration guide into the Zope/Configuration directory
> where it will be "right next to" the code it documents, leaving a
> pointer in the doc/zcml directory.  What do people think of that
> notion?

No offence, but I think this would really suck. The documentation really needs 
to be in one place, IMNSHO. If I can go to one folder, start with index.html, 
README.TXT or some such and work from there then I stand a chance as a newbie. 
If I have to rummage around in code folders just to find the documentation, I 
would be quite likely to give up and sink back into the pit of despair...

cheers,

Chris