News Feed
Jobs Feed
Sections




News Archive
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

Synfony Project: New testing framework

Tim Koschuetzki's Blog: How to put Combined Fields Into CakePHP's Model->generateList()

Fabien Potencier's Blog: PHP Iterators and Streams are awesome

Paul Jones' Blog: How Fast Is Your Framework?

Fabian Schmengler's Blog: "Mocking" built-in functions like time() in Unit


Community Events











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


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

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