ドキュメントを成果物要素として生成

ドキュメント出力定義要素やドキュメント定義パッケージから生成できるドキュメントを、成果物要素の付属ドキュメントとして生成・格納できます。この方法により、ドキュメントをファイルとしてではなく、対象のプロジェクトの内部に格納できます。これにより、ドキュメントも含めて共有したいような場合に便利です。

この機能を利用する場合には、まず以下のいずれかを作成する必要があります。

まず、対象の要素の単独で希望するドキュメントが正しく生成されることを確認してください。

成果物要素を作成する手順:

操作方法

対象のドキュメント定義パッケージあるいはドキュメント出力定義要素をダイアグラム内で選択します。

選択すると右上にクイックリンクのためのアイコンが表示されます。ダイアグラム内で他の要素がない箇所までドラッグし、表示されるメニューから「共通 | 成果物」を指定します。

必要に応じて、成果物要素の名前を設定してください。

ドキュメントを生成する手順:

#	操作方法
1	成果物要素を右クリックし、「ドキュメントを生成し付属ドキュメントに格納」を選択します。ドキュメントの生成ダイアログが表示されます。
2	ダイアログ内の設定は、関係するドキュメント定義パッケージあるいはドキュメント出力定義要素の設定が自動的に反映されます。必要に応じてその他の設定を変更し、生成を実行します。
3	ドキュメントの生成が完了すると、対象の成果物要素の付属ドキュメントとして格納されます。

注意:

ドキュメント内に付属ドキュメントの内容を出力するようなテンプレートの場合には、対象の成果物要素自身の内容が出力されないように注意してください。