配置図テンプレート（書き方とサンプル例）

こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
配置図のテンプレートと例文をご紹介します。

配置図とは？

UMLの配置図は、システムの物理的・ソフトウェア的側面からシステムの構成を図示化したダイアグラムになります。コンポーネント図に似ていますが、コンポーネント図がソフトウェア的側面から図示化されるのに対して、配置図ではどのシステムで成果物が作成され、利用されるのかも表現されます。

配置図によって、よりコンポーネント間の連携や関連性が分かりやすくなります。

WEB上で簡単に配置図の作成・管理を行えるツール「NotePM」

配置図の目的

配置図はハードウェアや、その中で稼働するコンポーネントが可視化されます。それによってシステムの全体像が分かりやすくなります。また、成果物も図示化されるので、各コンポーネントで作成される成果物とその利用用途も明確になります。

現在、システムはハードウェアやコンポーネント含めて複雑に連携しています。あるシステムの修正が思わぬ場所で不具合を起こすことも少なくありません。全体像と関連性が明確になることで、そうした不具合の発生を未然に防げるようになるでしょう。

配置図の書き方

配置図で使われる構成要素は次の通りです。

ノード

ノードにはデバイス（ハードウェア）と実行環境（OSやミドルウェア）に分かれます。基本的にハードウェア、ミドルウェア、ソフトウェアといった階層構造で表現されます。

ノードは基本的に四角で、 <<種類>> と記述します。しかし、PlantUMLではノード自体の形を指定できます。

使い方としては次のようになります。

component ラベル

幾つかのコンポーネントについては省略表記も用意されています。

入れ子

前述の通りコンポーネントは入れ子で表現されることが多いです。その場合には次のように表記します。

cloud データベースサーバー  {
 database データベース
}

成果物

成果物はラベルとして <<artifact>> と明記し、その下に成果物名を記述します。PlantUMLの場合は artifact 成果物名 として定義します。

関連・通信経路

ノード同士を関連付けます。その際、通信経路の種別を記載します。例えばODBC、TCP/IPなどになります。ノードを用意したら、それぞれを -- などで結びます。

WEB上で簡単に配置図の作成・管理を行えるツール「NotePM」

配置図のサンプル例

以下は一般的なWebアプリケーションの構成を配置図で示したものになります。

component クライアント {
  component Webブラウザ
}
component Webサーバー {
  component nginx
}
component アプリケーションサーバー1 {
  component Docker1 {
    component Railsアプリケーション1
  }
}
component アプリケーションサーバー2 {
  component Docker2 {
    component Railsアプリケーション2
  }
}
component データベースサーバー {
  component Ubuntu {
    database MySQL
  }
}

Webブラウザ--nginx: n TCP/IP 1
nginx--Railsアプリケーション1
nginx--Railsアプリケーション2
Railsアプリケーション1--MySQL
Railsアプリケーション2--MySQL

実際の描画結果は次の通りです。