archimaid은(는) 무엇을 하나요?
Archimaid는 ArchiMate 3.2를 Mermaid에 archimate-beta 다이어그램 유형으로 추가합니다. 다이어그램을 일반 텍스트로 작성하고, archimaid CLI로 확인한 후 SVG로 렌더링할 수 있습니다.
워크플로우
- 뷰에 필요한 ArchiMate 요소와 관계를 결정합니다. 메모가 아닌 요소 유형과 관계로 의미를 모델링하세요.
- 다이어그램을
.mmd파일 또는 마크다운의mermaid펜스 블록 안에 작성합니다. - 검증하고 모든 오류를 수정한 후 다시 검증합니다:
표준 입력을 검증하려면npx --yes archimaid validate path/to/diagram.mmd-를 사용하세요. 문제는file:line:column: message형식으로 출력됩니다. 경고는warning:으로 시작하며 실행을 실패시키지 않습니다. - ArchiMate 3.2가 각 관계의 소스와 대상 유형 간의 관계를 허용하는지 확인합니다(부록 B). 현재 검증기는 이를 확인하지 않습니다.
- GitHub 마크다운과 같이 대상 호스트가 플러그인을 로드할 수 없는 경우 SVG를 렌더링합니다(렌더링 참조).
구문
archimate-beta로 시작하고 각 선언을 한 줄에 하나씩 배치합니다.
archimate-beta
direction LR
accTitle: 주문 관리
accDescr: 주문 관리 제품군에는 청구 구성 요소가 포함되어 있습니다.
element applicationComponent suite "주문 관리 제품군" {
element applicationComponent billing "청구"
}
description billing "청구서 처리를 담당합니다."
click billing href "https://wiki.example.com/billing" "청구 런북 열기"
suite *-- billing
note review "재시도 동작 확인" on suite
- 요소:
element <유형> <id> "이름". 60가지 유형 키(businessProcess,applicationComponent,node, …)는 references/reference.md에 나열되어 있습니다. 키가 확실하지 않을 때마다 읽어보세요. - ID: 고유해야 하며, 문자나 밑줄로 시작하고 문자, 숫자, 밑줄, 하이픈을 포함할 수 있습니다.
- 문자열: JSON 스타일의 큰따옴표를 사용하며, 절대 비어 있지 않아야 합니다. 줄바꿈에는
\n을 사용하세요. 긴 이름은 자동으로 줄바꿈됩니다. - 접근성: 항상
accTitle:을 추가하세요. 여러 줄의 경우accDescr:또는accDescr { … }를 추가하세요. - 머리말:
---줄 사이의 선행 YAML 블록이 허용됩니다(예:config: { theme: dark }).
관계
단축 표기: <소스> <연결자> <대상>, 선택적으로 : "레이블"을 추가할 수 있습니다. 왼쪽 끝점은 항상 모델 소스입니다.
| 연결자 | 관계 |
|---|---|
*-- | 구성 |
o-- | 집합 |
@==> | 할당 |
..|> | 실현 |
--> | 서빙 |
.. / <.. / ..> / <..> | 접근: 불특정 / 읽기 / 쓰기 / 읽기쓰기 |
-.-> | 영향 |
--- / --/ | 연관: 무방향 / 방향 |
==> | 트리거링 |
-.=> | 흐름 |
--|> | 특수화 |
manage <.. order는 manage가 order를 읽음을 의미합니다: 접근자가 왼쪽에 있습니다.- 문장 시작 부분의 ID는
o--글리프로 읽히지 않습니다.o--b가 아닌o o-- b로 작성하세요. - 동일한 단축 표기 줄을 반복하지 마세요.
- 긴 형식:
relationship <유형> <id> <소스> -> <대상>, 선택적으로access read|write|readWrite|unspecified또는directed를, 그 다음label "텍스트"를 추가합니다. 다른 선언이 관계의 ID를 참조해야 할 때는 긴 형식을 사용하세요.
중첩
element … {와}안에 자식을 선언하되, 각 자식을 독립적인 줄에 배치합니다. 블록은 중첩될 수 있으며 요소, 설명, 관계, 노트,nest및click을 포함할 수 있지만 다이어그램 설정은 포함할 수 없습니다.- 중첩에는 관계가 필요하지 않습니다. 정확히 하나의 부모-자식 관계가 중첩을 지원하는 경우, enclosure가 그 관계를 나타내며 해당 줄은 숨겨집니다. 구성, 집합, 할당, 실현 및 접근은 부모에서 자식으로 향합니다. 특수화는 자식에서 부모로 향합니다.
nest <자식> in <부모> [via <관계Id>]는 줄 형식입니다. 여러 관계가 중첩을 지원할 수 있는 경우via를 사용하세요. 각 자식은 하나의 시각적 부모를 가지며, 중첩은 순환을 형성해서는 안 됩니다.
노트 및 링크
note <id> "텍스트"는 독립형 노트를 선언합니다.on <요소Id>를 추가하여 노트를 요소에 첨부할 수 있습니다. 노트는 관계의 끝점이 될 수 있습니다.click <id> href "<url>" ["툴팁"] [_blank|_self|_parent|_top]는 요소를 링크합니다. URL은 http, https, mailto 또는 상대 경로여야 합니다. 툴팁이 없으면 호버링 시description이 표시됩니다.
레이아웃
- 기본값 또는
layout architecture: 레이어를 위에서 아래로(전략, 비즈니스, 애플리케이션, 기술 및 물리, 구현 및 마이그레이션) 배치하며, 동기는 연결되는 항목 근처 상단에 배치됩니다. 레이어 간 뷰에 선호합니다. layout framework: 동일한 레이어에 고정된 수동 구조, 행동, 능동 구조 열이 있고 동기는 오른쪽에 배치됩니다.layout graph또는 단독direction TB|BT|LR|RL: 관계 기반 배치. 작은 단일 레이어 뷰와 체인에 선호합니다.
범위 외
접합점, 끝점으로서의 관계, 대체 도형, 관점 및 모델 교환은 지원되지 않습니다. 이에 대한 구문을 만들지 마세요. 그렇다고 말하고 가장 가까운 지원 구문을 사용하세요.
렌더링
렌더링하려면 프로젝트에 Playwright Chromium이 필요합니다:
npm install --save-dev archimaid mermaid playwright
npx playwright install chromium
npx archimaid render diagram.mmd diagram.svg --theme default --background theme
플러그인을 등록하지 않는 호스트(GitHub, GitLab)의 경우, .mmd 소스를 SVG 옆에 커밋하고 SVG를 포함시키세요: .
웹 페이지의 경우 Mermaid 12.3 이상에서 플러그인을 등록하세요:
import mermaid from 'mermaid';
import { archimate } from 'archimaid';
mermaid.initialize({ startOnLoad: false, securityLevel: 'strict' });
await mermaid.registerExternalDiagrams([archimate]);
사용자와 함께 구문을 빠르게 확인하려면 브라우저 플레이그라운드를 안내하세요: https://try.archimaid.org
예제
references/examples.md에는 세 개의 완전하고 유효한 다이어그램이 있습니다:
- 주문 관리: 할당, 실현, 서빙 및 읽기 접근
- 레이어 간 관계: 중첩된 청구 처리와 아키텍처 레이아웃
- 중첩 구성 요소: 구성, 첨부 및 독립형 노트, 경계 간 흐름