uml について
PlantUMLの構文とコードフェンスの形式を案内し、レンダリング可能なUML図を作成するスキルです。標準的な要素や関係に加え、mxgraphアイコンの例も扱います。
主な機能
- 01PlantUMLによる図の記述
- 02図の開始・終了記号とコードフェンスの使用
- 03UML要素と関係の定義
- 04skinparamと色によるスタイル設定
- 05mxgraphアイコンの追加
活用シーン
- 01クラス図とコンポーネント間の関係の作図
- 02AWSまたはKubernetesのアイコンを使った構成図の作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ markdown-viewer/ skills --skill umlインストール後、Claude Code で/umlを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
examples/activity-diagram.mdclass-diagram.mdcommunication-diagram.mdcomponent-diagram.mdcomposite-structure-diagram.mddeployment-diagram.mdinteraction-overview-diagram.mdobject-diagram.mdpackage-diagram.mdprofile-diagram.mdsequence-diagram.mdstate-machine-diagram.mdswimlane-activity-diagram.mdsysml-bdd.mduse-case-diagram.mdstencils/alibaba_cloud.mdandroid.mdarchimate.mdarchimate3.mdarrows.mdatlassian.mdaws.mdaws2.mdaws3.mdaws3d.mdaws4.mdazure.mdbasic.mdbootstrap.mdbpmn.md詳細
UML ダイアグラムジェネレーター
クイックスタート: ダイアグラムの種類を選択 → PlantUML テキストを記述 → 要素と関係を定義 → ```plantuml フェンスで囲みます。
⚠️ IMPORTANT: 必ず
```plantumlまたは```pumlのコードフェンスを使用してください。```textは絶対に使用しないでください。ダイアグラムとしてレンダリングされません。
重要なルール
- すべてのダイアグラムは
@startumlで始まり、@endumlで終わります - 標準の PlantUML キーワードを使用します:
class、interface、abstract、enum、actor、participant、component、node、database、package - 関係は矢印構文を使用します:
-->、<|--、*--、o--、..>、..|> - グローバルなスタイル設定と色には
skinparamを使用します - 個々の要素に特定の色を指定するには
#colorを使用します - ノートには
note left of、note right of、note over、または単独のnote "text" as Nを使用します
UML ダイアグラムの種類
| 種類 | 用途 | 主な構文 | 例 |
|---|---|---|---|
| クラス | クラス構造と関係 | class、interface、<|-- | クラスダイアグラム |
| シーケンス | 時間経過に伴うメッセージのやり取り | participant、->、--> | シーケンスダイアグラム |
| アクティビティ | ワークフローとプロセスの流れ | start、:action;、if/else | アクティビティダイアグラム |
| スイムレーンアクティビティ | スイムレーンを使った複数の役割のアクティビティ | |Lane|、:action; | スイムレーンアクティビティダイアグラム |
| ステートマシン | オブジェクトのライフサイクル状態 | state、[*] --> | ステートマシンダイアグラム |
| コンポーネント | システムコンポーネントの構成 | component、[name]、interface | コンポーネントダイアグラム |
| ユースケース | ユーザーとシステムのやり取り | actor、usecase、(name) | ユースケースダイアグラム |
| デプロイメント | 物理的なデプロイメントアーキテクチャ | node、artifact、database | デプロイメントダイアグラム |
| オブジェクト | 実行時のオブジェクトスナップショット | object "name" as id | オブジェクトダイアグラム |
| パッケージ | モジュール構成 | package "name" | パッケージダイアグラム |
| コミュニケーション | オブジェクト間の連携 | シーケンス構文による番号付きメッセージ | コミュニケーションダイアグラム |
| 複合構造 | クラスの内部構造 | ネストされた port を持つ component | 複合構造ダイアグラム |
| 相互作用概要 | アクティビティとシーケンスの組み合わせ | group、ref over | 相互作用概要ダイアグラム |
| プロファイル | UML の拡張メカニズム | <<stereotype>> ラベル | プロファイルダイアグラム |
Mxgraph ステンシルアイコン
draw-uml は mxgraph.* 構文を使って、9500 以上の mxgraph ステンシルアイコン(AWS、Azure、Cisco、Kubernetes など)に対応しています。デフォルトの色は自動的に適用されるため、fillColor や strokeColor を指定する必要はありません。
ステンシルの完全なリファレンス: stencils/README.md を参照してください。
構文
mxgraph.<namespace>.<icon> "Label" as <alias>
mxgraph.<namespace>.<icon> "Label" as <alias> #color
mxgraph.<namespace>.<icon> <alias>
mxgraph.<namespace>.<icon>— ステンシルの形状キー(例:mxgraph.aws4.lambda、mxgraph.kubernetes.pod)"Label"— 表示テキスト(スペースを含む場合は引用符で囲み、1 語の場合は囲みません)as <alias>— 関係で使用する識別子#color— 色の任意の上書き(例:#FF6600、#LightBlue)
例
@startuml
' Simple icon declaration
mxgraph.aws4.lambda "Lambda\nFunction" as fn
mxgraph.aws4.api_gateway "API GW" as gw
mxgraph.aws4.dynamodb "DynamoDB" as db
gw --> fn
fn --> db
@enduml
@startuml
' Kubernetes architecture with icons
mxgraph.kubernetes.ing "Ingress" as ing
mxgraph.kubernetes.svc "Service" as svc
mxgraph.kubernetes.pod "Pod" as pod
mxgraph.kubernetes.deploy "Deployment" as deploy
ing --> svc
svc --> pod
deploy --> pod
@enduml
@startuml
' Mixing standard UML with stencil icons
node "Cloud" {
mxgraph.aws4.ec2 "EC2" as ec2
mxgraph.aws4.rds "RDS" as rds
}
database "Legacy DB" as legacy
ec2 --> rds
rds --> legacy
@enduml
コメント
Markdown 対応