Hello Zope Community, Digital Creations is dedicated to provide up to date documentation. I have accepted the technical writer position to provide a focal point for all documents. We are commited to producing quality document and have established a plan to deliver. As part of our new documentation process, we will not release a new version until it is reasonably documented. The technical writer will publish the documents on the http://www.zope.org site. Along with new releases, bundled text files (changes.txt, install.txt & readme.txt) will provide necessary information about the individual projects. All DC documents will be available as Guides and HowTo's. The Guides and HowTo's will be available on the new Zope site and it promises to be exciting. In the works is the Zope Developer's Guide (ZDG) and the Zope Administration Guide (ZAG). The developer's guide will contain information targeted towards the developers. The administration guide will provide tidbits helpful for the content managers. Please feel free to submit suggestions for documentation efforts, they should be posted to Collector. Thanks and hello! -- Pam Crosby mailto:pam@digicool.com Technical Writer http://www.zope.org Digital Creations
On Wed, 30 Jun 1999 12:16:41 -0400, Pam Crosby <pam@digicool.com> said: Pam> Please feel free to submit suggestions for documentation efforts, Pam> they should be posted to Collector. Thanks and hello! Welcome aboard! I don't think this is specific enough to report to Collector, so I'll just generalize here. When I was learning Zope (and still am) I found the documentation was actually quite good. Many thanks to Amos, ZDP folks, whoever else has been writing this stuff. What kind of bogged me down was the sheer number of tiny documents. I have the DTML Users Guide spiral bound, and about a dozen stapled faqs, articles, emails, etc all stuffed inside the cover of that. When I'm trying to remember something it makes it really hard to know where to look for that one code snippet. It would probably be helpful for folks to have a hefty Zope "book" with a unified index that is downloadable in postscript or pdf format, as well as html. Or better yet, each installation Zope could use xml-rpc to automagically download the latest revisions of the html format docs from the nearest Zope docs mirror. :-) Alex Rice | alrice@swcp.com | http://www.swcp.com/~alrice Current Location: N. Rio Grande Bioregion, Southwestern USA
On Wed, 30 Jun 1999, Pam Crosby wrote:
Hello Zope Community,
Digital Creations is dedicated to provide up to date documentation. I have accepted the technical writer position to provide a focal point for all documents. We are commited to producing quality document and have established a plan to deliver. As part of our new documentation process, we will not release a new version until it is reasonably documented. The technical writer will publish the documents on the http://www.zope.org site. Along with new releases, bundled text files (changes.txt, install.txt & readme.txt) will provide necessary information about the individual projects.
All DC documents will be available as Guides and HowTo's. The Guides and HowTo's will be available on the new Zope site and it promises to be exciting. In the works is the Zope Developer's Guide (ZDG) and the Zope Administration Guide (ZAG). The developer's guide will contain information targeted towards the developers. The administration guide will provide tidbits helpful for the content managers.
Please feel free to submit suggestions for documentation efforts, they should be posted to Collector. Thanks and hello!
You guys should change the Zope Developers Guide to the Zope Integrator's Guide (ZIG). That way you could put it together with the Zope Administration Guide and have Zig-Zag! Oh boy, it hurts to be this lame... <sigh> --------------------------------------------------- - Scott Robertson Phone: 714.972.2299 - - CodeIt Computing Fax: 714.972.2399 - - http://codeit.com - ---------------------------------------------------
: All DC documents will be available as Guides and HowTo's. The Guides : and HowTo's will be available on the new Zope site and it promises to : be exciting. In the works is the Zope Developer's Guide (ZDG) and the : Zope Administration Guide (ZAG). The developer's guide will contain : information targeted towards the developers. The administration guide : will provide tidbits helpful for the content managers. Great, somebody is assigned for this task at DC. When I'm writing pieces for ZBook, I mostly have the idea (why am I doing this?), because it's very hard to get a notion that people read this stuff and actually like it or dislike it. Also, it has to be in spare time, so it takes some time before it gets shape. This is Pam's job, so I think it will get quicker now and also much better. Much better for DC and offcourse also for us! Finally somebody who has (should have) the time to create and document things about which we're already talking some months, but still haven't accomplished. However, I do hope, people still like our efforts at ZDP. But, I've one question, why post all things in the Collector? Why not make a seperate one especially for documentation? Or using the ZDP list? Regards, Tom.
participants (4)
-
Alex Rice -
Pam Crosby -
Scott Robertson -
Tom Deprez