Documentation Sidebar

The Documentation sidebar is an essential tool for creating and managing documentation for various elements within your project. This tutorial will guide you through accessing and utilizing the sidebar effectively.

Accessing the Documentation Sidebar

You can open the Documentation sidebar via several methods:

  • Sidebar Header Bar: Click the "Documentation" button located in the sidebar header bar.
  • Ribbon: View → Windows → Sidebars → Documentation.
  • Classic Menu: View → Sidebars → Documentation.
  • Quick Action Box: Type 'Documentation' into the quick action box for a swift access.
Documentation Sidebar
Documentation Sidebar

Features of the Documentation Sidebar

The Documentation sidebar is designed to enhance your project's documentation process:

  • Object Name Box: At the top, you'll find a box displaying the name of the object currently being documented, such as an element, field, active diagram, or folder.
  • Context Switch Arrow: Next to the object name box is a small downward arrow. Clicking this reveals a dropdown menu that lets you switch between different objects within the current context, such as a selected field, owning or selected element, diagram, or project folder.
  • Section Dropdown: Below the header box is the Section dropdown. This feature allows you to navigate between various sections of the documentation, like 'Default', 'Example', etc. To the right of this dropdown are two buttons:
  • Add Section: Lets you add new sections to the documentation.
  • Remove Section: Enables the removal of existing sections.
  • Text Editor: The central part of the sidebar is dedicated to a text editor. This is where you can compose and edit the documentation text. The formatting of the text can be adjusted using the Text ribbon tab, while additional documentation-related options are available under the Documentation ribbon tab.
  • Exportable Checkbox: Located under the text editor, this checkbox lets you decide whether the current documentation should be included in generated outputs.
  • AI Generate Button: Situated in the right bottom corner, this button offers the capability to automatically generate documentation. It's a useful feature for quickly creating a base for your documentation, which can then be refined manually.

Utilizing the Documentation Sidebar

The Documentation sidebar is invaluable for maintaining clear and detailed documentation throughout your project. Whether you are documenting a specific process in a flowchart, detailing the properties of a class in a UML diagram, or providing an overview of a project folder, this sidebar provides a centralized and accessible platform for all your documentation needs.

Remember, effective documentation is key to the success of any project. It ensures clarity, aids in understanding, and facilitates smoother transitions and collaborations within teams. By integrating the Documentation sidebar into your regular workflow, you elevate the quality and efficiency of your project management.

Context menu

This menu appears when you right-click within the documentation editor and offers the following options:

  • Undo: This option reverses the last action performed in the documentation editor. It's useful for quickly correcting recent changes or mistakes.
  • Redo: This function re-applies the last action that was undone. It's helpful if you change your mind after using the Undo feature.
  • Cut: This command copies the selected text to the clipboard and simultaneously removes it from the documentation. It's a convenient way to move text from one part of the documentation to another.
  • Copy: This option copies the selected text to the clipboard without removing it from the current document, allowing for easy duplication of text within the documentation.
  • Paste: This feature inserts text from the clipboard into the documentation at the cursor's position. It's essential for adding previously copied or cut text into your documentation.
  • Delete: This command removes the selected text from the documentation without copying it to the clipboard. It's useful for quickly getting rid of unwanted text.
  • Select All: This option selects all the text within the documentation editor, enabling quick modifications or copying of the entire document's content.


Jan 12 June 2014 15:34:02

Reuse/link documentation

Is it possible to reuse documentation (link in) on other diagrams (e.g. documentation written for a Use Case could be linked and displayed on a Robustness Diagram or a Sequence Diagram)? If so, is it described anywhere on this site?

Dusan Rodina - 12 June 2014 16:39:23

RE: Reuse/link documentation

It's not yet possible. However, I can add this improvement. Thank you for your suggestion.

Jan 12 June 2014 17:50:40

RE: RE: Reuse/link documentation

Thanks for the speedy reply! I'm looking forward to this feature :-)

New Comment