# Tool per redazione documentazione

**URL:** <https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159>\
**Category:** IT\
**Created:** [May 19, 2011, 5:58pm UTC](https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159 "2011-05-19T17:58:45Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![luislavena](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/l/0ea827/32.png) [@luislavena](https://www.ruby-forum.com/u/luislavena)\
**Post date:** [May 19, 2011, 5:58pm UTC](https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159/1 "2011-05-19T17:58:45Z")

</div>

Ciao, qualcuno utilizza/conosce tools per scrivere documentazione in una  
applicazione Rails? Esistono utility per ricavare diagrammi entità  
relazioni per il database?

---

<div class="post-metadata">

**Author:** ![dboz](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/dc4da7/32.png) [@dboz](https://www.ruby-forum.com/u/dboz)\
**Post date:** [May 20, 2011, 11:53am UTC](https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159/2 "2011-05-20T11:53:11Z")

</div>

2011/5/19 ROR ROR [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid):

> Ciao, qualcuno utilizza/conosce tools per scrivere documentazione in una  
> applicazione Rails? Esistono utility per ricavare diagrammi entit  
> Ciao ‘Ror ror’ (?)… la domanda un po’ vaga… puoi usare RDoc  
> ([http://rdoc.sourceforge.net/](http://rdoc.sourceforge.net/))  
> o Yard ([http://yardoc.org/](http://yardoc.org/)) per documentare il tuo codice.

> relazioni per il database?  
> Mmmmh… di solito fai il percorso inverso… prima hai le relazioni  
> che devi costruire e poi nei modelli metti i vari has\_\* e belongs\_to  
> per realizzarle.

Al limite puoi usare annotate ([annotate | RubyGems.org | your community gem host](https://rubygems.org/gems/annotate)) per  
farti un dump dello schema della tabella all’interno del file del  
modello… giusto da avere come riferimento.

HTH  
Paolo

–  
“… static analysis is fun, again!”

life from an application security guy ~\> [http://thesp0nge.com](http://thesp0nge.com)

---

<div class="post-metadata">

**Author:** ![dboz](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/dc4da7/32.png) [@dboz](https://www.ruby-forum.com/u/dboz)\
**Post date:** [May 20, 2011, 11:56am UTC](https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159/3 "2011-05-20T11:56:53Z")

</div>

Se vuoi generare diagrammi UML _a partire_ dal codice di  
un’applicazione Rails (a la “reverse engineering”) ti consiglio di  
guardare: [http://railroad.rubyforge.org/](http://railroad.rubyforge.org/)

Il 20 maggio 2011 11:52, Paolo P. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) ha scritto:

> per realizzarle.  
> “… static analysis is fun, again!”
> 
> life from an application security guy ~\> [http://thesp0nge.com](http://thesp0nge.com)
> 
> * * *
> 
> Ml mailing list  
> [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
> [http://lists.ruby-it.org/mailman/listinfo/ml](http://lists.ruby-it.org/mailman/listinfo/ml)

–  
Carlo P.  
email: [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
twitter: @carlopecchia

---

<div class="post-metadata">

**Author:** ![dboz](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/dc4da7/32.png) [@dboz](https://www.ruby-forum.com/u/dboz)\
**Post date:** [May 20, 2011, 1:34pm UTC](https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159/4 "2011-05-20T13:34:28Z")

</div>

2011/5/20 Carlo P. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid):

> Se vuoi generare diagrammi UML _a partire_ dal codice di  
> un’applicazione Rails (a la “reverse engineering”) ti consiglio di  
> guardare: [http://railroad.rubyforge.org/](http://railroad.rubyforge.org/)

alternativo, per i diagrammi ER: [http://rails-erd.rubyforge.org/](http://rails-erd.rubyforge.org/)

---

<div class="post-metadata">

**Author:** ![dboz](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/d/dc4da7/32.png) [@dboz](https://www.ruby-forum.com/u/dboz)\
**Post date:** [May 20, 2011, 5:28pm UTC](https://www.ruby-forum.com/t/tool-per-redazione-documentazione/207159/5 "2011-05-20T17:28:02Z")

</div>

On Thursday, May 19, 2011 05:58:45 PM ROR ROR wrote:

> Ciao, qualcuno utilizza/conosce tools per scrivere documentazione in una  
> applicazione Rails?

Personalmente preferisco yard rispetto a rdoc.

Ciao  
Flavio