[ZDP] DC's Zope Documentation Plan

[Tom Deprez]

Ha, Great!

New Office? Woow, when thus Zope goes to WallStreet? Let me know!

So what does this have to do with the ZDP? As the folks who have the best
sense of what needs to be done to improve Zope documentation, I'd like you
to review our goals and tell us if we're off base or not. 

Nice, that DC wants to work with ZDP! Thanx.

What are we missing? 

I think there should also be a sort of guideline documentation, which gives
some guidelines on chosing how to develep a certain project. eg. for this
sort of projects you can better use ZODB then SQL; You can go 2 ways, use a
Python method or DTML,... but in this case you better use, because...; etc.
Telling the Pro& Cons of a certain implementation...

Also a doc which shows the differences on how to handle things, eg you can
achieve this through a python method (with code as example) or you stay in
DTML (with code as example)

>Do we describe documentation needs correctly for different constituencies? 

I think so.

>Do we accurately describe the ZDP's role in the documentation process? 

I think so. What ZDP is a this moment trying to do is to create some tools
which will ease the generation of documentation (so that people who
normally don't contribute, now do) and trying to find a way on how to
present it to the people in an easy , overviewable, searchable way. Having
lot's of information is great, but if you can't find the things you need,
then you're nothing with the information.

At a later stage ZDP wants to be the central place of all kind of sorts of
Zope documentation... ZDP must stand for THE place when you need
information on Zope. (A direct URL from Zope to ZDP? So that every person
who doesn't find the right information on site, can go directly searching
ZDP) Thus then we need to get as much as documentation (Is this taken to
high?). 

>Are the projects we're working on the right ones?

Yup, this are the first ones which need to be extended/updated.

Tom.



>Hello,
>
>As some of you may have heard, DC is opening up a Portland, OR office.
>We've decided to take this opportunity to start taking Zope
>documentation more seriously. The Portland office (that's me, Michel
>Pelletier, and Karl Anderson) have been charged with the mandate of
>improving Zope documentation. To this end, I've prepared a short plan
>which summarizes what our goals are and some of the projects that we're
>working on to achieve those goals.
>
>  http://www.zope.org/Members/Amos/Documentation/Plan
>
>So what does this have to do with the ZDP? As the folks who have the
>best sense of what needs to be done to improve Zope documentation, I'd
>like you to review our goals and tell us if we're off base or not. What
>are we missing? Do we describe documentation needs correctly for
>different constituencies? Do we accurately describe the ZDP's role in
>the documentation process? Are the projects we're working on the right
>ones?
>
>After I collect your feedback I'll revise the document and then I'd like
>to make it public in the next couple of days.
>
>Thanks so much for all your help!
>
>-Amos
>
>--
>Amos Latteier         mailto:amos@digicool.com
>Digital Creations     http://www.digicool.com
>
>_______________________________________________
>ZDP maillist  -  ZDP@zope.org
>http://lists.zope.org/mailman/listinfo/zdp
>
>