Re: Requirements for Documentation System

From: Date: Mon, 12 Apr 2004 21:43:41 +0000
Subject: Re: Requirements for Documentation System
References: 1 2 3 4 5 6  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3283@lists.php.net to get a copy of this message
On Apr 12, 2004, at 11:30 PM, Paul M Jones wrote:
yes, so why the PHP manual is up to date with mostly of the functions and the PEAR manual is not ? Given that the PHP manual is using DocBook... Following your logic with such an hard system the php main documentation should be desert too ;)
Fair enough -- it might have to do with the fact that there are orders-of-magnitude more people interested in PHP than in PEAR. 1% of a a hundred thousand contributors is a hundred times more than 1% of a thousand; they have a critical mass, and PEAR does not. Thus, we must make a critical mass by lowering barriers to entry. Thus, the "ease of use" requirement.
right :D but the advantage of PEAR is having someone that cares about his own baby. On php.net the documentors are not really related to what they document ..that said your point is very valid and true.
Here is my proposal. Let's draft a list of Undocumented packages. I will email each of the lead offering help if needed with the current technology. Let's see how it works then of course we can continue the discussion on alternatives, new technologies, miracles makers et al :D
Good idea, let's start it on a parallel thread and not re-purpose this one. Before you get going, you may want to make a list of the individual steps needed to go from "zero" to "competent" under the current system. I would be interested to see how many steps there are; I'm betting the process is non-trivial. ;-)
heh depends the basics are here http://www.php.net/manual/howto/ but to make it simple here is what you need: - php :) -openjade libxml on debian or mac OS X easy to get and install - text editor cvs account but this is not mandatory because someone else can commit for you in the beginning. I asked a lot of questions on #phpdoc (irc.freenode.net) and I always found help both on IRC and on the mailing lists. I even messed many XML files and someone (didou) helped me to fix the mess. Competent is a strong word but... with some practice is not that complicate. Specially if the package lead tries out phpdocumentor.
--


« previous php.pear.doc (#3283) next »