シーケンス図テンプレート（書き方とサンプル例）

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

ダウンロード ( Markdown )

例文を見る

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

NotePMを詳しく見る　＞

シーケンス図とは？

シーケンス図はUMLで作成される図の1つになります。ある処理について、システム間でどのようにデータが送受信されるかを表すために作成されます。

シーケンス図は時系列に沿って書かれるので、データがどのように作成されて、どのように次の処理に流れていくのかが分かりやすくなります。

シーケンス図の目的

シーケンス図はシステムのある処理について、データの流れから可視化します。実際のロジックについては明記せず、詳細設計レベルではありません。しかし、詳細設計に入る前の処理全体像は理解しやすくなります。

ある処理において作成されたデータが、外部システムとどのように関連し合っているのか可視化されます。シーケンス図を意識することで、システム開発時において抜け漏れが発生しづらくなるでしょう。

シーケンス図の書き方

ここではPlantUMLでの描画について解説します。PlantUMLはNotePMの中で利用できる記法になります。

分類子

シーケンス図で利用できる分類子は次の通りです。

分類子	形
participant	四角
actor	人の形
boundary	境界。丸と縦線
control	丸を描いた矢印
entity	丸と下線
database	データベース
collections	重なった四角
queue	横向きの円柱

実際に描画される内容は次の通りです。

番号付け

処理に番号を振ることで、追加説明しやすくできます。

autonumber

開始番号を指定できます。以下は10からはじまって、次は11になります。

autonumber 10

さらにステップ数も指定できます。以下は100からはじまって、10毎にステップ数が繰り上がります。

autonumber 100 10

ヘッダー、フッター、タイトル

図のタイトル、ヘッダー・フッターを指定する場合には次のように記述します。 %page% や %lastpage% を置き換え文字列として定義できます。

title 図のタイトル
header ページヘッダー
footer %page% / %lastpage%

ページ送り

長いシーケンス図の場合、 newpage を途中で差し込んで次のページに変更できます。

newpage

グループ

処理をグループ化して囲めます。ラベルによって以下を指定できます。

alt/else
opt
loop
par
break
critical
group

ノート

note を使ってシーケンス図の特定部分に追加の説明を行えます。 note right や note left のように表示場所を指定できます。最後には end note を記述します。

note right
    アカウントロックは連続3回認証
    失敗した場合に実行されます
end note

ライフライン

複数の処理にまたがって接続が持続する場合などはライフラインを使って分かりやすく明記できます。この時には activate と deactivate または destroy でバツ印も表示できます。

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

NotePMを詳しく見る　＞

シーケンス図のサンプル例

以下はシーケンス図の例です。

autonumber 10 10
actor Webブラウザ
activate サーバー
Webブラウザ -> サーバー: 認証リクエスト
database データベース as DB

alt 認証成功

    サーバー -> Webブラウザ: 認証成功

else 認証失敗

    サーバー -> Webブラウザ: 認証失敗
    deactivate サーバー
    group サーバー処理
      サーバー -> DB : 失敗回数記録
          loop 3回失敗
              サーバー -> DB: アカウントロック
          end
      サーバー -> Webブラウザ : アカウントロック通知
    end
    note right
      アカウントロックは連続3回認証
      失敗した場合に実行されます
    end note

else 他のシステムエラー

   サーバー -> Webブラウザ: 再度認証実行要求

end

実際に描画される内容は次の通りです。

おすすめの情報共有ツール「NotePM」

NotePM

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

NotePMの特徴

マニュアル作成、バージョン管理、社外メンバー共有
強力な検索機能。PDFやExcelの中身も全文検索
社内FAQ・質問箱・社内ポータルとしても活用できる
銀行、大学も導入している高度なセキュリティ。安全に情報共有できる

URL: https://notepm.jp/

NotePMについて詳しく見る＞