Diagrams for Documentation

gistfile1.md

some tools for diagrams in software documentation

Diagrams For Documentation

Obvious Choices

• Graphviz
• Pandoc

ASCII

• AsciiFlow Editor online web-editor, limited shapes
• Ditaa Generator Java
• Ascidia Generator Python

UML

• Class Diagram - yUML
• Activity Diagram - yUML
• Use Case Diagram - yUML

yUML (ruby on rails) can be hosted yourself, for 49 USD

• Sequence Diagram - js-sequence-diagrams JavaScript, browser, SVG
• Sequence Diagram - flowchart.js JavaScript, browser, SVG

Sequence Diagrams

• KangaModeling, dot-like, web-api-renderer, .NET

• https://stackedit.io/

---

---

---

https://shd101wyy.github.io/markdown-preview-enhanced/#/diagrams

https://github.com/yuzutech/kroki

You can also use diagrams.net (draw.io) diagrams in your repository. Check it out

Mermaid is Github native now.

  graph TD;
      A-->B;
      A-->C;
      B-->D;
      C-->D;

I'd forgotten the name, and found this Gist organically via Google. Seems like Mermaid is definitely worth mentioning here in this context. 😉