ユースケース図

ユースケース図は、外部のアクターがシステムとどのように相互作用するかを示します。誰が何を行い、システムがどのような機能を提供するかを表現するものです。機能要件の全体像を俯瞰でき、設計の初期段階で関係者の認識を揃えるのに役立ちます。

PlantUML では、アクター、ユースケース、およびそれらの関係をテキストで記述します。図は自動的に生成されます。

すべての図種に共通する機能については、共通コマンド を参照してください。

ユースケース

ユースケースは丸括弧で囲んで使います(丸括弧の対は 楕円に似ているからです)。

usecase キーワードを使ってユースケースを定義することもできます。 as キーワードを使ってエイリアスを定義することもできます。このエイリアスは あとで、ユースケースの関係を定義するために使います。

アクター

アクターは2つのコロンで囲まれます。

actor キーワードを使ってアクターを定義することもできます。 as キーワードを使ってエイリアスを定義することもできます。このエイリアスはあとで、ユースケースの関係を定義するために使います。

後から説明しますが、アクターの定義は必須ではありません。

アクターのスタイルを変更する

アクターのスタイルを、デフォルトの棒人間以外に変更できます:

棒人間 (デフォルト)

Awesome man

[Ref. QA-10493]

Hollow man

[Ref. PR#396]

ユースケースの説明

クオート記号を使うことにより、複数行にわたる説明を記述できます。

また、次の区切り記号を使用できます:

これらのペアで囲んで、その間にテキストを記述することで、区切り記号の中にタイトルを記入できます。

WARNING
 This translation need to be updated. 
WARNING

パッケージ

パッケージを使用して、アクターやユースケースをグループ化できます。

rectangleを使用するとパッケージの見た目を変更できます。

簡単な例

アクターとユースケースを繋げるには --> 矢印を使います。

矢印に使うハイフン - の数を増やすと矢印を長くできます。 矢印の定義に : を使うことにより矢印にラベルをつけることができます。

以下の例では User は定義なしにアクターとして使われています。

継承

もしアクターやユースケースが継承をする場合には、 <|-- 記号を使います。

ノートの使用方法

オブジェクトに関連のあるノートを作成するには note left ofnote right ofnote top ofnote bottom of キーワードを使います。

または note キーワードを使ってノートを作成し、 .. 記号を使ってオブジェクトに紐づけることができます。

ステレオタイプ

<<>> を使い、アクターとユースケースを定義中にステレオタイプを追加できます。

矢印の方向を変えるには

デフォルトでは、クラス間の線は2個のハイフン -- で表され、縦方向につながります。横方向の線を描くには以下のようにハイフン1つかドット1つを書きます。

線を反対にすることでも方向を変えることができます。

矢印の内側に leftrightupdown を書くことによっても線の方向を変えられます。

例えば、 -down- ではなく -d- など、各方向の頭文字、または頭2文字( -do- )だけ使って矢印を短く記述することも出来ます。

ただし、この機能の使いすぎには注意しましょう。ほとんどの場合、特別なことをしなくても Graphviz がその場にあった表示を選びます。

left to right directionパラメータを使用した場合は、次のようになります:

図を分割する

newpage キーワードは、いくつかのページや画像に図を分割します。

左から右に描画する

デフォルトの作図方向は top to bottom となっています。
作図方向を left to right に変更するには left to right direction コマンドを使います。

_See also 'Change diagram orientation' on [Deployment diagram](deployment-diagram) page._

スキン設定(Skinparam)

ダイアグラムの色やフォントを変更するには skinparam コマンドを使用します。

このコマンドは以下の場面で使用できます。

個別のステレオタイプ付きアクターやユースケースにそれぞれ色やフォントを定義することができます。

WARNING
 This translation need to be updated. 
WARNING

完全な例

ビジネスユースケース

/を加えると、ビジネスユースケースを作成できます。

ビジネスユースケース

ビジネスアクター

[Ref. QA-12179]

矢印の色とスタイルを変更する(インラインスタイル)

個別の矢印ごとにとスタイルを変更するには、次の記法を使用します:

[Ref. QA-3770 and QA-3816] [配置図クラス図の同様の機能を参照]

要素の色とスタイルを変更する(インラインスタイル)

個別の要素ごとにとスタイルを変更するには、次の記法を使用します:

[Ref. QA-5340 and adapted from QA-6852]

Display JSON Data on Usecase diagram

Simple example

[Ref. QA-15481]

For another example, see on JSON page.