-
Task
-
Resolution: Unresolved
-
Neutral
-
None
-
None
-
None
-
-
Empty show more show less
-
Empty show more show less
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, Template rendering
- Hand-drawn Magnolia 5 architecture diagrams. Are these UML or pseudo-UML?
- Hand-drawn Magnolia 4 architecture diagrams (OmniGraffle originals). These are definitely not UML but great for explaining concepts.
Acceptance criteria