Re: PEAR Descriptions/More documentation

Am Mon, 8 Oct 2001 17:12:20 -0400 schrieb Chuck Hagenbuch <chuck@horde.org>: > Quoting Markus Wolff <wolff@21st.de>: > > > Granted, but IMHO an API documentation is only good as a function > > reference. If you want to get started on using a new class, the best you > > can do is find a good tutorial and work it through step by step. > > No. That's the best that _you_ can do. I tend to learn at least as well from > API docs. Someone else will learn a different way. Lots of people prefer > tutorials like you do; lots more prefer API docs. Probably most would rather > have both. > > Try not to dismiss a form of documentation or whatever just because it's not > what _you_ want to work with. We need all of them equally, and we need all of > them to be equally good. Hi Chuck, I never said that there is no need for API documentation or that tutorials should be the only form of documentation. What I said is that I think a tutorial is better for getting started - and most people that I know think the same way. Of course, once you know how a certain class is working in general, good and up-to-date API docs are essential. You said it yourself - it´s probably best to have both. Unfortunately, for most PEAR classes, this is presently not the case. This is why I don´t understand that if someone stands up and offers to volunteer for more and better documentation, all the feedback he gets is something like "why more and better? There already is enough.". Yeah, for some people it may seem like that. But certainly not for everyone. CU Markus -- *21st Media* | Consulting, Konzeption, Produktion für die Bereiche: Markus Wolff | Internet, Intranet, eCommerce, Content Management, Hamburg,Germany | Softwareentwicklung, 3D-Animation, Videostreaming http://21st.de | Tel. [+49](0)40/6887949-0, Fax: [+49](0)40/6887949-1