[Zope3-dev] documentation project at z3 sprint?

Jim Fulton jim@zope.com
Fri, 08 Nov 2002 13:32:38 -0500


holger krekel wrote:
> Jim Fulton wrote:
> 
>>kapil thangavelu wrote:
>>
>>>is there interest in such a project? with an alpha by the end of the year, 
>>>having some more narrative docs (as opposed to interfaces and unit tests), 
>>>would be a good thing. its not as sexy as coding, but its part of the 
>>>building the platform. 
>>>
>>I agree that more narrative docs are needed. I'll note that a number of
>>the responses you got were for tools to generate interface docs. :)
>>
> 
> And you disagree that they are needed and would be very helpful?

Given that we have lots of interfaces, automatic docs
provide relatively little value. It would be nice to have a document that
listed and catagorized all the interfaces, but I don't think such a thing
would be automatically generated.

Jim

-- 
Jim Fulton           mailto:jim@zope.com       Python Powered!
CTO                  (888) 344-4332            http://www.python.org
Zope Corporation     http://www.zope.com       http://www.zope.org