Re: New approach - summary

On Wed, 04 Jun 2003 12:56:33 -0700, Andy McKay <andy@...> wrote:

>> The final thing we agreed on via IRC was that we need to *enforce* 
>> documentation. By moving it to CVS, you have no excuse of not updating 
>> the relevant documentation when you do something.
>
> Unfortunately there is, its in another project and "oh do I really have
> to go over there, its just a quick fix". Personally I think this is just
> as easy to ignore as opening a browser to Plone.org ;)

Not when your laptop is a 933MHz Transmeta (~5-600MHz P-III) and you are 
running Mozilla it isn't ;)

And for some reason I always have something fishy with ExternalEditor. And 
Textfields Suck®.

> **********
> The only way this will work is if the core contributor's (and Limi is on
> board with this), who do most of the work are on board. Followed by a
> few of us are willing to hound people to death until documentation is
> done for a feature added or even (shock horror) remove that feature. 
> **********

Amen.

> I hate contributing to Zope because one key feature I had (moving
> ZSQLMethod caching to CacheManagers) would involve about 30 lines of
> code. Changing two chapters in the book. Changing online help. Writing
> unit tests. Explaining it to everyone. So I know about keeping barriers
> low. But they can't be too low, otherwise we documentation will never
> improve.

We should have one, and only one place to add/rewrite docs. That's the 
whole point of this exercise. :)

> If documentation is important to us and the project, and I think it is,
> then we all have to get on board.

And anyone who doesn't agree, post your SF userid, and I will instantly 
vaporize your commit privileges ;)

> Meanwhile we can play catch up documenting the existing stuff and CMF,
> Zope, Python and the world as we know it.

Ain't life grand. :]

Rock on, Andy.

-- Alexander Limi

-------------------------------------------------------
This SF.net email is sponsored by:  Etnus, makers of TotalView, The best
thread debugger on the planet. Designed with thread debugging features
you've never dreamed of, try TotalView 6 free at www.etnus.com.