IBM
Contents Index Previous Next



Preparing the Documentation Structure


What You Will Learn

Introduction to the Exercise

Your task is to modify the basic view of the Organizer to get the desired document structure.

The result of the exercise will be an Organizer structure containing a number of chapters and modules, see Figure 722. The chapters will correspond to the different activities in SOMT and the modules will correspond to the models in each activity.

Deleting Unwanted Chapters

When you start a new project in SDL Suite you will get the default basic Organizer view, see Figure 720. (This view could be different if you do not have the default preferences set). The Organizer contains a few black lines with attached names, the chapters. The purpose of these chapters is to group together collections of documents.

Figure 720 : The basic Organizer view

We want each chapter in the Organizer view to represent an activity in SOMT. The current chapters in the Organizer will not fit into our future documentation structure so they should be removed.

Delete the unwanted chapters by following the steps below:

  1. Make sure you have the basic view in the Organizer.
  2. Select the chapter named Analysis Model.
  3. Select the Remove command in the Edit menu or press the <Delete> button. You also find the Remove command in the pop up menu. The Remove dialog is issued asking you to Remove or to Cancel the action.
  4. Press the Remove button. The dialog disappears and the chapter is deleted.
  5. Repeat the steps above and remove all of the remaining chapters.

Adding New Chapters

You should now organize the Organizer view into chapters corresponding to the different activities in the SOMT method, i.e. each chapter should contain documents and diagrams from one particular activity.

You will have to add four chapters and they will be named Requirements Documents, System Analysis Documents, System Design Documents and Object Design Documents, respectively.

First, add the Requirements Documents chapter:

  1. Select the Add New command in the Edit menu. The Add New dialog arises with the Organizer radio button set.
  2. Select the Chapter option in the option menu connected to the Organizer radio button.
  3. Change the document name Untitled to
    Requirements Documents.
  4. Press the OK button or <Return>. A chapter named Requirements Documents will appear as the uppermost chapter object.
  5. Now repeat the steps above and add the three remaining chapters and name them System Analysis Documents, System Design Documents and Object Design Documents, respectively.

If the chapters show up in another order than the one you want in the Organizer window, you may move a selected chapter by using the arrow quick buttons in the tool bar.

  1. If needed, move the chapters in the Organizer to get a structure corresponding to the one in Figure 721.

Figure 721 : The Chapter structure

Adding the Organizer Modules

The next step to take when preparing the document structure is to add the Organizer modules. A module in the Organizer forms a naming scope around the documents it contains. It may contain any kind of documents.

As each activity in SOMT consists of a number of models, it seems natural to let a model correspond to a module in the corresponding chapter. You should now add the modules to the chapters in the Organizer structure.

  1. Select the chapter named Requirements Documents.
  2. Select the Add New command in the Edit menu.
  3. In the Add New dialog, make sure that the Organizer radio button is set. Select the Module option in the Organizer option menu.
  4. Change the name Untitled to RequirementsUseCaseModel

Note:

You are not allowed to have any space characters in the name of a module.

  1. Press the OK button. A module named RequirementsUseCaseModel appears in the Requirements Documents chapter.
  2. Now add the other modules to their respective chapter in the Organizer view. Let each model in a SOMT activity have its own module. The document structure in the Organizer should look like Figure 722 when you are finished.

Figure 722 : The complete document structure

This structure will form the framework to organize the forthcoming documents around.

  1. Save the Organizer structure and name the file accesscontrol.sdt.

Now you have finished the preparations and you can start to develop the Access Control system using the SOMT method.


http://www.ibm.com/rational
Contents Index Previous Next