DEV Community

Molinero
Molinero

Posted on

Solução definitiva para minhas documentações

Nos primórdios, fazia minhas documentações em txt, mas era um método um tanto quanto arcaico e pobre de recursos. Porém, documentação tem que ser algo que você consiga acessar em qualquer editor de texto, em qualquer sistema operacional, em qualquer máquina que você esteja, por isso nunca quis fazê-las em PDF ou word (argh 🤮) e de qualquer outra forma que eu precisasse instalar ferramenta/app para poder acessar.

Foi então que conheci o Markdown. Linguagem de marcação fácil de aprender e que pode acessar em qualquer editor de textos. Depois do Markdown dominado, senti falta de um pouco mais de "beleza", conseguir representar fluxogramas, gráficos, etc. E eis que hoje, estou usando o que se tornou pra mim a solução definitiva pras minhas documentações.

Markdown + Mermeid

Markdown+Mermaid Example

Indico a todos a darem uma olhada

Markdown Guide

Mermaid

Top comments (0)