Um resumo prático das regras para desenhar em MDL 2.0: elementos, link, pontas, linha tracejada, cross link e cores. O texto completo da notação está na especificação do MDL 2.0; os diagramas prontos estão nos exemplos por uso.
Elementos
O MDL é livre e simples: poucos elementos, um só conector, e qualquer coisa liga com qualquer coisa, desde que faça sentido. Vai do negócio à modelagem de dados no mesmo desenho, em níveis de abstração diferentes.
| Elemento | Forma | O que representa |
|---|---|---|
| user | Qualquer ator que atua no sistema: pessoa, robô, IA, agente. | |
| front-end | Tela ou interface, client-side ou não, web ou não. | |
| back-end | Core, serviço, API, BFF, microserviço. Também um processo ou um contexto (DDD). | |
| data | cilindro | Qualquer repositório de dados: banco, cache, até FTP. |
| part | Uma parte: detalha por dentro ou por fora qualquer elemento. Tiers, layers, cloud, nó, camadas de um core (facade, filtros, DTO, dados), regiões de uma tela (wireframe), tabela de banco (campos), até a estrutura de uma IA. | |
| boundary | Limite ou fronteira: um contexto, um grupo, um ambiente. | |
| black-box | Algo que não se quer detalhar: legado, ferramenta de mercado (Cloudflare, fila, gateway), componente grande. É sempre um retângulo: se for bola ou lápis, não é black-box. O clássico é preto com texto branco. | |
| comentário | retângulo serrilhado (hachurado) | Nota ou especificação: explica o que o elemento é ou como é por dentro. Liga em qualquer elemento. |
Composição por contenção
Um elemento dentro do outro faz parte dele: uma tela dentro de outra tela, bolinhas pequenas dentro de uma grande (um serviço composto), camadas dentro de um core, tabelas dentro do banco.
Rótulo de tipo
O tipo vem entre <<…>> sob o nome, por exemplo <<bff>>, <<api>>, <<database>>, <<table>> e <<postgre>>. Uma tabela é um retângulo com o nome, <<table>> e a lista de fields, como + codigo long, pk.
Link
No MDL só existe um conector: o link, uma linha com seta aberta na ponta. Ele liga qualquer coisa com qualquer coisa: usuário com banco, banco com banco, camada com camada. E tem três funções:
- Direção: o fluxo da informação, para onde a seta aponta.
- Ordem: um número no link (1, 2, 3…) e, abaixo, o que acontece, como “1 - efetuar pagamento” e “2 - invoca o back-end”. Assim o desenho descreve o negócio.
- Desvio (if): o mesmo número em dois links, com cor diferente (por exemplo, vermelho) no caminho alternativo, como “[se] usuário validado: gera e retorna o token”.
Pontas do link
As pontas valem em qualquer link e de qualquer lado.
| Ponta | Figura | Significado |
|---|---|---|
| seta aberta | Direção. | |
| losango fechado (composition) | O lado do losango é o todo, a composição. O MDL não tem losango aberto. | |
| triângulo aberto (specialization) | Especialização (herança). | |
| bolinha fechada (always link) | Sempre acontece, então não precisa de número. Por exemplo, o core com o banco em 100% dos fluxos. | |
| setas nas duas pontas | — | Bidirecional. |
Sem seta no outro lado, a direção é a do lado do losango, da bolinha ou do triângulo. Com seta no outro lado, o losango marca a composição e a seta marca a direção.
Linha tracejada
| Linha | Figura | Vira |
|---|---|---|
| link tracejado | Link fraco: não é necessariamente físico e pode acontecer ou não. | |
| composição tracejada | — | Agregação. |
| especialização tracejada | — | Implementação. |
Cross link
O cross link é um link que passa por cima de elementos e camadas para ligar dois pontos distantes, sem precisar de uma setinha por camada. Por exemplo, do usuário ou da tela direto ao core ou ao banco, atravessando as tiers de infraestrutura e a segurança. Ele aparece em vermelho e deixa o desenho limpo. Use de um ponto relevante a outro, como da última camada do front à primeira do core. Veja o cross link no exemplo de link e cross link.
Cores
A paleta é o padrão da ArcH. Os elementos são claros (exceto o black-box), com texto e borda no tom escuro da mesma cor.
| Domínio | Amostra | Cor |
|---|---|---|
| front-end / usuário | Roxo claro no elemento. Roxo escuro no nome, no usuário e na seta que nasce dele. | |
| core / back-end | Azul claro. | |
| segurança | Verde: escuro se for black-box, claro se não for. | |
| dados / banco / camada de dados | Amarelo. | |
| externo | Cinza. | |
| black-box | Sólido escuro, o clássico é preto, com texto branco. | |
| desvio de fluxo / cross link | Vermelho. |
- Cor do link: é a da origem. A seta que sai do front é roxa; a que sai de um black-box verde é verde.
- Camadas: quanto mais externa, um pouco mais escura; quanto mais interna, mais clara. A sub-sub-camada pode ter fundo branco com borda na cor da camada: o contraste mostra a profundidade.
- Molduras externas (título, moldura escura) são enfeite, não fazem parte da notação.
