[Zope] Zope reference documentation?

Milos Prudek milos.prudek@tiscali.cz
Wed, 15 Jan 2003 22:43:35 +0100


> The Zope Book has a reasonable API references for ZPT, DTML/TAL (Appendix
> A-C).

No Andreas, it does not have that. It has an API reference, but not a 
comprehensive or reasonable one. Some core functions are simply 
undocumented. Maybe 10%, maybe less, but they have been undocumented for 
more than a year, maybe even two years!

And there are almost no examples. IMHO every function should have an 
example. Even the simplest function.  A definition is good, but examples 
are preferred by many. And don't get me started that examples do not 
belong to reference text. Make them optional, so that they can be turned 
off by people who dislike examples.

Patrick Price sees this deficiency clearly, since he's a newcomer. Zope 
stalwarts are blind to these issues.

I've been using Zope for four years now, and although documentation 
improved a lot since 1998, it is still the same relative distance from 
Zope abilities. And Patrick is either right that this is a funding 
issue, or <sinister=on>Zope Corp. ridiculously high consulting fees 
depend on the documentation deficiencies.</sinister=off>

Patrick needs to download archives of this conference since 2000 and use 
them as a very valuable resource. He also must go to http://www.zope.org 
for some issues, and quite often he will need to study Zope source code. 
That is not a normal situation. That is Zope in 2003, and it should change.

-- 
Milos Prudek