Re: Requirements for Documentation System
| From: | David Costa | Date: | Mon, 12 Apr 2004 21:23:24 +0000 |
| Subject: | Re: Requirements for Documentation System | ||
| References: | 1 2 3 4 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3280@lists.php.net to get a copy of this message | ||
On Apr 12, 2004, at 11:14 PM, Paul M Jones wrote:
Sorry, guys, I got off-track with the "translations" thing, I'm just trying to point out a system issue.No problem but remember that translating is a very boring task ;)
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 ;)On Apr 12, 2004, at 11:02 PM, Paul M Jones wrote:My bad. We are talking about the PEAR manual, not the PHP manual.On Apr 12, 2004, at 3:34 PM, Jesus M. Castagnetto wrote:he referred to the php.net manualXML supoorts international alphabete w/o much problem,. That's why we have a Russiand and an English version of the manual written in the same format (about 31 translations IIRC).A nominal 6, not 31: English, French, Japanese, Hungarian, Dutch, Russian.
Not sure about this point. If you make it a duty for leads to keep some documentation they will have to try. This is already a PEAR requirement. So if they commented the code properly they can generate their documents with PHPDocumentor. The problem is not with the new packages but with the old ones. I agree but I would like to wait a proposal for an alternative.I appreciate your effort and I welcome your input, but saying that the current platform is not good enough and that this is the reason why we have no docs or little translation is, IMHO, really far from the truth.I think it is very near the truth; I think that if it is easy to use, more people will use it, and the harder it is to get started, the fewer people will try.
So I guess "easy to use" is a requirement, which brings us back to the proper course. ;-) Yes but I really don't get the requirements/technology distinction really. My bad.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
Cheers David Costa