ドキュメントグループ

項目

説明

ドキュメント

ドキュメント要素とは、documentというステレオタイプを持つ成果物要素です。ドキュメント要素は、ツールボックスの「ドキュメント」・「SysML」・「Zachman Framework」のいずれかのグループで作成できます。RTF ドキュメントまたは CSV ファイルと関連付けることができます。

要素をダブルクリックすると、ドキュメントエディタが表示されます。ドキュメントが作成されると、ダイアグラム上のドキュメント要素の右上にアイコンが表示されます。

(参考:付属ドキュメント、クイックリンクの定義をプロファイルに追加)

カスタムドキュメント

カスタムドキュメント要素は、ドキュメント要素の一形態ですが、ドキュメント要素は要素に固有の静的なドキュメント情報を保持しているのに対し、カスタムドキュメントは、ドキュメントの内容をモデル内の他の要素やダイアグラムを利用して定義し、内容を自動的に更新できます。カスタムドキュメントの機能を利用すると、その内容を保持するためのカスタムドキュメント要素が、機能を実行した際のパッケージに生成されます。

カスタムドキュメントは、要素やダイアグラムを利用してドキュメントの内容を定義し、ドキュメントを開くたびに、リンクされている要素やダイアグラムの内容を元にコンテンツが動的に更新されます。

カスタムドキュメントには3種類のコンテンツがあります。

• ドキュメントテンプレートに含まれる内容
• パッケージ・ダイアグラム・要素・属性や操作など、モデルブラウザからドキュメントにドラッグされた項目
• ドキュメントに直接入力した静的な内容

例えば、ドキュメント内でダイアグラムの画像が必要な箇所や、モデル内に存在する要素の一覧が必要な箇所では、これらの項目をモデルブラウザからドラッグ＆ドロップで追加できます。これらの項目がどのように描画されるかは、指定したドキュメントテンプレートによって決まります。

暗号化ドキュメント

暗号化ドキュメント要素は、保持するドキュメントの内容が自動的に暗号化され、パスワードを入力しないとEnterprise Architect内で開くことができません。パスワードを割り当てて簡単には参照させないような、保護した機密情報を記録できます。

ツールボックスのドキュメントグループから暗号化ドキュメント要素をダイアグラムにドラッグすると、パスワードを入力する画面が表示されます。パスワードを入力すると、保持するドキュメントを作成できます。その後、ユーザーがドキュメントを開こうとするたびに、パスワード入力画面が表示されます。ユーザーが最初に指定したパスワードを入力しない場合、ドキュメントを開くことはできません。正しいパスワードが提供された場合のみ、ドキュメントは復号化されて表示されます。

暗号化ドキュメント要素は、ツールボックス・ダイアグラム・モデルブラウザでは、通常のドキュメント要素とは異なるアイコンが表示されます。

(参考:付属ドキュメント)

ドキュメント生成

ドキュメント生成要素は、ドキュメント生成機能における設定を保持する要素です。これにより、特定の設定でドキュメントを生成する場合に効率よく実行できます。

ドキュメント生成要素を作成した後は、要素をダブルクリックするだけで、ドキュメントの生成ダイアログが表示され、保存してある設定が復元されます。そのままドキュメントを生成することも、設定を変更して出力できます。

(参考:ドキュメントの生成ダイアログ)

リーディングリスト

リーディングリスト要素は、タスクやプロセスにとって特に重要な情報を含む要素の一覧を提供します。リーディングリストに追加した要素の一覧を、ドキュメントサブウィンドウで表示させることを想定しています。

ユーザーストーリー

ユーザーストーリー要素は、エクストリームプログラミング(XP)などのアジャイル手法において、ビジネスユースケースを文書化するための手段を提供するものです。要素の付属ドキュメントにおいてビジネスシステムが提供しなければならない機能を、要求の「誰が」「何を」「なぜ」を明確にして記述します。ユーザーストーリー要素は、ドキュメント要素と同じ動作となります。ドキュメントの作成時には、ドキュメントのベースとなるドキュメントテンプレートを選択する画面が表示されます。

ドキュメント出力定義

ドキュメント出力定義要素は、モデル内のパッケージを指定し、ドキュメントを生成できます。モデルブラウザの構成に依存しないドキュメントの生成に利用します。