[DOCU-211] Generate UML diagrams from code Created: 15/Sep/11  Updated: 03/Nov/15

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Suzanne Deprez
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

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


 Comments   
Comment by Suzanne Deprez [ 16/Sep/11 ]

I found these existing diagrams:
http://wiki.magnolia-cms.com/display/DEV/Renderer,+Model+and+Template+Definition
http://documentation.magnolia-cms.com/reference/templating.html
http://wiki.magnolia-cms.com/display/DEV/Concept+Caching+In+Clustered+Env
http://wiki.magnolia-cms.com/display/WIKI/Architectural+Notes

Comment by Suzanne Deprez [ 28/Oct/11 ]

Added wiki page to start documenting UML diagrams for Magnolia CMS. Continuing to evaluate tools listed on page.

Comment by Suzanne Deprez [ 16/Nov/11 ]

Finished updates to wiki page.

Generated at Mon Feb 12 01:06:58 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.