Comments
Last updated
Last updated
It takes a team to build great diagrams. Comments help clarify parts of your diagram, mark inaccuracies, or share ideas. Everyone in your organization can leave, view and resolve comments to add to the discussion.
Comments are only visible to an organization's admins, editors, and viewers. Share-link viewers can't see them.
There are 3 comment types in IcePanel. Each comment type can be used to discuss a particular topic:
Question - to discuss parts that you're unsure about.
Inaccuracy - to flag parts of the diagram that are incorrect.
Idea - to share thoughts about changes or improvements.
Questions should be used when you're unsure of part of the diagram, want to know how something works, or if something is unclear. Questions are added to the recommendations tab to be resolved by your teammates.
Inaccuracy comments should be used when something in the diagram or documentation is untrue or has changed. Each inaccurate comment reduces the Inaccuracy Score of the landscape, and resolving them will improve it.
Ideas are thoughts about future improvements to your architecture or diagram. For example, changes to a system or app to improve performance. Idea comments don't affect Inaccuracy Scores and can't be resolved (only deleted).
Comments can be added to any diagram and by all admins, editors, and viewers of your organization as long as they have access to a landscape. Share link readers can't add or view comments left by others.
To add a comment in a diagram:
Click the comment icon in the top right of the navigation bar, then the New comment button.
Or, click on the + button on the left-hand toolbar.
Select the type of comment you want to add (Question, Inaccuracy, Idea).
Type in your comment.
Mention someone using '@'. They'll receive an email notification and see the comment under the Mentions tab in the comments dropdown
Click on the confirmation button. Each comment type button differs:
Question comment type: Ask question
Inaccurate comment type: Mark as inaccurate
Idea comment type: Add idea
Click and drag on the comment bubble to move it to the desired location.
Team members can reply to the comment in the comment box.
If there are a lot of comments in a diagram or domain, you can quickly scan through them in the comment drop-down.
To view all comments:
Click on the comment icon in the top right of the navigation bar
You'll see 3 tabs:
Your comments: Comments that you created
Mentions: Comments where you were mentioned
All comments
In each tab, you can sort through open and resolved comments
To edit a comment:
Click on the comment bubble or find it in the comment drop-down.
Click on the pencil ✏️ icon.
Edit the comment.
Click on the checkmark button.
Pinning a comment makes the comment text visible in the diagram.
To pin a comment:
Click on the comment bubble or find it in the comment drop-down.
Click on the pin📍 icon in the top right of the comment box.
Questions and Inaccuracy comments can be resolved to remove them from the diagram and reduce their effect on the Recommendation and Inaccuracy Score.
To resolve a comment:
Go to the comment (must be a Question or Inaccuracy type).
Click the Resolved ◻ check box.
The comment will be removed from the diagram.
Resolved comments can still be accessed from the comments drop-down:
Click on the comment icon in the top right of the navigation bar.
Click on the All comments tab.
Click on the Resolved comments section to view all resolved comments.
If you want to restore the comment, click the comment and Resolved checkbox.
Only Idea comment types can be deleted.
To delete a comment:
Click on the comment bubble or find it in the comment drop-down.
Click on the trash 🗑️ icon to delete it.
Deleted comments can still be accessed in the drop-down under the resolved section.
