News Feed
Sections




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

Chris Hartjes' Blog:
What Is Really Considered Documentation?
July 23, 2008 @ 10:26:33

In this new post, Chris Hartjes takes a look at something that is one of the banes of most programmers' existence - documentation. In it he wonders what should really be considered documentation and the importance of it.

As a committed user of open source technologies, the difference between me using something and not using something is the documentation. Is there documentation for it? Is it easy to find? Does it answer my questions? Is there someone I can call an idiot if I disagree with the level of documentation? These are all very important questions.

He uses the illustration of the documentation of the CakePHP framework that's helpful, but only really after you learn how to use the framework in the first place. He mentions people on both sides of the fence - those that love the framework and love the documentation and those that moved on to something simpler because they just couldn't get it.

He also mentions the variety of sources that can provide "documentation" for the framework when you're getting a bit stuck - everything from blogs to The Bakery to a different sort of documentation, unit test.

0 comments voice your opinion now!
consider documentation types cakephp example unittest manual blog


blog comments powered by Disqus

Similar Posts

Matthew Weier O'Phinney: Testing Code That Emits Output

Phil Sturgeon: Why PHP DateTime Rocks

Brandon Savage: Best PHP Blogs To Follow

Richard Thomas' Blog: Pjq becomes jQPie - jQuery PHP interface extension

MC|Press Online: TechTip: PHP Delivers mail() on IBM System i


Community Events





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


interview community series library tips introduction laravel package language list release opinion bugfix install deployment podcast framework voicesoftheelephpant symfony api

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