Generate UML diagrams from code
-------------------------------
Key: DOCU-211
URL: http://jira.magnolia-cms.com/browse/DOCU-211
Project: Documentation
Issue Type: Task
Security Level: Public
Components: content
Reporter: Antti Hietala
Assignee: Suzanne Deprez
Start a wiki page where you document a best practice for generating UML
diagrams from code.
* Goal and audience
** Aim the wiki page at seasoned Magnolia developers so they know how to
generate diagrams
** The diagrams are meant for beginning developers so they understand Magnolia
code.
** Which diagram types do beginning developers benefit from most: class,
sequence..?
** What areas of Magnolia code should we provide diagrams of? Send a proposal
to Greg, cc Antti.
* Tools
** Compare couple of Eclipse plugins intended for generating UML diagrams.
Recommend the easiest tool. Look and feel of the diagram is not the most
important selection criteria. Ease of use is.
** Link to plugin download location, installation instructions and usage
instructions
** Attach and embed a sample diagram you generated with the tool.
* Resources
** Generated UML diagrams: [Architectural
notes|http://wiki.magnolia-cms.com/display/WIKI/Architectural+Notes], [Template
rendering|http://documentation.magnolia-cms.com/reference/templating.html]
** Hand-drawn [Magnolia 5 architecture
diagrams|http://wiki.magnolia-cms.com/display/MAGNOLIA5/Magnolia+5+Architecture+Diagrams].
Are these UML or pseudo-UML?
** Hand-drawn [Magnolia 4 architecture
diagrams|http://documentation.magnolia-cms.com/reference/architecture-diagrams/content-storage.html]
([OmniGraffle
originals|http://wiki.magnolia-cms.com/display/DOCU/Architecture+diagrams]).
These are definitely not UML but great for explaining concepts.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details see
http://www.magnolia-cms.com/community/mailing-lists.html
To unsubscribe, E-mail to: <[email protected]>
----------------------------------------------------------------
