search

tpluscode / restalk-editor

0 stars 0 forks source link

Implement diagram generation #2

Open tpluscode opened 7 years ago

tpluscode commented 7 years ago

There are a bunch of possibilities on how to implement the diagramming. Ideally the tool should produce SVG images. For that purpose I've been considering an extensible JavaScript library. Here are some choices to look into:

  1. https://github.com/adrai/flowchart.js
  2. http://jointjs.com/tutorial
  3. http://sigmajs.org/
  4. https://gojs.net/latest/learn/index.html
  5. https://www.jgraph.com/
  6. http://plantuml.com/
  7. http://knsv.github.io/mermaid/
  8. https://github.com/sporritt/jsPlumb
  9. https://www.structurizr.com/
asbjornu commented 7 years ago

We have had great success implementing PlantUML in our organisation, where we have plugins for it in our internal wiki and use the tooling extensively so we can version the diagrams the diagrams alongside the code belonging to the system they are documenting.

While the resulting diagrams and tool chain does leave something to be desired, I haven't found a solution that integrates better in a development process. Highly recommended.

Oh, and since you haven't already mentioned it, there's Web Sequence Diagrams too.