IBM® Rational® SoDA® との統合の主な機能は、Rational UML モデリング製品から情報を検索し、
その情報を使用してカスタマイズされた文書を生成し、Microsoft® Word を使用してレポートを生成することです。SoDA は、Software Documentation Automation の頭字語です。
SoDA は、ご使用のプロジェクト・ソフトウェア・ツールから情報を検索して、プロジェクト文書を公開することのできる、柔軟で堅牢な文書化ツールです。SoDA が提供する定義済み UML モデリング製品テンプレートを使用することも、特定のニーズに合わせてテンプレートをカスタマイズすることもできます。
SoDA との統合機能を使用する前に、IBM Rational SoDA for Word バージョン 2003.06.14 に「SR4 ホット・フィックス」を適用するか、それ以降のバージョンをインストールする必要があります。
それがまだ完了していない場合は、
http://www.ibm.com/software/awdtools/soda/support/ にアクセスして、コピーの入手とインストールに関する情報を参照してください。
機能の重複を回避するため、事実上すべての文書とレポートの生成は、SoDA 製品内から実行します。
Rational SoDA for
Word を使用するには、次のようにします。
- 以下のステップを実行して、UML モデリング製品内の Common Reporting SoDA との統合機能を使用可能にします。
注: SoDA との統合機能はデフォルトで使用可能に設定されています。
- をクリックします。
- 「設定」ウィンドウで「共通レポート作成」をクリックします。
- 右側に開くページで、「SoDA Integration を使用可能にする」チェック・ボックスを選択します。
- 「適用」をクリックして設定の変更を継続するか、「OK」をクリックして保管して終了します。
これで、SoDA との統合機能がオンになり、文書レポート生成ツールの使用を開始できるようになりました。
注: SoDA レポートを生成するには、UML モデリング製品を実行する必要があります。
- 次に、をクリックして、SoDA を開始します。
- 「始めに: 概要 (Getting Started: Introduction)」ウィンドウで、「次へ」をクリックします。
- 「テンプレートの選択」ウィンドウに使用可能なテンプレートがすべてリストされます。rsa¥ テンプレートのリストが表示されるまでスクロールダウンします。
文書を生成したい情報を反映するテンプレート名を選択して、「次へ」をクリックします。
- 生成した文書の名前とロケーションを指定して保管するための「テンプレートの保管」ウィンドウが開きます。
「参照」をクリックして、ファイルの名前とロケーションを選択するか、パスとファイル名を入力し、「次へ」をクリックします。
「レポートの生成」ウィンドウで、「生成」をクリックしてレポートの作成を開始します。
Microsoft Word が開いて、生成されたレポートが表示されます。SoDA の使用に関する詳細なヘルプについては、ツールバーからをクリックして、詳しい SoDA オンライン・ヘルプを表示してください。