Re: Is your package Documented ?
| From: | Paul M Jones | Date: | Tue, 13 Apr 2004 19:25:43 +0000 |
| Subject: | Re: Is your package Documented ? | ||
| References: | 1 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-27582@lists.php.net to get a copy of this message | ||
On Apr 13, 2004, at 1:48 PM, David Costa wrote:
Is you package documented and listed in the pear manual ?Thanks to David Costa it is (kind of) -- David just linked the manual entries for Text_Wiki and Contact_Vcard_* to my external documentation site.
If the answer to this question is No, please let us know why not ;) (email the Doc list at pear-doc@lists.php.net)I think I've been hammering at this one a while on PEAR-DOC, but I'll say it again here (as Jones the Ogre!) -- I find it far too difficult to get started in the current documentation system, and the feedback loop is much too long to be rewarding. That's just me.
Extensive documentation (whenever possible with clear, "for dummies" examples) is critical to ensure both your package and PEAR success among users.Absolutely right.
Documentation can be automatically-generated using PHPDocumentor http://pear.php.net/package/PhpDocumentor/Jones the Ogre speaks: PhpDocumentor itself is not in the PEAR documentation. Is that bad? :-( -- Paul M. Jones Savant: the simple alternative to Smarty. http://phpsavant.com/