コンポーネント図テンプレート（書き方とサンプル例）

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

マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！

コンポーネント図とは？

クラス図はUML（統一モデリング言語）で描かれる図の一つです。クラス図はオブジェクト指向モデリング、およびオブジェクト指向プログラミングで利用されます。ソースコードにおけるクラスやインタフェースをモデリングし、プロジェクト関係者がシステム構造を理解しやすくなります。

コンポーネント図では主にシステムがどのようなコンポーネントによって構成されており、それらコンポーネントがどのような相互関係になっているかを可視化します。

一般的にシステムは複数のコンポーネントによって成り立っています。それは異なる役割を持ったサーバー群であったり、アプリケーション群、データベースやプロキシサーバーなどです。さらに外部システムが関わる場合も少なくありません。システム規模が大きくなればなるほど、相互関係は複雑になるでしょう。

コンポーネント図ではそうしたシステムの構成要素がどのように関わっているのかを可視化します。それによってシステムの全体像がつかめるようになり、システムのイベントによってどういった相互作用が起こるのかを把握できるようになります。

コンポーネント図では、枠を使ってコンポーネントをグルーピングします。枠には次の種類があります。

package "グループ1" {
  HTTP - [コンポーネント1]
  [別なコンポーネント]
}

node "グループ2" {
  FTP - [コンポーネント2]
  [コンポーネント1] --> FTP
}

cloud {
  [例1]
}

database "MySQL" {
    [売上げ]
    [顧客] --> [売上げ]
}

folder "個人のフォルダー" {
    [ファイル]
}

frame "フレーム" {
    [フォルダー4]
}

コンポーネントを定義した後に #色名 で色を付けられます。

frame "フレーム" #Blue {
    [フォルダー4]
}

コンポーネント間を関連付けるのが矢印です。これはコンポーネントとして定義されている中で行うことも、別途まとめて記述もできます。

この例ではコンポーネント1とFTPを関連付けています。

package "グループ1" {
  HTTP - [コンポーネント1]
  [別なコンポーネント]
}

node "グループ2" {
  FTP - [コンポーネント2]
  [コンポーネント1] --> FTP
}

まとめて定義する場合は、コンポーネントの定義とは別で記述します。

[コンポーネント1] --> FTP

矢印は書き方によって方向や種類が変わります。

さらに . や .. は破線になります。例えば ..> や .> といった具合です。

矢印に説明を付ける場合には : を使います。例えば [コンポーネント1] ..> HTTP : 呼び出す といった具合です。

database "MySQL" {
    [売上げ]
    [顧客] --> [売上げ] : 1:n
}

コンポーネントに吹き出しを付ける場合には note を使います。上下左右、自由に付けられます。

[コンポーネント] as C

note top of C: 上のノート

note bottom of C
  下のノート
  改行もできます
end note

note left of C
  左のノート
  こちらも改行
end note

note right of C: 右のノート

NotePM

NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。

NotePMの特徴