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

StackExchange.com: What features would you like to have in PHP?

NETTUTS.com: Book Review: Zend Framework 1.8 Web Application Development

Symfony Blog: Symfony Docs Hack Day Needs You on March 30th

Ben Ramsey\'s Blog: Technical Vocabulary and Grammar

Matt Frost: Using Comments


Community Events









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


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

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