Tool Mentors > Rational SoDA Tool Mentors > Creating a Software Architecture Document Using Rational SoDA

Purpose

This tool mentor describes how to use Rational SoDA to create a Software Architecture Document. SoDA automates the generation of the report so that it is created quickly and accurately. The Software Architecture Document can be generated by SoDA either with the Microsoft Word or Adobe FrameMaker versions of the product. SoDA collects architectural significant aspects from a Rational Rose model and adds those into the Software Architecture Document. This will only work if the Rose model follows the structure and naming convention for the Rose model.

Related Rational Unified Process™ information: Artifact: Software Architecture Document.

Overview

This tool mentor is applicable when running Windows 98, Windows 2000, NT 4.0, or UNIX.

To create a the Software Architecture Document using Rational SoDA, choose one of the following options:

  1. Use Rational SoDA/Word to generate a Software Architecture Document
  2. Use Rational SoDA/FrameMaker to generate a Software Architecture Document

1. Use Rational SoDA/Word to generate a Software Architecture Document To top of page

  1. From Rational Rose, in any context.
  2. Select Report=>SoDA Report.
  3. From the list of available reports, select Rational Unified Process Software Architecture Document. If you do not see that report, cancel and make sure you have a use case selected in your class diagram.
  4. Click OK.
  5. Review the generated report.

2. Use Rational SoDA/FrameMaker to generate a Software Architecture Document To top of page

  1. From the FrameMaker program, select File=>New. Click on SoDA, then the Rational RoseTemplates, then RationalUnifiedProcessSoftwareArchitectureDocument.fm.
  2. Edit the Connector and enter the name of the model file and the name of the use case.
  3. Use File=>Save As to save the template to a personal or project directory. You may wish to change the name of the template to reflect the name of the use case, such as ConductTransactionsReport.fm.
  4. Select SoDA=>Generate Document.
  5. Review the generated document.

The next time you want to generate this same document, simply open the document and select SoDA=>Generate Document.

Structure and naming convention for the Rational Rose model To top of page

Example structure of the Rose model. The following diagrams are extracted from the Rational Rose model by the Rational SoDA template and presented in the appropriate sections of the Software Architecture Document:
  • The use cases and actors which are considered to be 'architecturally significant' should be depicted in the diagram 'Architecturally Significant Use Cases'. They will be presented in the Use-Case View section of the Software Architecture Document.
  • The classes, interfaces, packages and subsystems which are considered to be 'architecturally significant' should be depicted in the diagram 'Architecturally Significant Model Elements'. They will be presented in the Logical View section of the Software Architecture Document.
  • The packages which represent layers in the design model should be depicted (along with any package dependencies) in the diagram 'Architecture Overview - Package and Subsystem Layering'. They will be presented in the Logical View section of the Software Architecture Document.
  • Any diagram in the 'Process View' package will be presented in the Process View section of the Software Architecture Document.
  • Any diagram in the 'Implementation Model' package will be presented in the section of the same name in the Software Architecture Document.
  • Any diagram in the 'Deployment View' will be present in the Software Architecture Document section of the same name.

 

Copyright  © 1987 - 2001 Rational Software Corporation

Display Rational Unified Process using frames

Rational Unified Process