[Zope-dev] Documentation

Martijn Pieters mj@antraciet.nl
Fri, 24 Sep 1999 15:13:16 +0200


At 05:48 24/09/99 , Dody Gunawinata wrote:

>Let's us not forget that Zope is an open source product now. Having DC
>doing most of the development of Zope sometimes
>can make us forget that Open Source means a community collaboration.
>That would include the documentation. It is clear
>that the documentation currently lacks especially for beginners. But
>that's not the fault of DC itself, because creating
>documentation, especially for beginners can be a lot harder (and time
>consuming because we have to assume that they know nothing), and DC
>should spend time better on documenting and explaining the
>latest/coolest features instead.
>
>So it's up to us, the community, to create the 'book'. We do need a
>'book' with decent chapters. Lots of how-to is nice if you are already
>know what you are doing, but the information is fragmented, and it's no
>use for beginners.
>
>So, it's another project proposal..let's write a book on Zope.
>Individual(s) can work on chapters after having agreed of the general
>structures. We'll cover the basic from DTML, with working
>projects/products example in the end, to Python programming, and up to
>the
>higher end. It's not an easy task as the transition from one chapter to
>another needs to be carefully defined, as if it is not, they would be
>difficult for new comer to use. An open source book. For the quality,
>the 'book' should be good enough to be sold commercially in
>bounded/printed form. A definitive guide to Zope. As this is electronic,
>there is no limitation on how 'thick' the book can be. We can use tons
>and tons of example in the 'book'.
>
>Another requirement, they should use less the word 'namespaces' :0)..I
>hate the word because I've seen loads of them in the current document
>(and in Python tutorial as well)

Please join the ZDP! The Zope Documentation Project has been founded just 
for this purpose, see the site at:

     http://zdp.zope.org/

--
Martijn Pieters, Web Developer
| Antraciet http://www.antraciet.nl
| Tel: +31-35-7502100 Fax: +31-35-7502111
| mailto:mj@antraciet.nl http://www.antraciet.nl/~mj
| PGP: http://wwwkeys.nl.pgp.net:11371/pks/lookup?op=get&search=0xA8A32149
------------------------------------------