UML editor for a software architecure lovers !
Diagram.io is online UML editor that is oriented to Github.
You could easily create a UML diagram in any modern Browser and commmit it to your repositoy on the GitHub.
For the local clone of your Github repository you could use Eclipse plug-in which implementes HTTP WebSync API.
Project values:
- Minimize the creation time for a UML diagram
Most of the developers do not create UML diagrams because it takes a lot of time. According to our statistics a minimum time for a UML diagram creation is 10 minutes (for existing code). It looks really boring especially when you have so nice tools like Eclipse or NetBeans.
So, WebSync plug-in for Eclipse allows you to extract and filter information about source code and use it for diagrams creation.
UmlSync + WebSync do not provide an automated diagrams creation because in the most cases they are useless. Semi-automated approach allows you to create usefull diagrams in a minimal time (2min)! - Integrate diagrams into markdown documentation
How often do you have to keep 2 instances of diagram: one in XMI or any other custom format and another one in PNG/JPG/SVG ?
Today, thanks to GitHub all developer could create an online documentation which located in the same repository as code. It means that each branch or revision could contain a valid documentation, API, installation guide etc.
So, the next logical step is to integrate diagrams into markdown documentation !!!
- Simplify sharing diagrams and documentation with collegues
You could send the reference on the diagram by the GitHub path, SHA-sum, or GIST item, and it will be available for your collegues:
http://umlsync.org/github/repos/umlsynco/diagrams/contents/diagrams/ProxyPattern.md
The path structure is absolutely similar to GitHub path except the prefix "http://umlsync.org/github" - Snippets - the way to share knowledge
If you need to explan an internal structure of project/feature/module to the collegues then you could go to the blackboard and start drawing sequence diagrams, components and scheemas.
OR you could create snippet - the sequence of custom(yours) comments across the code, docs and diagrams.
You could explain diagram or source code to the collegue and add your text comments for them and finally you could send it to your collegues or save it to the project knowledge base.
As a result you should not explain again and again the same things and collegues will not come with the questions like: "where is the component which you described on the blackboard ?"
Snippets tool is really perfect in case of multi-sites development when it is not possible to draw somethig on blackboard at all!
Note: Snippets is not a review tool!
Target audience:
- SW architecture geeks who likes to recover an architecture from existing code;
- SW Architects who wants to add an examples to their profile (like linkedin or stackoverflow);
- Community of opensource architects;
- OpenSource contributors who wants to provide an internal documentation;
- Blogs for developers which need to embed a UML widgets and snippets; (like stackoverflow)