reST, mechamisms? (was Re: [Zope3-dev] Z3 documentation)

Marcus J. Ertl marcus.ertl@larp-welt.de
Thu, 03 Apr 2003 09:10:17 +0200


On Wed, 2 Apr 2003 15:44:49 -0500, Stephan Richter wrote:

Hi!

>I disagree. I have written successfully docs in Wikis which do not suffer that 
>shortcoming. In fact, if links are used wisely, they can have a positive 
>effect, since they lead you into deeper discussions.

I'm no Zope develeper, so it may be wrong for me to take word in this
place. But in my opinion Wikis are great for diskussions, but not for
documentation.

What I need, for my daily(?) work with Zope3 is a more straight foward
documentation:

- Clear and complete API-References
- Clear and straight forward Howto's

At the moment, there is a real lag of such documentation. Many thinks
in documentation tell me how something works, but not how to use it!
:-(

And it would be usefull to know wich parts of documentation refer to
realy working fuctionality, and witch is still Science Fiction.

In my opinion, you shouldn't stop someone, how wants to do
documantation, but should help him as much as possible. There can't be
such thing as "to much documantation".

Bye
   Marcus
-- 
 Das LARP-Portal im Internet:
LARP-Welt: http://larp-welt.de

!fantasy