Community画像github.com

Archimaid

ArchiMate® 3.2 図をテキストで作成、検証、レンダリングします。ユーザーが ArchiMate 図やエンタープライズアーキテクチャビューを要求した場合、または `archimate-beta` で始まる `.mmd` ファイルや Markdown の mermaid ブロックを編集する場合に使用します。

Archimaid とは?

Archimaid は、Mermaid に ArchiMate 3.2 を `archimate-beta` 図タイプとして追加するツールです。開発者はプレーンテキストで図を作成し、`archimaid` CLI を使用して検証し、SVG にレンダリングできます。このスキルは、エンタープライズアーキテクチャのビュー(ビジネス、アプリケーション、テクノロジー層、ケイパビリティ、モチベーション)をモデル化する際に特に有用で、`archimate-beta` 構文を使用して要素、リレーションシップ、ネスト、メモを宣言します。検証ではエラーを報告し、レンダリングには Playwright Chromium が必要ですが、ブラウザ上のプレイグラウンド(https://try.archimaid.org)でも構文を素早く確認できます。現在、GitHub や GitLab などのホストはプラグインを登録しないため、SVG をコミットして埋め込む必要があります。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Archimaid/claude-plugin/tree/HEAD/skills/archimaid

Installed? Explore more 画像 skills: steipete/songsee, affaan-m/frontend-design, mattpocock/improve-codebase-architecture · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

プレビュー

スキル README より

タイトル

ドキュメント

Archimaid は何をしますか?

Archimaid は、Mermaid に ArchiMate 3.2 を archimate-beta 図タイプとして追加します。図をプレーンテキストで記述し、archimaid CLI でチェックして、SVG にレンダリングします。

ワークフロー

  1. ビューに必要な ArchiMate 要素とリレーションシップを決定します。モデルは、ノートではなく要素タイプとリレーションシップで意味を表現します。
  2. .mmd ファイル、または Markdown のフェンスで囲まれた mermaid ブロックに図を記述します。
  3. 検証してすべてのエラーを修正し、再度検証します。
    npx --yes archimaid validate path/to/diagram.mmd
    
    標準入力の検証には - を使用します。問題は file:line:column: message として出力されます。警告は warning: で始まり、実行は失敗しません。
  4. ArchiMate 3.2 がソースとターゲットタイプ間の各リレーションシップを許可しているか確認します(付録 B)。バリデーターはまだこれをチェックしません。
  5. GitHub Markdown など、ターゲットホストがプラグインを読み込めない場合は SVG をレンダリングします(「レンダリング」を参照)。

構文

archimate-beta で始め、各行に 1 つの宣言を記述します。

archimate-beta
  direction LR
  accTitle: Order management
  accDescr: The order management suite contains a billing component.

  element applicationComponent suite "Order management suite" {
    element applicationComponent billing "Billing"
  }
  description billing "Handles invoicing."
  click billing href "https://wiki.example.com/billing" "Open the billing runbook"

  suite *-- billing
  note review "Confirm retry behaviour" on suite
  • 要素: element <type> <id> "名前"。60 のタイプキー(businessProcess、applicationComponent、node など)は references/reference.md にリストされています。キーがわからない場合はいつでも参照してください。
  • ID: 一意で、文字またはアンダースコアで始まり、文字、数字、アンダースコア、ハイフンを含みます。
  • 文字列: JSON 形式の二重引用符で、空にしないでください。改行には \n を使用します。長い名前は自動的に折り返されます。
  • アクセシビリティ: 常に accTitle: を追加します。accDescr: または複数行の場合は accDescr { … } を追加します。
  • フロントマター: --- 行で囲まれた YAML ブロックを先頭に記述できます(例: config: { theme: dark })。

リレーションシップ

省略形: <source> <connector> <target>。オプションで : "ラベル" を付けます。左側のエンドポイントは常にモデルのソースです。

コネクタリレーションシップ
*--構成
o--集約
@==>割り当て
`..>`
-->サービス提供
.. / <.. / ..> / <..>アクセス: 未指定 / 読み取り / 書き込み / 読み書き
-.->影響
--- / --/関連: 無方向 / 方向付き
==>トリガー
-.=>フロー
`-->`
  • manage <.. order は manage が order を読み取る ことを意味します: アクセス側は左側にあります。
  • 文の先頭にある ID は o-- グリフとして読み取られません。o o-- b のように記述し、o--b とは記述しません。
  • 同一の省略形の行を繰り返さないでください。
  • 長形式: relationship <type> <id> <source> -> <target>。オプションで access read|write|readWrite|unspecified または directed を続け、次に label "テキスト" を続けます。他の宣言がリレーションシップの ID を参照する必要がある場合は、長形式を使用します。

ネスト

  • element … { と } の内側に子を宣言し、各行に 1 つずつ記述します。ブロックはネストでき、要素、説明、リレーションシップ、ノート、nest、click を含めることができますが、図の設定は含めません。
  • ネストにはリレーションシップは必要ありません。子と親の関係をサポートするリレーションシップが 1 つだけの場合、その囲みがそれを表し、その行は非表示になります。構成、集約、割り当て、実現、アクセスは親から子へ向かいます。特殊化は子から親へ向かいます。
  • nest <child> in <parent> [via <relationshipId>] が行形式です。複数のリレーションシップがネストをサポートする可能性がある場合は via を使用します。各子は 1 つの視覚的な親を持ち、ネストはサイクルを形成してはいけません。

ノートとリンク

  • note <id> "テキスト" はスタンドアロンのノートを宣言します。on <elementId> を追加して要素に添付します。ノートはリレーションシップのエンドポイントになることができます。
  • 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 を埋め込みます: ![タイトル](diagram.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 には、完全で有効な 3 つの図が含まれています。

  • 注文管理: 割り当て、実現、サービス提供、読み取りアクセス
  • クロスレイヤーリレーションシップ: ネストされた請求処理を含むアーキテクチャレイアウト
  • ネストされたコンポーネント: 構成、添付ノートとスタンドアロンノート、境界を越えたフロー

関連スキル