Kevin van Zonneveld has posted seven steps that you can follow to help the documentation for your PEAR class come out better and be more useful in the end.
If you've written a PEAR package, it's probably a good idea to submit some end user documentation. Here's how to do it.
He explains what it is (XML in CVS, easily convertible with phpd) and how the process flows - save the current docs, add your own, build locally and submit to CVS. Here's his tips to help things go smoothly/turn out better:
- Gather the prerequisites
- Save current documentation
- Try building the docs
- Write your own XML docs
- ReBuild peardoc
- Commit your XML
- (There is no seventh step - you're done!)