Linking Diagram Elements to Documentation

In this tutorial, we'll walk you through the process of adding links to your documentation within Software Ideas Modeler. By linking diagram elements to your documentation text, you create a seamless integration between the visual and written aspects of your project, making it easier for readers to understand and navigate. Moreover, when you update the name of a linked element in the diagram, the text in the documentation will automatically update as well, ensuring consistency across your project.

By linking diagram elements to your documentation in Software Ideas Modeler, you enhance the user experience and create a more organized and easily navigable project. The automatic update feature ensures that your documentation stays consistent with changes made to the diagram elements, saving you time and effort. Follow these simple steps to make the most of this valuable feature and improve your documentation process!

Linking elements from a diagram to documentation
Linking elements from a diagram to documentation

Step 1: Open Your Project

First, open the Software Ideas Modeler project you're working on or create a new one. Make sure you have your diagram open in the main window and the Documentation panel open in the right sidebar.

Step 2: Navigate to the Documentation Panel

Click on the Documentation icon in the sidebar (by default on the right) to access the documentation editor. You should see a text editor where you can add, edit, and format your documentation text.

Step 3: Select the Diagram Element

In the diagram canvas, locate the diagram element (e.g., a class or another entity) you want to link to your documentation. Click on the element to select it.

Step 4: Drag and Drop the Element to the Documentation Editor

With the diagram element selected, press and hold the right mouse button. Drag the element over to the Documentation panel and release the right mouse button while hovering over the text editor. This action will create a link in your documentation text.

After adding the link, you'll see that the element's name appears as a blue highlighted text in the Documentation panel. You can change the formatting if desired.

Step 6: Update the Linked Element and See the Automatic Change in Documentation

To demonstrate the automatic update feature, change the name of the linked element in the diagram. After making the change, you'll see that the linked text in the Documentation panel automatically updates to match the new name of the element, ensuring consistency across your project.

New Comment