レビュードキュメントの作成

<< 目次を表示 >>

ページ位置:  Enterprise Architectの操作 > 仕様ビュー >

レビュードキュメントの作成

チーム内の仕事を管理している場合、チームメンバーが要素に行う作業を調整・ガイドする仕組みがあると大変便利です。これはレビュードキュメントなどの仕様パッケージで作成することができます。仕様ビューからこの種類のドキュメントを素早く簡単に生成することができます。このドキュメントはチームライブラリ機能から配布・接続・確認してください。

 

生成できるレビュードキュメントには、大きく分けて 2つの種類があります。

 

 

どちらのドキュメントも、テンプレートから生成することができます。テンプレートを使わずにドキュメントを作成することも可能です。テンプレートは、レポート生成機能 (仕様ドキュメント)・付属ドキュメントエディタ (管理ドキュメント) から利用できます。

 

仕様ドキュメントは、選択されたテンプレートにより、仕様ビューから自動的に情報を構成します。テンプレートに自動的に情報が入るので、編集する必要はありません (後に編集を加えることは可能です)。そのため、自動生成ドキュメントと呼ばれています。

 

既定値では、レビュードキュメントは公式レビューというチームライブラリの特別なカテゴリにあるフォルダ (トピック) に格納されています。チームライブラリ内であれば、ドキュメントの作成はどこからでも可能です。仕様パッケージをチームライブラリのフォルダに結びつけることが、パッケージに最適の方法です。

例えば、チームライブラリ内にモジュール構造がある場合、チームライブラリと同じセクションに仕様パッケージで利用するレビュードキュメントを保持することになります。フォルダにはそのパッケージを含むモデルの一部に関する投稿・ディスカッション・ドキュメントが入っています。

 

 

利用手順:

リボン

ホーム > チーム設計 > チームライブラリ

 

 

レビュードキュメントの作成

トピック

説明

名前

レビュードキュメントダイアログで、ドキュメントの名前を入力します。

チームライブラリフォルダで利用するドキュメントの名前です。

テンプレート

ドロップダウンリストをクリックし、いずれかを選択してください。

  • なし。テンプレートを利用せず、自由に作成。
  • ドキュメントのテンプレート名を指定し、テンプレートを利用します。

OK

このボタンをクリックし、ドキュメントエディタでドキュメントを開きます。テキスト・画像を入力し、体裁を整えて印刷できます。

 

同時に:

  • チームライブラリサブウィンドウが開きます。
  • 公式レビューカテゴリがチームライブラリに作られます (まだ作られていない場合)。
  • 仕様パッケージと同じ名前のフォルダが、公式レビューカテゴリに作られます (まだ作られていない場合)。
  • レビュードキュメント名がこのフォルダに追加されます。

 

パッケージを別のチームライブラリフォルダ (以下参照) に結びつけた場合、公式レビューカテゴリの下ではなく、結びつけたフォルダにレビュードキュメントが作成されます。

 

 

ドキュメントの自動生成

トピック

説明

名前

レビュードキュメントダイアログで、ドキュメントの名前を入力します。

チームライブラリフォルダで利用するドキュメントの名前です。

テンプレート

ドロップダウンリストをクリックし、システム-テンプレート名の レポートを選び、ドキュメントを作成してください。

OK

このボタンをクリックし、レポート生成を通してドキュメントを生成します。仕様ビューで現在表示されている情報を、レポートテンプレートのパラメータ内に収まる範囲で表示します。

 

同時に:

  • チームライブラリサブウィンドウが開きます。
  • 公式レビューカテゴリがチームライブラリに作られます (まだ作られていない場合)。
  • 仕様パッケージと同じ名前のフォルダが、公式レビューカテゴリに作られます (まだ作られていない場合)。
  • レビュードキュメント名がこのフォルダに追加されます。

 

編集が必要な場合には、チームライブラリタブからドキュメントを表示してください。ドキュメントは生成された時点から利用可能です。

パッケージを別のチームライブラリフォルダ (以下参照) に結びつけた場合、公式レビューカテゴリの下ではなく、結びつけたフォルダにレビュードキュメントが作成されます。

 

 

パッケージをチームライブラリのトピックと関連づけ

#

操作方法

1

リンクのトピック選択ダイアログで、希望カテゴリ名の横にある展開ボタンをクリックし、トピックフォルダを表示します。

2

トピックフォルダ名をクリックします。

3

OK ボタンをクリックします。

補足:

  • レビュードキュメントを作成したときには、選択されたトピックのフォルダに自動的に格納されます。
  • 「現在のレビューフォルダ」オプション を選択したときには、チームライブラリサブウィンドウが開き、選択されたフォルダ名が選択表示され、展開されます。
  • 「現在のレビュー」オプション を選択したときには、選択されたフォルダ内のドキュメントをサブメニューが表示します。

 

 

注意:

  • 仕様パッケージからは、必要なだけレビュードキュメントを生成できます。
  • 仕様ビューからレビュードキュメントを生成する前に、スペルチェック機能で仕様パッケージ内のスペルを確認できます。

 

 

参照: