Download the presentation (6MB PDF)

I have a confession: I love documentation — and I don’t just mean code comments. I mean documentation of every form. I want to introduce you to the breadth of documentation styles and forms. I want to show you how to produce beautiful generated documentation. I want to explain what makes an awesome README. How to build an amazing marketing website for your library. I want to gush about why I think writing TomDoc is going to make you write better code.

Ruby is such an expressive language that your code can end up looking like anything you can imagine. Documentation is paramount in helping others understand why and how they should be using your code.

References

Documentation Formats

Good Website Examples

READMEs

Man pages

Hacks & Tools

Misc

If you'd like to keep in touch, I tweet @kneath on Twitter. You're also welcome to send a polite email to kneath@gmail.com. I don't always get the chance to respond, but email is always the best way to get in touch.