How to
PlantUML 記法の下書きとプレビュー確認を同じ画面で進めるためのツールです。シーケンス図やクラス図の構造を確認したい時に向いています。テーマ切り替えと複数ページ管理にも対応しているため、図の比較や下書き整理にも使えます。
Use Cases
Capabilities
Steps
画面を見ながら進められるように、操作の順番と確認ポイントをまとめています。
STEP 1
左側の入力欄へ PlantUML 記法を書き込みます。複数ページを切り替えながら下書きを並行管理できます。
シーケンス図やクラス図の記法を直接入力し、そのままプレビューへ反映できます。
現在の PlantUML 記法を空にして、最小構成から書き直せます。
作成中の PlantUML 記法をそのままコピーして、仕様書やメモへ貼り付けられます。
STEP 2
右側のプレビューを確認しながらテーマを切り替え、SVG / PNG のコピーやダウンロードを使い分けます。
背景や線色の見え方を確認しながら、共有先に近いテーマへ切り替えられます。
描画結果を確認し、SVG として再利用できる状態かを見極められます。
構文や接続に問題がある場合は、プレビュー面で原因を確認しながら修正できます。
Notes
使う前に確認しておくと迷いにくいポイントを、理由つきでまとめています。
確認すること
要素を一度に増やすと、構文ミスと接続ミスの切り分けが難しくなります。まずは短いシーケンスやクラス関係だけで表示を確認すると進めやすいです。
確認すること
編集前提なら SVG、チャットや資料へ貼るなら PNG というように、出力形式を先に決めると手戻りが減ります。
確認すること
PlantUML のプレビューはネットワーク接続が必要です。接続がない場合はプレビューが表示されません。オフライン環境では使えません。
FAQ
使う前に判断しやすい質問を先に整理します。
PlantUML 記法を前提に UML 図を扱いたい時に向いています。Mermaid とは別の記法として、文書ごとに切り替えて使えます。
プレビュー engine の接続状況に応じて SVG と PNG のコピーや保存に対応します。未接続時はプレビュー面にエラーを表示します。
シーケンス図、クラス図、状態遷移図、ユースケース図、ガントチャートなど PlantUML の主要な図に対応しています。
PlantUML の公式ドキュメントに種類別の記法が記載されています。このページで記法を入力しながら図を確認できます。
SVG または PNG でダウンロードするかクリップボードにコピーして共有してください。
PlantUML のプレビューは外部サーバーへの接続が必要です。接続がない場合はプレビューが表示されません。
次に見る使い方
関連する使い方を続けて見られるように、次に確認しやすい導線をまとめています。
