News Feed
Jobs Feed
Sections




News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

Kevin van Zonneveld's Blog:
7 Steps to better PEAR documentation
February 23, 2009 @ 11:11:55

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!)
0 comments voice your opinion now!
better pear documentation steps xml cvs phpd build submit package


blog comments powered by Disqus

Similar Posts

Smashing Magazine: Ask SM [PHP]: Form Validation, Converting MySQL to XML

Zend Developer Zone: Streamline Working with XML in PHP Using Service Data Objects (Part 1 & 2)

Secunia.com: Debian Update for PHP4 & PHP5

Riff Blog: Multiple entries with Zend_Config_XML

Marcelo Gornstein's Blog: Dependency injection with Xml and Yaml in the Ding container


Community Events











Don't see your event here?
Let us know!


release series package facebook podcast framework symfony2 install hhvm application security performance code language hack introduction component opinion composer unittest

All content copyright, 2014 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework