News 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

Jonathan Street's Blog: Is PHP good enough for science?

Benjamin Eberlei's Blog: Application Lifecycle Management & Deployment with PEAR & PHAR (revisited)

Community News: Latest PEAR Releases for 02.19.2007

Justin Silverton\'s Blog: Excel and php without COM

Zend Framework Blog: Help us improve the documentation!


Community Events





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


interview laravel deployment symfony series podcast framework zendserver bugfix language community install package release introduction tips api library opinion update

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