Is your package really documented? The truth
| From: | David Costa | Date: | Thu, 29 Apr 2004 21:59:57 +0000 |
| Subject: | Is your package really documented? The truth | ||
| Groups: | php.pear.dev php.pear.doc | ||
| Request: | Send a blank email to pear-dev+get-28582@lists.php.net to get a copy of this message | ||
Hello Everyone,
After reviewing the previous topic, I prepared (manually :(( ) the list of the PEAR Documentation status as it is today, you can see it at
http://pear.gurugeek.org/
you can also modify the listing if something is not accurate, or make your pledge to documented the package by changing the status to "$progress "
and possibly the expected date.
The list is not completely accurate, aka if you have some external documentation it is still not documented in the PEAR manual and the basic documentation with
link should be part of the manual.
We have 139 not documented packages at the moment (including alpha and beta releases)
Possible solutions:
a) learn DocBook format and validation, use PHPDocumentor to prepare your docs and commit to peardoc
b) Prepare some basic docbook documentation (see http://pear.gurugeek.org/ for an explanation and some examples)
which links to your website or better a Wiki where you have available both the API Documentation and some implementation examples.
I am willing to do the PEAR Manual/Docbook linking and basic documentation on demand.
Looking forward your suggestions and comments,
Regards
David Costa