🏁Getting started
Create your first IcePanel diagram and model
Last updated
Create your first IcePanel diagram and model
Last updated
IcePanel is an interactive modelling and diagramming tool that uses the C4 model to help you communicate your team's system architectures in a structured way. It helps explain how things work to your audiences through an abstraction-first approach, overlaying details when needed.
With the C4 Model, you can drill down or zoom in and out of different levels of detail, depending on the audience you're communicating your designs to. In most software teams, this is a mix of technical (developers, architects, operations, etc.) and non-technical people (product, business stakeholders, etc.).
Using modelling instead of diagramming alone removes much of the maintenance headache of keeping multiple diagrams up-to-date, as changes sync automatically through all your diagrams.
Getting started in IcePanel is simple. Here is a quick example to follow so you can have robust system documentation that will help you educate, learn, make decisions and plan future developments (which also look pretty cool 😎).
Create a landscape (if you haven't already)
Add the top-level objects for your design, such as:
The system(s) your company develops (start with 1)
Third-party systems you depend on
People who use your solution, such as customers
Add connections between the different objects, highlighting their high-level relationships.
Adding and editing objects in diagrams automatically adds them to your model to be re-used later.
This is the context level (Level 1) of the C4 model, and the focus here is the big-picture view of your system architecture. This will mainly show how your system(s) solve your customer's problems, remaining primarily at the business level, so keep it simple!
Everyone! Anyone in or out of your company who needs a high-level overview of how your system(s) work. Perfect for your business, product, or other non-technical peers, as well as onboarding new technical teammates.
Name your objects in a way anyone can understand.
Label all connections so the relationships are clear.
Zoom into a System (using the +🔍 icon on the top left of the system).
Add the Apps and Stores that are inside the primary system.
Connect them to show messages or relationships between them.
This is the App level (Level 2 - known as Container diagram in C4). It shows the individually deployed/runnable units in each System that execute or store code.
Mainly technical people, such as architects and developers. Some product people (such as product owners, product managers, or business analysts) will gain value here, especially for planning purposes.
Name your objects in a way anyone can understand.
Label all connections so the relationships are clear.
Because we're using a model, we can add objects from higher levels here, such as other systems you depend on or the people interacting with your solution.
Add your Actors and Systems from the level above by either:
Double-clicking in the diagram and typing their name.
Going to the "Model objects" tool on the left and drag them in.
Add the connections to the apps/stores inside the system from previously created connections.
You can create multiple diagrams to show different views of your model. Examples include customer-specific views, focusing on one object, and current vs. future design.
Connections that were created at a higher level will show as higher connections.
Once you have your Apps and Stores laid out and connected, start adding any tech choices, such as what service in AWS, GCP or Azure service, languages, libraries or frameworks, etc.
Select your model object. You can multi-select objects by holding the Shift key.
Go to the technology section on the right-hand panel.
Search for your tech choice and add it.
These choices come with docs preassigned and a simple description for those unfamiliar. These can be used later to highlight tech choices using the tags bar, allowing people to learn your architecture's technical choice landscape and filter your model.
Each object and diagram has a description, which adds details to help your teammates understand how things work. Descriptions follow that object wherever it is and are linked to your Recommendation score.
The minimum you should add is a brief displayed description for each object. This might seem obvious, but it will help your teammates (especially new ones).
Select an object.
Go to the right-hand panel.
Add a displayed description to each object (max 120 characters).
Try to explain:
What the object is.
What its primary responsibilities are.
Use the detailed description field to show other useful information, or Linking to reality to highlight parts in your code.
The detailed description field supports Markdown, so you can quickly import your existing documents and formatting manually or through our API.
Your Systems architecture doesn't live in a static world without interactions and data flows, so neither should your diagrams. Flows allow you to show how your system works in multiple scenarios or user journeys on the same view.
Click Create flow in the diagram Flows tab at the bottom left of the screen. Name your Flow.
Select the object or connection you want to show in your first step.
Click + Step on the left.
Add an optional description to the step.
Keep adding steps to show the rest of the flow.
Use the Back and Next buttons to step through your flow when complete.
Tags allow you to show multiple perspectives of your diagrams without duplicating them. Use Tag groups to show different information, such as deployment information, the risk, or the cost of your model.
Open the Tags bar at the bottom of the screen.
Click an object to open the details in the right-hand panel.
Click the Add tags button.
Add tags that apply to the tag group you want to show.
Hover over the tags in the bottom tag bar to highlight them. You can also click on them to pin them or select the hide/focus options.
Tags are a great way to change the focus of your design with little effort and help target specific areas of focus for each of your audiences.
IcePanel is a collaborative tool for your whole team. Getting others involved helps you gain knowledge from across your business. Invite them as viewers (unlimited and free on all IcePanel plans) or create interactive read-only share links of your designs. Share links & embeds are a great way to showcase your designs without them needing an account using just a browser.
Click the Share button in the top right of the screen.
Type the emails of the people you want to invite to your team.
Send invitations.
Create share links:
Click the Share button in the top right of the screen.
Navigate to the Share link tab.
Toggle on share links.
Copy and paste the link to anyone you want to show your designs.
Wherever you are when you create a share link will be where your audience lands when opening the URL. This includes position, selected object, Flow, Tags etc.
You can create versions of your landscapes to track changes and use the timeline to visualize how your architecture has evolved.
Click the Current drop-down at the top left of the canvas.
Click the Create version button.
Name your version and add notes (this will help you and others in the future).
Click the Create version button to confirm.
Select the Current drop-down to view the version timeline.
Congratulations! You've started your journey into interactive architecture documentation that remains up-to-date and can be accessed by all your teammates!
Still need help? Let us know at mail@icepanel.io, and we'll respond as soon as we can!
