UML変換ツールを使ってシーケンス図をテキストベースで管理しよう

目的

Visioで作成したシーケンス図は追加後に番号を振りなおしたり、複数人で更新するのに手間がかかります。
テキストベースでシーケンス図を作図できるツールを使うと、バージョン管理システムと相性がよく管理がしやすくなります。

オンラインで使えるもの

ブラウザー上でシーケンス図を編集するツールです。
オンラインであれば、どこでも編集可能になります。

a-1. websequencediagrams

PlantUMLがベースのツールですが、シーケンス図に特化して追加で簡略した表記が使えたり、拡張した表現が可能です。

特徴
  • 日本語対応
  • リアルタイムに入力が作図される
  • ダイアグラムの補助入力あり
  • 有料会員になると追加機能がある

a-2. PlantUML Server

フォームに入力したテキストファイルを変換してくれるだけのツールです。
シーケンス図以外にもPlanetUMLのフル機能が使えますが、リアルタイム性はありません。
オンライン用PlanetUMLも使いたいなら、websequencediagramsで作成したテキストがPlantUMLと互換の範囲で作成しているか、さっと確認するのに使えます。

特徴
  • 日本語対応
  • フォームにポストしてダイアグラムの表示が行われる。
  • シーケンス図以外のUML図も作図可能。

オフラインで使えるもの

オフラインで作図結果を見ながら編集できるエディターです。

b-1. PlantUML QEditor

PlanetUMLのフル機能が使えます。

特徴
  • Windows版は、エディター部分が日本語未対応
  • オフラインで日本語が必要なら、PlantUML Editorを利用する。
  • OSX対応のソースコードあり(未調査)

b-2. PlantUML Editor

同じくPlanetUMLのフル機能が使えます。

特徴
  • .NET Frameworkを使ったWindows用のツール
  • 設定が必要だが、UTF-8ベースの日本語対応可能
  • GraphVizのインストールが必要(PlantUML QEditorを先にいれるとスムーズ)
  • シーケンス図以外のUML図も作図可能

PlantUML Editorのインストール

PlanetUML Editorのインストール方法です。

0. 準備

GraphVizが必要なので一括導入できる、まずPlantUML QEditorをダウンロードして、インストール。

1. ダウンロード

PlantUML Editorをダウンロード

2. インストール

ダウンロードしたexeファイルをダブルクリックして、インストール

3. plantuml.jarの設定

plantumlが必要になるため、ダウンロードして、
C:\Program Files\Omar AL Zabir などに置いておく。

4. 日本語入力設定

日本語対応のために、起動スクリプトを設定
C:\Program Files\Omar AL Zabir\PlantUMLEditor フォルダに

_PlantUmlEditor.cmd を作成する

set JAVA_TOOL_OPTIONS=”-Dfile.encoding=UTF-8″
@echo C:
@echo cd \Program Files\Omar AL Zabir\PlantUMLEditor
start PlantUmlEditor.exe

5. _PlantUmlEditor.cmdを実行

_PlantUmlEditor.cmdのアイコンをダブルクリックして実行する。
最初の起動時に、plantuml.jarの場所を聞かれるので、ファイルを指定する。

参考