# Inspiringly documented projects

**URL:** <https://www.ruby-forum.com/t/inspiringly-documented-projects/159821>\
**Category:** Ruby\
**Created:** [February 9, 2009, 8:03am UTC](https://www.ruby-forum.com/t/inspiringly-documented-projects/159821 "2009-02-09T08:03:48Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![Martin\_DeMello](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/f17d59/32.png) [@Martin\_DeMello](https://www.ruby-forum.com/u/Martin_DeMello)\
**Post date:** [February 9, 2009, 8:03am UTC](https://www.ruby-forum.com/t/inspiringly-documented-projects/159821/1 "2009-02-09T08:03:48Z")

</div>

I was looking at Rubygame this morning, and I was impressed by the  
quality of its documentation[1] - both extensive and coherent, with  
notes as to the motivation behind various features. Prawn is another  
such library I noticed recently. Anyone else have favourite examples?

[1] [http://rubygame.sourceforge.net/doc/2.3.0/](http://rubygame.sourceforge.net/doc/2.3.0/)

martin

---

<div class="post-metadata">

**Author:** ![Martin\_DeMello](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/m/f17d59/32.png) [@Martin\_DeMello](https://www.ruby-forum.com/u/Martin_DeMello)\
**Post date:** [February 10, 2009, 1:38am UTC](https://www.ruby-forum.com/t/inspiringly-documented-projects/159821/2 "2009-02-10T01:38:49Z")

</div>

Martin DeMello wrote:

> 

My current nominees for this category (and seriously, there OUGHT to be  
an award!) -

ERBook - Extensible document processor based on eRuby  
[http://snk.tuxfamily.org/lib/erbook/](http://snk.tuxfamily.org/lib/erbook/)

Inochi - Gives life to RubyGems-based software  
[http://snk.tuxfamily.org/lib/inochi/#doc-theory.erb](http://snk.tuxfamily.org/lib/inochi/#doc-theory.erb)

This documentation is simply gorgeous!

t.

–

```auto
Tom C., MS MA, LMHC - Private practice Psychotherapist
Bellingham, Washington, U.S.A: (360) 920-1226
<< removed_email_address@domain.invalid >> (email)
<< TomCloyd.com >> (website)
<< sleightmind.wordpress.com >> (mental health weblog)

```