markdown guide

What's the official industry term for "random incoherent lines all over a notebook?"


R.I.L.A.O.N now you're using a modeling language, I guess it has a lot of good features like infinity freedom, just one downside : no one will understand it but you.


"Boxes and arrows", often incorrectly referred to as flowcharts


We don't

We write documentation using Guru and our API is documented in Apiary. We could say our model is described in Apiary. We use Guru to share small pieces of documentation with the team. We think that works better than writing long articles in a wiki or similar.


It should be about documentation only but about modeling ;)


Lately I ve been using the c4model.com/
I m in a team with an architect that prepare the highest abstraction layer and then we go almost until the code layer with her to map the whole project and interactions


Same as Ben but I use Markdown files because my calligraphy is not even readable by me 😂


Scrawly notebook doodles showing flows of data and dependency. If I need other people to be able to understand them, I use draw.io or a similar tool to produce legible versions. I'm not working on anything so massive as to require formal specification with UML and the like.



which is very comprehensible for both business and developers (Automation Industry know that kind of diagram well). Is agnostic so could map easily with code or UML if wanted.


I like drawing diagrams in Omnigraffle! Lots of freedom, and nice to show to technical and non-technical folks alike. For enduring documentation, we use Jira/Confluence.

Classic DEV Post from Dec 14 '19

Python coders, what are some exercises/activities that help you quickly get better at the basic coding?

Belhassen Chelbi profile image
UX Designer/ Front End Engineer I help businesses develop products with impact on humans.