Skip to main content

System Platforms

Overview​

With Platforms you will know how all the pieces in your system fit together. From the high level, logical system architecture to the individual components, with their metadata, integrations, and dependencies.

Create a Platform​

A platform is a collection of components — i.e. software that uses or provides an API such as web-apps, microservices, SaaS providers, etc.

  • Open your project
  • In the left-side menu, open “Platforms”
  • Click “Create a platform”

You can choose between:

Using AI Assist: Our AI Assist feature will process image files (.png or .jpg) of your existing diagrams or freehand sketches, extrapolating and listing all of your system components. You can then edit them and select those that will be added to your platform.

  • Upload as many image files as you wish, to get a full list of your components. This process may take a few minutes to complete.
  • Type in a platform name.
  • Review the detected components. You can rename them, change their type or add tags.
  • Click “Create a platform”.

Continuing with the manual process: You can manually list all the components you want to add to your platform.

  • Type in a platform name.
  • Type the component name on “Enter to create a component”.
  • Click the “+” plus icon.
  • You can now change the component type or add tags.
  • Once you have a full list, click “Create a platform”.

You will also be able to add, edit, and delete platform components at any point after its creation.

Edit the Components in a Platform​

đź’ˇ When editing your Platform, it's a good idea to create a new design branch: you can easily discard any incorrect changes or ask your team to review and approve them before merging into main.

(1) Add / Delete Components

A component is a software that uses or provides an API (e.g. web-apps, microservices, SaaS providers, etc.).

  • Click the “+” plus icon in the platform top menu or the “→” arrow icon when you hover over one side of a component
  • In the pop up modal, you can select an existing component or add a new one by clicking “Create a new component”
  • Name the component, select its type, and click “Create component”

To delete a component, select it and hit delete on your keyboard. You can also delete it from the Components tab.

(2) Add / Delete Dependecies

A dependecy (or a line / arrow between components) indicates a relationship where one component relies on another for functionality, data, or services to perform its role within the system.

  • Hover over one side of the component until an “→” arrow icon appears
  • Press, hold and drag the new dependecy to the desidered component

To delete a dependecy, select it and hit delete on your keyboard.

(3) Edit the Style and Information of Components

You can edit components by:

  • Double clicking on a component and editing the information in the right-side panel that opens
  • Navigating to the Components tab and opening the relevant component

For more information about editing components see here.

Edit the Layout of a Platform​

Arrange your platform components in the way that best suits your workflow:

  • Manual layout: manually drag and drop components for precision placement
  • Auto layout: Multiplayer will automatically organize and align everything for you.

With both options you don’t have to worry about reconnecting components when you move them within your platform, all dependencies will remain intact.

Platform Comments​

You and your team can write or seach for Platform comments by clicking on the "đź’¬" comment icon in the platform top menu.

đź’ˇ If you're looking to evolve your system architecture, the best way to discuss the changes with your team is to create a new design branch, edit your platform and submit a system design review.

Rename a Platform​

  • Hover over the platform name
  • Click on the ellipsis button “…”
  • Select “Rename”
  • Type a new platform name

Delete a Platform​

  • Hover over the platform name
  • Click on the ellipsis button “…”
  • Select “Delete”
  • Confirm your action in the prompt - please note that you can’t undo or recover deleted platforms.

Next Steps​

You did it! What’s next?