Draw architectural design of the project using “railroady” gem.

As a developer no one likes to write a complete documentation for a project. Butsometime we have to give some document which explain at least our architectural design of project.
If in future anyone else work on same project then he can easily understand the overview and business logic before look into the code.We should draw a simple architectural design of our project models, controller and their relationship.
There is a gem which provides all necessary diagrams – add it into development group.

 gem ‘railroady’

System Requirements

$ sudo apt-get install graphviz

run

$ rake diagram:all

It generates all diagrams contains structural design in the /doc directory.  If you have 100 model and controller in your app then Gemerated UML diagram is too much complex to view. So this gem provides some options like you can specify only those model for which you want to draw relationship.

This gem have lot of other options.
For more details Click here and click here

I have attached some diagrams of one of my App, it also provides detailed diagram with attributes.
Thanks

ImageImage

Advertisements

One thought on “Draw architectural design of the project using “railroady” gem.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s