# Best practice for documenting a ROR application

**URL:** <https://www.ruby-forum.com/t/best-practice-for-documenting-a-ror-application/137196>\
**Category:** Rails\
**Created:** [May 9, 2008, 9:03pm UTC](https://www.ruby-forum.com/t/best-practice-for-documenting-a-ror-application/137196 "2008-05-09T21:03:37Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![jef](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e5b9ba/32.png) [@jef](https://www.ruby-forum.com/u/jef)\
**Post date:** [May 9, 2008, 9:03pm UTC](https://www.ruby-forum.com/t/best-practice-for-documenting-a-ror-application/137196/1 "2008-05-09T21:03:37Z")

</div>

Hi

is there a method in particular?

Does IDE provide any features to do that?

thanks

---

<div class="post-metadata">

**Author:** ![jef](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/e5b9ba/32.png) [@jef](https://www.ruby-forum.com/u/jef)\
**Post date:** [May 11, 2008, 1:44am UTC](https://www.ruby-forum.com/t/best-practice-for-documenting-a-ror-application/137196/2 "2008-05-11T01:44:12Z")

</div>

RDoc is the standard method of Ruby documentation. The Pickaxe book  
has a chapter devoted to it. There’s a lot that you can do with it,  
but to generate HTML documentation for your app, you can run `rake doc:app` from the app root. (I think.)

-Kyle