O que archimaid faz?
Archimaid adiciona ArchiMate 3.2 ao Mermaid como o tipo de diagrama archimate-beta. Escreva diagramas como texto simples, verifique-os com o CLI archimaid e renderize-os para SVG.
Fluxo de trabalho
- Decida quais elementos e relacionamentos ArchiMate a view precisa. Modele o significado com tipos de elementos e relacionamentos, não com notas.
- Escreva o diagrama em um arquivo
.mmd, ou em um blocomermaidcercado por três acentos graves no Markdown. - Valide-o e corrija todos os erros, depois valide novamente:
Usenpx --yes archimaid validate caminho/para/diagrama.mmd-para validar a entrada padrão. Os problemas são impressos comoarquivo:linha:coluna: mensagem. Avisos começam comwarning:e não interrompem a execução. - Verifique se o ArchiMate 3.2 permite cada relacionamento entre seus tipos de origem e destino (Apêndice B). O validador ainda não verifica isso.
- Renderize um SVG quando o host de destino não puder carregar o plugin, como GitHub Markdown (consulte Renderização).
Sintaxe
Comece com archimate-beta e coloque uma declaração em cada linha.
archimate-beta
direction LR
accTitle: Gestão de pedidos
accDescr: O conjunto de gestão de pedidos contém um componente de faturamento.
element applicationComponent suite "Conjunto de gestão de pedidos" {
element applicationComponent billing "Faturamento"
}
description billing "Lida com faturamento."
click billing href "https://wiki.exemplo.com/faturamento" "Abrir o runbook de faturamento"
suite *-- billing
note review "Confirmar comportamento de repetição" on suite
- Elementos:
element <tipo> <id> "Nome". As 60 chaves de tipo (businessProcess,applicationComponent,node, …) estão listadas em references/reference.md. Leia-as sempre que não tiver certeza de uma chave. - IDs: únicos, começam com letra ou sublinhado e contêm letras, dígitos, sublinhados e hífens.
- Strings: aspas duplas no estilo JSON, nunca vazias. Use
\npara uma quebra de linha. Nomes longos quebram automaticamente. - Acessibilidade: sempre adicione
accTitle:. AdicioneaccDescr:, ouaccDescr { … }para várias linhas. - Frontmatter: um bloco YAML inicial entre linhas
---é permitido, por exemploconfig: { theme: dark }.
Relacionamentos
Forma abreviada: <origem> <conector> <destino>, com : "Rótulo" opcional. O ponto extremo esquerdo é sempre a origem do modelo.
| Conector | Relacionamento |
|---|---|
*-- | composição |
o-- | agregação |
@==> | atribuição |
..|> | realização |
--> | servindo |
.. / <.. / ..> / <..> | acesso: não especificado / leitura / escrita / leituraEscrita |
-.-> | influência |
--- / --/ | associação: não direcionada / direcionada |
==> | acionamento |
-.=> | fluxo |
--|> | especialização |
manage <.. ordersignifica manage lê order: o acessor está à esquerda.- Um ID no início de uma instrução nunca é lido como o glifo
o--. Escrevao o-- b, nãoo--b. - Não repita uma linha abreviada idêntica.
- Forma longa:
relationship <tipo> <id> <origem> -> <destino>, opcionalmente seguido poraccess read|write|readWrite|unspecifiedoudirected, depoislabel "Texto". Use a forma longa quando outra declaração precisar referenciar o ID do relacionamento.
Aninhamento
- Declare filhos dentro de
element … {e}, cada um em sua própria linha. Blocos aninham e podem conter elementos, descrições, relacionamentos, notas,nesteclick, mas não configurações do diagrama. - Aninhamento não requer relacionamento. Quando exatamente um relacionamento pai-filho suporta aninhamento, o fechamento o representa e sua linha fica oculta. Composição, agregação, atribuição, realização e acesso apontam do pai para o filho. Especialização aponta do filho para o pai.
nest <filho> in <pai> [via <idRelacionamento>]é a forma de linha. Useviaquando vários relacionamentos puderem suportar o aninhamento. Cada filho tem um pai visual, e o aninhamento não deve formar um ciclo.
Notas e links
note <id> "Texto"declara uma nota independente. Acrescenteon <idElemento>para anexá-la a um elemento. Notas podem ser pontos extremos de relacionamento.click <id> href "<url>" ["Tooltip"] [_blank|_self|_parent|_top]vincula um elemento. URLs devem ser http, https, mailto ou relativas. Sem tooltip, passar o mouse mostra adescription.
Layout
- Padrão, ou
layout architecture: camadas de cima para baixo (Estratégia, Negócio, Aplicação, Tecnologia e Física, Implementação e Migração), com Motivação no topo perto do que ela conecta. Prefira este para visões entre camadas. layout framework: as mesmas camadas, com colunas fixas de Estrutura Passiva, Comportamento e Estrutura Ativa e Motivação à direita.layout graph, oudirection TB|BT|LR|RLpor conta própria: posicionamento orientado por relacionamento. Prefira este para visões pequenas de camada única e cadeias.
Fora do escopo
Junções, relacionamentos como pontos extremos, figuras alternativas, pontos de vista e intercâmbio de modelo não são suportados. Não invente sintaxe para eles. Diga isso e use o construto suportado mais próximo.
Renderização
A renderização precisa do Playwright Chromium no projeto:
npm install --save-dev archimaid mermaid playwright
npx playwright install chromium
npx archimaid render diagrama.mmd diagrama.svg --theme default --background theme
Para hosts que não registram o plugin (GitHub, GitLab), faça commit do código-fonte .mmd ao lado do SVG e incorpore o SVG: .
Para uma página web, registre o plugin com Mermaid 12.3 ou posterior:
import mermaid from 'mermaid';
import { archimate } from 'archimaid';
mermaid.initialize({ startOnLoad: false, securityLevel: 'strict' });
await mermaid.registerExternalDiagrams([archimate]);
Para verificar a sintaxe rapidamente com o usuário, aponte-o para o playground do navegador: https://try.archimaid.org
Exemplos
references/examples.md tem três diagramas completos e válidos:
- Gestão de pedidos: atribuição, realização, servindo e acesso de leitura
- Relacionamentos entre camadas: layout de arquitetura com processamento de sinistros aninhado
- Componentes aninhados: composição, notas anexadas e independentes, fluxos entre limites