Intridea Blog: Technology, Design, Business

Back to Blog

Get in Touch

You're currently viewing posts tagged with: "documentation"

PROJECT README, Y U NO HAVE?

By Jerry Cheung | November 21, 2011 documentation, opensource, opperator

Pick any popular open source library. It'll have more documentation than your application code - I guarantee it. Test and documentation are both acknowledged as good development practices. But unlike testing, documentation doesn't get the same love from developers. For code that isn't intended for a public audience, developers keep all the docs in their head, or assume that their code is self documenting. Additionally, the tests become a kind of runnable documentation. But there's several lessons we can apply to our private application code from open source documentation. Today, we'll start the conversation with the lowest hanging fruits - the README.

Read more…

Document Your Models the Easy Way

By Joe Grossberg | March 16, 2009 rails, ruby, documentation