News Feed

News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way
Documentation Makes the World Go Round
October 04, 2011 @ 09:03:16

On 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

Anthony Ferrara: It's All About Time

Hiveminds Magazine: PHP: What to Do When Your Web Host Turns Off Fopen

Victor Farazdagi's Blog: New Project: Phrozn - static site generator in PHP

Paul Jones' Blog: PHP Works 2007 Teaser: Framework Benchmarks!

Alexander Netkachev's Blog: Easy Apache/PHP install

Community Events

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

opinion framework extension release composer voicesoftheelephpant version introduction interview api application community library series laravel example symfony2 performance php7 podcast

All content copyright, 2015 :: - Powered by the Solar PHP Framework