News Feed
Sections




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

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

Reddit.com: Moving a large existing project onto a framework

LivePipe Blog: Complex Sorting with PHP

Davey Shafik's Blog: Where fore art thou International PHP Magazine?

Jani Hartikainen's Blog: 5 ways how PHP is better than Node.js

Gonzalo Ayuso: How to run a Web Server from a PHP application


Community Events





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


tool opinion framework interview language release laravel artisanfiles symfony community composer podcast list version conference voicesoftheelephpant library introduction series security

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