ALM: User Guide

When you prepare project documentation, such as business or system requirements, it helps to use expressive tools: UML models, BPMN diagrams, user interface mockups, decision trees (mind maps), and so on.

The editor has built-in support for UML models through PlantUML. This is a simple language for describing various kinds of UML models in text. The model source (text) is stored directly in the document section, so any participant can change the current version of the diagram.

For example, when the following diagram code is inserted:

class Car [[https://localhost]]
class Driver
Driver -- Car

the application builds the following diagram:

Note that the Car class has a link. It is clickable and opens the description of that class, the requirements for it, or the component where additional attributes and relationships are defined.

The application can build PlantUML diagrams automatically from a set of components. Classes, services, microservices, and other implementation details can be recorded as components, and a diagram can be generated and then inserted into the relevant use case or other functional requirement.

Diagrams contain links to the corresponding components and are updated automatically when the attributes, relationships, and other diagram elements change.

Clicking "Diagram" on the toolbar opens the draw.io editor, where you can create diagrams in many notations. It is a strong alternative to Visio and similar desktop tools. The diagram source (text) is stored inside the requirement, so versioning, version comparison, and the other requirements and change-management mechanisms used for text all work.

If needed, you can create diagrams in the desktop version of draw.io and then import them into the document.

Links can also be added to diagram elements, so you can open the description of those elements, their requirements, and so on.

If you use other tools to prepare diagrams, you can insert the result as an image or as embedded HTML. If the source model or diagram is updated, it is updated in the requirement text as well. This is done by inserting the model as embedded HTML. Almost all tools can insert models as embedded HTML.

On the toolbar, choose "Insert HTML" and paste the text the modeling tool gave you into the input field.

Here are several popular modeling tools:

• https://cawemo.com/ for building BPMN diagrams
• https://www.gliffy.com for drawing diagrams
• https://moqups.com for drawing a graphical user interface

This approach has some limitations. For example, such diagrams cannot be exported to external formats if authentication is required, or if they are stored on a private cloud drive.

To create decision trees (mind maps), use diagrams. Add a new diagram and, under "Advanced", choose the ready-made "Mind maps" shape.

You can create branches, topics, and ideas with the arrows on the diagram:

To create user interface mockups, insert a diagram and choose shapes (Mockup...) that contain the main controls for mocking up a graphical user interface. If that shape category is missing, click "More shapes" and enable the categories you need.