Story Notes - ER
ActiveRecord Class/Table Pages
It would be useful to have a page
for each ActiveRecord class (ie, database table).
This should include a connectivity diagram, field descriptions, usage notes, etc.
Most databases are willing to report on their internal structure.
In the case of MySQL
this information is stored in a schema_info
table in each database.
Combining this with information from migrations and ActiveRecord declarations
we can define the content and organization of the database tables.
This information can be used to create diagrams
(eg, via GraphViz
that show a given table and all of its close-related "neighbors".
Ideally, of course, these relationships would extend through classes
into controllers and views.
This wiki page is maintained by Rich Morin
an independent consultant specializing in software design, development, and documentation.
Please feel free to email
comments, inquiries, suggestions, etc!
| SN_Title || ActiveRecord Class/Table Pages |
| SN_Type || ER |
| SN_UseType || View |
| SN_Priority || Important |
| SN_Urgency || r.s.n. |
| SN_TaskSize || L |
| SN_Phase || Analysis |
| SN_Status || Inactive |