Como desenhar diagramas de arquitetura de software (2022)

• Artigo sobre como desenhar diagramas eficazes de arquitetura de software
• O autor enfatiza a importância dos diagramas no desenvolvimento de software, pois muitas vezes eles se tornam o centro de discussões e tomadas de decisão
• O conteúdo do diagrama deve ser preciso, atualizado e sem ambiguidades, e as entidades e relações devem ser representadas corretamente
• O autor propõe várias características de um diagrama eficaz:
  • Minimizar a distância entre vizinhos: manter nós relacionados próximos uns dos outros torna o diagrama mais fácil de entender. Isso se torna um desafio à medida que o diagrama cresce
  • Buscar simetria: diagramas simétricos são visualmente atraentes e mais fáceis de compreender. Além disso, podem reforçar o significado transmitido pelo diagrama
  • Alinhamento central: um diagrama limpo e alinhado torna os conceitos mais claros. Manter o alinhamento a cada nova adição ajuda a preservar a organização
  • Uso de grupos de contêineres: dividir o diagrama em várias áreas rotuladas o torna mais fácil de entender. Os contêineres podem adicionar contexto, mostrar abstrações ou agrupar objetos relacionados
• O autor promete abordar mais na parte 2 sobre roteamento de linhas, tamanho e posição de rótulos, cores, ícones etc.
• Este artigo faz parte do blog da Terrastruct, que oferece materiais para engenheiros e desenvolvedores de software

[GN⁺]

Comentários do Hacker News

• Um usuário gosta de criar diagramas por causa das opções de formatação e da sintaxe da linguagem D2, e escreveu um post no blog sobre isso.
• O VisualFlows.io deve lançar em breve a versão v1.0, que permitirá aos usuários projetar em poucos minutos um mapa animado da arquitetura do seu SaaS. Os principais recursos incluem Smart Sections, Smart Edges, Smart Node Deletion, modos Dark/Light, Embeddable, Drag n Drop de imagens/svgs/gifs, ícones da AWS/Windows/Google e suporte a Markdown.
• Outro usuário argumenta que, quando o sistema começa a mudar, pode ser difícil manter diagramas “bonitos”, e sugere usar diagrams-as-code como uma alternativa mais eficiente.
• Um usuário reclama que, embora grandes modelos de linguagem sejam possíveis, não existe uma ferramenta local para reorganizar blocos e setas em busca de beleza estética. Ele se pergunta por que não existe uma ferramenta em que o usuário possa desenhar caixas e setas, e o sistema alinhe tudo para ficar bonito.
• Um usuário traça um paralelo entre diagramas de arquitetura de software e esquemas elétricos, diagramas de circuitos e outros desenhos de engenharia. Ele argumenta que não existe uma “resposta certa” e que escolher boas abstrações e formas de representação é o que separa ideias compreensíveis de uma bagunça arrependida.
• Um usuário compartilha sua experiência usando o yEd para desenhar diagramas. Com essa ferramenta, é possível bagunçar caixas e setas, mas com alguns cliques no menu tudo é organizado automaticamente.
• Um usuário agradece por um artigo que explica como tornar algo mais bonito de forma prática. Ele normalmente depende da própria intuição.
• Um usuário compartilha sua experiência com o D2 para gerar automaticamente um grande diagrama D2 a partir de um arquivo serverless.yml. A ferramenta é atualizada automaticamente conforme o sistema cresce.
• Outro usuário adiciona a linguagem D2 ao seu post no blog para abordar temas relacionados a código de design de cibersegurança.
• Um usuário sugere adicionar blocos plantuml para inserir diagramas em projetos escritos como documentos markdown. Ele observa que, ao visitar arquivos .md no GitLab pelo navegador, eles são renderizados corretamente, mas que o GitHub ainda não oferece esse recurso.