News Feed
Sections




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

Scott Mattocks:
D is for Documentation
March 04, 2013 @ 09:30:16

Scott Mattocks has wrapped up his series about LUCID development with the final letter of the acronym - D is for Documentation.

Despite mankind's best efforts, writing code is still clearly an exercise for talking to computers. It has not evolved to the point where talking to a computer is as easy and natural as talking to other people. That's why documentation is so important. Programming languages are just a translation of a developer's intent into something a computer can execute.

He points out that even a little documentation can go a long way (even in presentations with code in the slides). It provides context and the intent of the code, not just details about what it's doing. He proposes a compliment practice to test-driven development (TDD) that turns the documentation process around - Documentation Driven Development. This is essentially writing up what the code does first, then writing tests to check it and only then writing the code to make it happen.

If you're interested in the rest of the articles in the series, check out the LUCID article on his site with links to each letter's article.

0 comments voice your opinion now!
lucid development principles documentation tdd


blog comments powered by Disqus

Similar Posts

Community News: Learn Test-Driven Development with Munchkin

Sara Golemon\'s Blog: libssh2 API documentation - Complete

Chris Hartjes: PHPSpec and the New Wave of Testing

NetTuts.com: Getting Started With Phpspec

Philip Olson's Blog: Learning how to help people contribute to the PHP.net Project


Community Events





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


symfony community zendserver release language tips voicesoftheelephpant api list code laravel series interview framework deployment podcast introduction development bugfix conference

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