[Zope] Re: ZDP

Kent Polk kent@goathill.org
Tue, 9 Feb 1999 22:24:37 -0600 (CST)


> From: Amos Latteier <amos@aracnet.com>
 
> The are a couple reasons for this. We do not have a simple way to search
> the documentation. The documentation is not as clearly labeled as it could

IMO, bibliographic and full-text search capabilities really need to be
developed for Zope. All info sites really do need a search engine...
(don't ask me about implementing Marked Tree search results, Paul will
shoot out both of your feet)

> I think we need to move to a better classified documentation system, and
> provide a system of searching the documentation. We should probably also
> try to cull interesting information from the mailing list to beef up the
> support and how-to documentation.

When documentation is written, please consider that it may be desired
to use to show one's boss certain concepts. I don't mean to constrain
here, but remember that most bosses will be at Zope Zen level 0.1. The
more technical the info, the less need for limiting Zope-Speak.

I'm supposed to give a talk about using Zope here at work soon. I'm
almost clueless as to how to talk to clueless Zope users like myself.
Anyone else in this boat, willing to work together to try to write
something along these lines?
 
> I think that the Product API tutorial helps. 

Very useful!  Need More Input! Such as a folderish Product. Or a
Tabula-ish product. We want to implement Computed Attributes (or
whatever the heck they are called) for TinyTables. And remember
that the more descriptive comments there are in the Zope sources,
the fewer questions dummies like me will be asking...

> I look forward to a better documentation process that will help more people
> get the most out of Zope.

Please, please, please provide modification dates on your documents. This
is a VERY helpful feature when one is browsing oft-browsed sites. If no
mod-dates are available, one tends to either unnecessarily re-read old
documents and assume that what is new stuff has already been read. Also,
by providing a mod-date for documents, it can become very easy to create
a 'databased' What's New search where one can fill in the the What's New
in the Last n Days, etc. not to mention sortin by mod-date...

Thanks!
Kent