News Feed
Jobs Feed
Sections




News Archive
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

TopWebNews.com: Web Services and PHP

echolibre Blog: The Capsule CRM API and PHP

Chris Jones' Blog: PHP 5.3.8 RPMs are on oss.oracle.com

Mayflower Blog: PHP_CodeBrowser goes stable

Blog.php-tools.net: patError documentation available


Community Events









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


interview development composer opinion podcast api object framework database release language code phpunit tool example introduction testing zendframework2 unittest community

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