Re: PEAR's mission statement - let the fun begin

Hi, Yes, in my opinion a end-user documentation greatly increases accessibility, compared to a basic generated documentation. However, creating the xml source is not easy for everyone, a tool to fill doc skeletons would be surely appreciated (I might be able to contribute to such tool). And yes, I'm pro strict coding guidelines to ensure quality packages. I also believe we can't ensure top quality php5 packages that won't break BC. However, I'm aware that there is a big part of the userbase that still requires php4 compatibility. A solution that pleases everyone would be tough to find ;) Your summary of my thoughts pretty much cover my opinion, thanks! -E Joshua Eichorn a écrit :

Etienne Kneuss wrote:

Hi there, Nice initiative! So, some things that I can think of : 1) API doc modifications: complete removal or complete integration, the current implementation is IMO a mess. 2) End-User doc required to release a package as stable 3) PEAR_ in front of next major package's releases 4) Strict and concrete(documented) guidelines for error handling, E_STRICT issue, PHP5 only packages.

Ok so you have pretty good concrete ideas, any thoughts on the bigger picture. Your goals seem to focus on improving documentation, and making current documentation more available. And create strict well documented guidelines for PHP5 So if I was going to write up a mission statement from your thoughts it would be. Create a set of PHP5 packages following strict coding guidelines with a focus on high quality documentation. Followed by a section describing the basics of the coding guidelines and defining what high quality documentation is. thoughts -josh

-- Etienne Kneuss http://www.colder.ch/ colder@php.net