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/

---

---

---

PlanUML project also allow you to build cool diagrams (Architecture, Sequence, Flow, etc..) using just a plain text format. You can use an online version here. Below an Architecture example with PlanUML definitions.

@startuml
rectangle "Services Flow Architecture" {
    rectangle "Services Examples" as Services {
      ["queue service server"] as qss
      ["queue service consumer"] as qsc
      ["queue worker"] as qw
      ["notifications"] as notify

      qss -[hidden]down-> qsc
      qsc -[hidden]down-> qw
      qw -[hidden]down-> notify
    }

    rectangle "AWS ActiveMQ" {
        queue "events queue" as eq
        queue "events topic" as et
    }
    qss -> eq
    qsc -> eq
    notify -> eq
    qw -> eq

    eq -up-> et
}

@enduml

I have attached a sample below.

What about https://mermaid-js.github.io/mermaid/#/?

I've been playing with Gliffy, simple but powerful enough for my needs.

Hello
I am working on asciidoctor-gradle-plugin and want to find a way how to edit existing or create new diagrams within asciidoctor in gradle. Is there a way to do this? Thank you in advance :D

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;

Loading

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