DEV Community

Discussion on: Diagrams are the ultimate engineering tool

Collapse
 
wesen profile image
Manuel Odendahl

When you say they are not easy to create, what do you mean exactly? One thing I love about diagrams is that they are easy to create, and in fact most of the diagrams I draw are ephemeral. I draw them on the whiteboard or I create them with mermaid/plantuml in a pair programming session or in github comments, and then I discard them.

Documentation diagrams that are meant to be readable and long lived are indeed much more intensive. But compared to a well-written text that conveys the same information, the diagram is often faster and clearer. It is also easier to modify as the documentation needs to be adjusted.

Collapse
 
maurerkrisztian profile image
Krisztián Maurer

yes, when you draw them on the whiteboard or at a pair programming session, it's easy, you have instant feedback and add the missing context as you go. but I'm talking about documentation type diagrams when you want to abstract a complex system without instant feedback and provide a good diagram for all the developers.. You can go crazy and create a too big diagram or a too small one and need to do the shapes, notes, colors, etc with clear representation especially if you do more than one diagram about a complex system.. This is what my last comment was about. Thanks for the reply.