こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
シーケンス図のテンプレートと例文をご紹介します。
シーケンス図とは？
シーケンス図はUMLで作成される図の1つになります。ある処理について、システム間でどのようにデータが送受信されるかを表すために作成されます。
シーケンス図は時系列に沿って書かれるので、データがどのように作成されて、どのように次の処理に流れていくのかが分かりやすくなります。
シーケンス図の目的
シーケンス図はシステムのある処理について、データの流れから可視化します。実際のロジックについては明記せず、詳細設計レベルではありません。しかし、詳細設計に入る前の処理全体像は理解しやすくなります。
ある処理において作成されたデータが、外部システムとどのように関連し合っているのか可視化されます。シーケンス図を意識することで、システム開発時において抜け漏れが発生しづらくなるでしょう。
シーケンス図の書き方
ここではPlantUMLでの描画について解説します。PlantUMLはNotePMの中で利用できる記法になります。
分類子
シーケンス図で利用できる分類子は次の通りです。
| 分類子 | 形 |
|---|---|
| participant | 四角 |
| actor | 人の形 |
| boundary | 境界。丸と縦線 |
| control | 丸を描いた矢印 |
| entity | 丸と下線 |
| database | データベース |
| collections | 重なった四角 |
| queue | 横向きの円柱 |
実際に描画される内容は次の通りです。
番号付け
処理に番号を振ることで、追加説明しやすくできます。
開始番号を指定できます。以下は10からはじまって、次は11になります。
さらにステップ数も指定できます。以下は100からはじまって、10毎にステップ数が繰り上がります。
ヘッダー、フッター、タイトル
図のタイトル、ヘッダー・フッターを指定する場合には次のように記述します。 %page% や %lastpage% を置き換え文字列として定義できます。
ページ送り
長いシーケンス図の場合、 newpage を途中で差し込んで次のページに変更できます。
グループ
処理をグループ化して囲めます。ラベルによって以下を指定できます。
- alt/else
- opt
- loop
- par
- break
- critical
- group
ノート
note を使ってシーケンス図の特定部分に追加の説明を行えます。 note right や note left のように表示場所を指定できます。最後には end note を記述します。
ライフライン
複数の処理にまたがって接続が持続する場合などはライフラインを使って分かりやすく明記できます。この時には activate と deactivate または destroy でバツ印も表示できます。
シーケンス図のサンプル例
以下はシーケンス図の例です。
実際に描画される内容は次の通りです。
