Re: PEAR Documentation

On Fri, Apr 26, 2002 at 09:27:30AM -0400, Sean Coates wrote: > Regarding PHP Evangelism, I think there's a LOT of work to be done with > PEAR, especially concerning documentation. (yes, I know there are PEAR > lists, but this directly relates to evangelism). > > and coding standards. (link: > > http://www.sitepointforums.com/showthread.php?s=&threadid=50331). > Here's an > excerpt that really got my attention: Ok, to be honest, the PHP.net site is more referential than useful. I think we should write some documentation (white papers, tutorials, etc) about how thing can be done in PHP or with PEAR classes/packages. I'm thinking about how to program a webservive in PHP, using SOAP and XML. Using PEAR DB, caching, logging, etc. > -- > (1 -Skunk) > PEAR is developing into a superb resource and it's a great shame more PHP > coders aren't aware of it - this is mainly thanks to the PEAR site being > pretty rubbish (there's lots of information on PEAR but very little of it > is available to the public via pear.php.net) > (2 -Skunk (again)) Martin, stig and James are already convincing pear developers to write at least docbook/phpdoc referential documentation. But developers can't write user manuals. That's a fact, just like a programmer can't test his own code.. > PEAR's greatest weakness in my opinion is pear.php.net - the documentation > there is fine but it is very limited and gives a bad representation of what > PEAR is. The fact that Renegade is hung up on the coding standard is a > direct result of the PEAR website not being clear enough - instead of the > coding standard being hidden away in an apendix somewhere where only PEAR > developers will read it it is sat on the main website giving off the > impression that it is the most important thing about PEAR. I believe the pear website is currently maintained by 4 developers, who do web developent as documentation. I agree with the fact PHP needs more 'user' documentation. But who is willing to write it? The mailing lists are mainly used by active pear and php (the c-code) programmers. PHP web developers aren't really using the mailinglists or maybe some the php-general list. -- With best regards, Dave Mertens, Development Manager dmertens@ism.nl Innovative Solutions in Media BV Schiekade 101 3033 BG Rotterdam, Netherlands Tel. +31-10-2436060 Fax. +31-10-2436066