Skip to content

Instantly share code, notes, and snippets.

@graveca

graveca/!drawing.md

Last active June 26, 2023 20:24
Show Gist options
  • Save graveca/0f8363479ccfa85f7db583e3e6b5294b to your computer and use it in GitHub Desktop.
Save graveca/0f8363479ccfa85f7db583e3e6b5294b to your computer and use it in GitHub Desktop.
Download ZIP
Drawing
Raw
!drawing.md

Drawing

My notes on tools and approaches for drawing technical documents.

Tools

  • PlantUML
  • GraphViz
  • Excalidraw
  • WSD

Philosophy

  • Documentation as code. Put your documentation alongside the code that it describes. Use the same tools.
  • Diagrams as code. Draw diagrams as text and let a renderer do the work of formatting.
Raw
approach.md

Approaches

PlantUML

Draw diagrams using code. See https://plantuml.com/. All types of diagrams including sequence, mind maps, graphs. Plugin inside IntelliJ IDE for drawing.

image

image

GraphViz

I am a complete GraphViz nerd and draw diagrams using digraphs all the time. I tend to draw graphs inside PlantUML since supports the syntax fine and it's in my IDE. See https://graphviz.org.

image

Excalidraw

Useful for drawin sketches like a whiteboard and saving/loading to disk. See https://excalidraw.com/.

image

WSD

Useful for drawing sequence diagrams. See http://wsd. I tend to use PlantUML now.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment