工具輔助: 使用 Rational SoDA 建立軟體架構文件
這項工具輔助說明如何使用 Rational SoDA 來建立軟體架構文件。
工具: Rational SoDA
主要說明

概觀

SoDA 會自動化產生報告,以便更快、更準確建立報告。您可以利用 SoDA 的 Microsoft® Word® 或 Adobe® FrameMaker® 版本來產生軟體架構文件。為了建立這份報告,SoDA 會從 Rational Rose 模型中,收集含架構重要性的各方面資料。只有在模型遵循 Rose 模型的結構和命名慣例時,這才能夠運作。

相關的 Rational Unified Process 資訊:

當執行 Windows 2000、NT 4.0、Windows XP、Solaris 或 HP-UX 時,適合使用這項工具輔助。

如果要利用 SoDA 來建立軟體架構文件,請使用您的產品版本適用的程序:

使用 Rational SoDA/Word 來產生軟體架構文件

  1. 從 Rational Rose 中的任何位置,按一下報告 > SoDA 報告
  2. 當 SoDA 中顯示可用的報告清單時,請選取 Rational Unified Process 軟體架構文件
  3. 按一下確定來產生報告。

使用 Rational SoDA/FrameMaker 來產生軟體架構文件

  1. 從 FrameMaker 按鈕列中,按一下新建。按兩下 SoDA,再按兩下 RoseDomain,選擇 RUPSoftwareArchitectureDocument.fm 範本。
  2. 編輯連接器,輸入模型的名稱。
  3. 按一下檔案 > 另存新檔,將範本儲存到個人或專案目錄中。
    您可以變更範本名稱來反映使用案例的名稱;例如,ConductTransactionsReport.fm。
  4. 按一下 SoDA > 產生文件
  5. 審查產生的文件。

您下次想要產生這份相同的文件時,您只需要開啟文件,再按一下 SoDA > 產生文件

Rose 模型的結構和命名慣例

Rose 模型的範例結構。 以下列出 SoDA 從 Rose 模型中擷取出來,以便併入軟體架構文件的圖:
  • 含架構重要性的使用案例和參與者會顯示在文件的「使用案例視圖」區段中。
  • 含架構重要性的類別、介面、套件和子系統會顯示在文件的「邏輯視圖」區段中。
  • 代表設計模型中各個層次的套件會顯示在文件的「邏輯視圖」區段中。
  • 「流程視圖」套件中的任何圖解都會顯示在文件的「流程視圖」區段中。
  • 「實作模型」套件中的任何圖解都會顯示在文件的「實作視圖」區段中。
  • 「部署視圖」中的任何圖解都會顯示在文件的「部署視圖」區段中。