ドキュメントの生成手順

Enterprise Architectでは、簡単な処理でドキュメントを作成できます。ドキュメントは、プロジェクトのパッケージを基本単位としています。ドキュメントを作成するためには、モデルブラウザ・パッケージブラウザ・検索ビューで対象の要素やパッケージを選択します。

パッケージを選択した後に、コンテキストメニューからドキュメントダイアログを起動し、文書の詳細設定をできます。次のページではリッチテキスト形式のドキュメントを生成する方法を説明します。

ドキュメントを出力する場合には、さまざまなオプションを指定できます。このオプションの設定で、出力される対象や内容を調整できます。

ドキュメントには、モデル内のパッケージや要素などの情報が出力されます。多くの場合にはパッケージが基準になるので、最初に、ドキュメント出力対象のパッケージを決める必要があります。また、パッケージを対象に出力する場合には、パッケージ内の個々のダイアグラムに対して、出力対象に含めるかどうかの設定も可能です。その後、パッケージを選択した状態でドキュメントの出力ダイアログを開いて下さい。

利用手順:

ドキュメントの出力対象となるパッケージを選択し、以下の操作を実行します。

リボン	生成・入出力 > ドキュメント > DOCX/PDF > ドキュメントの生成
モデルブラウザのツールバー	\| ドキュメント \| ドキュメントの生成
キーボード	F8

この機能を試してみる方法として、サンプルプロジェクトに対して出力する方法の説明を後述しています。

項目

説明

ドキュメントの生成ダイアログを開くには

ドキュメントの生成ダイアログを開く方法は、上記の「利用手順」をご覧下さい。

ダイアログ内での操作については、「ドキュメントの生成ダイアログ」のページをご覧ください。

パッケージブラウザや検索ビューからドキュメントを生成する

パッケージブラウザや検索ビューからドキュメントの生成機能を呼び出した場合には、要素単位でのドキュメント生成が可能です。この方法を利用すると、次のようなドキュメントの生成ができます。

出力対象となる要素の種類を限定する
同じパッケージに含まれていない要素をまとめて出力する

例えば、テスト項目が定義されている要素をまとめてドキュメントに出力したいが、その要素がさまざまなパッケージに分かれているような場合を考えます。このような場合には、検索ビューで指定した条件に合致する要素を表示させ、その要素を選択してドキュメントの生成を行います。

なお、検索結果は要素の単位でのみ表示されますので、特定の条件のテスト項目を検索するルールを作成して実行し、その結果からドキュメント生成したとしても、検索条件を満たす要素が保持する、対象の条件に合致しないテスト項目もドキュメント出力の対象になります。

要素一覧からは、対象の要素を自由に選択した状態で右クリックし、ドキュメントの生成機能を呼び出せます。この場合には、選択した要素のみが含まれるドキュメントを生成できます。

クイックスタート

ドキュメントの機能をとりあえず試してみる場合の手順は次の通りです。:

#	操作方法
1	対象のプロジェクトを開きます。
2	対象のパッケージを選択します。
3	上記の利用手順に従って、ドキュメントの生成ダイアログを表示します。なお、パッケージに含まれる要素やパッケージが多い場合には、出力時間がかかります。
4	「出力ファイル名」の欄に、出力するファイルの名前と位置を指定します。また、出力形式に応じたファイルの拡張子(pdf, rtf, docxのいずれか)をファイル名に追加してください。
5	「テンプレート」の欄では、「(基本テンプレート)」を選択します。目次・スタイルシート・表紙についても、それぞれテンプレートを指定します。
6	生成ボタンを押します。
7	ドキュメントの生成が完了したら、表示ボタンを押します。

ヒント:

特定のパッケージを出力の対象外にできます。詳細は「ドキュメント対象パッケージの設定」のページをご覧ください。

参照: