News Feed
Jobs Feed
Sections




News Archive
PHPMaster.com:
Documentation Makes the World Go Round
October 04, 2011 @ 09:03:16

On PHPMaster.com today there's a new article emphasizing something that lots of developers forget to make a part of their process when writing code - creating useful documentation to help make your code that much clearer.

If you're writing code that will be shared with others, put yourself in their shoes. Don't let your project lose potential users, community members, and possible contributors all because of insufficient documentation.

He (Matthew Turland) suggests a few things to keep in mind as you're writing up your documentation - the content is "king" (an emphasis on good descriptions/examples/use cases), open it up to external contributions using things like wikis (or even stored in the source code repository) and a focus on technical writing skills. Even the best tools out there can suffer if there's poor or no documentation.

0 comments voice your opinion now!
documentation application code opinion content usecase example technical writing


blog comments powered by Disqus

Similar Posts

Ben Ramsey's Blog: Zend Framework on Ning

I Am Learning PHP Blog: Do Web-Scripting Languages Really Need OOP?

David Sklar's Blog: PHP Cookbook, 2nd Edition

Sitecritic.net: Simple Content Management in PHP Without Database Access

IBM developerWorks: Use Ajax with PHP and DB2 9 - Xajax


Community Events











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


opinion introduction unittest functional phpunit framework object conference code application community interview release podcast zendframework2 testing development series example language

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