4.3 Documenting Model Elements in StarUML

In StarUML, adding descriptions to model elements is done as follows. Select a model item by clicking on it with the mouse and open the Documentation editor. If it is not displayed on the right in one of the tabs of the model inspector, then open it using the View → Documentation menu. Opposite the Documentation item there should be a tick. Enter a description of the item in the documentation window (Figure 19).

Figure 19. Documenting a model element in StarUML

All model elements should be documented. The method described above is suitable for any element of any diagram.

Example. For actors and use cases of the “Style” shop order system we will make a brief description.

A customer is a person who can place an order at a Style store using a projected system.

An employee is all employees of the Style shop who can receive information about orders made and change the order status in the system depending on the step where the order is processed.

The Warehouse system is an external system that receives information about orders made at the Style shop in order to ensure that the stock of goods in the warehouse and the supply of goods are taken into account.

Order of goods - this precedent is launched by the buyer in order to place an order in the shop «Style». It consists of viewing the catalog, adding goods to the basket, viewing the basket, changing the contents of the basket and placing an order, including payment.

Order status management - this case is used by store employees to change the status of an order during its processing.

Getting information about the order - a precedent is used by all the actors to view information about the order.

To create another (of any type), for example, a detailed use case, right-click the Use Case Model folder and select Add Diagram from the pop-up menu that appears, then select the diagram you want to add from the list. For example, you can create an additional use case diagram by selecting Use Case Diagram (Figure 20).

Figure 20. Creating an additional use case diagram

Example. The precedent for ordering goods is the most significant precedent for this system and its actors. For it, we will build an additional use case diagram explaining this use case (Fig. 21).

Figure 21. A use case diagram explaining the main use case.

Custom products