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.
$ sudo apt-get install graphviz
$ 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.
I have attached some diagrams of one of my App, it also provides detailed diagram with attributes.