Linguagens
Markdown
Markdown é uma das linguagens de marcação mais populares para adicionar formatação rica, tabelas e imagens à sua documentação usando documentos de texto simples.
Arquivos Markdown (.md) podem ser controlados por origem juntamente com seu código.
Mais informações:
Ferramentas:
Mermaid
Mermaid permite que você crie diagramas usando definições de texto que podem ser renderizadas posteriormente com uma ferramenta de diagramação e gráficos.
Arquivos Mermaid (.mmd) podem ser controlados por origem juntamente com seu código. Também é recomendável incluir arquivos de imagem (.png) com os diagramas renderizados sob controle de origem. Seus arquivos Markdown devem vincular os arquivos de imagem, para que possam ser lidos sem a necessidade de uma ferramenta de renderização do Mermaid (por exemplo, durante a revisão de solicitação de pull request).
Exemplo de diagrama Mermaid
Este é um exemplo de um diagrama de fluxo Mermaid escrito como código.
graph LR
A[Ideia do Diagrama] -->|Escrever código mermaid| B(arquivo mermaid.mmd)
B -->|Adicionar ao controle de origem| C{Repositório de Código}
B -->|Exportar como .png| G(arquivo .png do diagrama)
G -->|Adicionar ao controle de origem| C
Este é um exemplo de como ele pode ser renderizado como uma imagem.
Mais informações:
Ferramentas: