[Zope-CMF] Re: Chicken and the Egg -- WAS -- Using CMF withou t portal like features

[Tim Hoffman]

I would be willing to put some time into helping document.
I have been using zope for about a year and CMF since 1.0. was beta 
(which I know ain't long)
and too lament the lack of basic API doc's.

I think for me a good starting place would be to document at least the 
public (and committed) API's
for all of the portal objects. Such as portal_type_registry, 
portal_workflow etc..
and at least define how they relate to each other.

Going off and having a look through the code is a bit of a drag, and 
half the time I don't know
what I am actually looking for. Also which bit's are comitted interfaces 
(ie aren't likely
to be significantly changed in the next dot release.

Rgds

Tim Hoffman




Tres Seaver wrote:

>On Tue, 31 Jul 2001, Boddy Stephen wrote:
>
>>Tres,
>>
>>I'm not attacking you Tres, but this is a perfect example of the problem.
>>These slides tell me (a grasshopper) what the CMF can do, without explaining
>>the techniques you (the Master) would use. Short of me spending the next
>>several months reading code, (particularly code written by someone else
>>who's a more experienced coder, and possibly :o) much smarter than me) then
>>it is highly unlikely that I, or someone like me, is going to be able to
>>create this documentation.
>>
>
>I'd just like to reiterate the tail end of my message:
>
>>>The outline implied by the slides is a likely start on a "CMF 
>>>Site Manager's Guide", I think.
>>>
>
>I think that fleshing out the "skeleton" indicated by those slides
>into a real manual is a desirable goal;  not only that, it is one I
>am likely to have resources for in the near term.
> 
>
>>Until someone with the knowledge and understanding takes on the onerous,
>>difficult and decidedly boring task of creating end-user documentation,
>>there will be a limited take up of CMF. This is not because of inherent
>>problems / shortcomings of CMF, but rather the large investment of time to
>>achieve professional, commercially acceptable results. At a time when time
>>is at a premium, it's difficult to justify the time needed to understand the
>>CMF, in order to make a judgment call as to whether it's viable, write
>>documentation, or adapt it to one's needs.
>>
>>In the long run I could see the documentation helping out. There seems to
>>lots of newbie style questions on this list, which to me should be more
>>about the development, bug-fixin' and improvement of CMF. A reduction in
>>this level of "noise" (Zope-CMF-[FAQ|Newbie]? Vote now!) would probably
>>justify a knowledgable persons time. I'm sure there'd be dozens of
>>beta-readers on this list alone.
>>
>
>I think that there *are* people on this list who *can* help create
>the required documentation;  I would be delighted to enlist as many
>as practical in the effort.
>
>Tres.
>