ドキュメント生成について

Enterprise Architectでは、作成したモデルの情報を「RTFドキュメント」「HTMLドキュメント」の2種類の形で出力することができます。ここでは、それぞれの形式の概要について説明します。

なお、ダイアグラム内の要素を(複数)選択してCtrl+Cでコピーし、Microsoft WordやExcelなどで「貼り付け」することができます。この場合には画像として貼り付けられ、画像を編集することはできません。この方法では作成した図の内容を簡単に利用することができますので、便利です。

RTFドキュメント

このRTFドキュメントの出力機能は、いわゆる仕様書を作成したモデルから作成する目的で利用することを想定しています。

RTFドキュメントは、Microsoft Word互換の形式です。Wordがインストールされている環境であれば、拡張子.rtfのRTFドキュメントはWordで開かれます。

RTFドキュメントの特徴は、テンプレートを作成することで、さまざまな内容のドキュメントを作成することができる点です。例えば、以下のようなテンプレートを作成することができます。

内部用の仕様書(モデルの作成者情報がある)
外部向けインターフェース仕様書(publicの属性や操作のみをドキュメントに含める)
最終納品用仕様書(会社露語や著作権表記なども自動で含める)
....

従来でもこうしたドキュメントは作成していますが、ドキュメントの自動生成機能を利用することで、1つのモデルを修正するだけで他のRTF(Word)ファイルの修正が不要になります。内容に変更があった場合には、ドキュメントを再生成することで、最新の情報に更新できます。二重管理は不要です。

なお、クラスやアクティビティなどのそれぞれの要素のプロパティ画面で「ノート」(説明)として入力した内容は、そのままドキュメントに出力することができます。ノート欄では文字の色などの書式設定が可能ですので、わかりやすいドキュメントを自動生成することができます。

HTMLドキュメント

HTMLドキュメントの出力機能を利用すると、Webブラウザで簡単にモデルの内容を見ることができるHTML形式のデータを出力することができます。

HTMLドキュメントはいわゆる「3ペイン」の形式になっていて、プロジェクトブラウザと同じ内容のツリーからダイアグラムや要素を選択すると、その概要が表示されます。ダイアグラムはクリッカブルになっていて、ダイアグラム内の要素の情報を参照できます。

HTMLドキュメントもカスタマイズの機能はありますが、RTFドキュメントに比較するとカスタマイズできる範囲・内容は限定されています。

内容	更新日	-
RTFドキュメント出力機能機能ガイド RTFドキュメントの出力機能やテンプレートエディタの機能を詳しく説明したドキュメントです。	2011/12/13	ダウンロード

内容	更新日	時間	-
ドキュメントの生成とカスタマイズ	2011/8/1	5分50秒	再生開始

ドキュメント生成について

RTFドキュメント

HTMLドキュメント

関連する情報