Skip to content

Commit 0181071

Browse files
committed
docs: enhance Reviewing Designs page with comment best practices (#550)
Signed-off-by: avanshh99 <avanshetty196@gmail.com>
1 parent ff8e930 commit 0181071

1 file changed

Lines changed: 34 additions & 7 deletions

File tree

  • content/en/kanvas/designer/comments

content/en/kanvas/designer/comments/index.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You can add comments in a number of convenient ways. Since designs are public by
3535

3636
### Commenting via context-click
3737

38-
Context-click on any area of your design, and from the contextual menu, select "Add a Comment". Using this context-click method allows for inline placement of your remarks right where you need them - *in context*.
38+
Context-click on any area of your design, and from the contextual menu, select "Add a Comment". Using this context-click method allows for inline placement of your remarks right where you need them - _in context_.
3939

4040
<figure>
4141
<img src="./comment-canvas.png" alt="Comment by context-clicking on your design" />
@@ -66,7 +66,7 @@ Easily draw the attention of relevant team members by tagging them in your comme
6666
### Comment on Specific Elements
6767

6868
Leave comments on specific elements within the design, whether it's a shape, text, or an entire component. This specificity ensures that feedback is targeted and directly related to the part of the design under discussion.
69-
69+
7070
### Resolving a Comment
7171

7272
Resolving a comment thread indicates that the conversation on that topic has concluded. When a comment is resolved, the comment component is removed from view on the canvas.
@@ -147,8 +147,8 @@ Kanvas auto-generates comment names, useful for quick feedback. When duplicating
147147
- **Timestamp**: The original creation time is preserved.
148148
- **Threads**: All replies in the original thread are included.
149149
- **Name**: If the comment has a name, the clone keeps the same name.
150-
- **Placement**:
151-
- **Duplicate**: Instantly places the comment in the same design.
150+
- **Placement**:
151+
- **Duplicate**: Instantly places the comment in the same design.
152152
- **Copy**: Allows you to paste the comment manually into the same or a different design.
153153
- **Notifications**: Neither duplicating nor copying sends a creation notification to the design owner or participants. However, replies to the cloned comment will notify participants unless they’ve muted the thread.
154154
- **Independence**: The clone is separate—editing or deleting the original does not affect the copy.
@@ -181,7 +181,7 @@ Give long-lived comments short, descriptive names like `"Needs Load Balancer"` o
181181
so you can quickly find them in the Layers panel later on.
182182
{{< /alert >}}
183183

184-
### Reopen a Resolved Comment
184+
### Reopen a Resolved Comment
185185

186186
If a comment is resolved by mistake, it can be reopened. Adding a new comment to a resolved discussion will also re-open the thread. Reopening a comment allows you to reinitiate conversations, address additional concerns, or make further changes.
187187

@@ -241,14 +241,41 @@ You can also manage all your comment notification settings centrally through the
241241

242242
- While email alerts are muted, you can still access and view all comments on the design at any time.
243243
- You'll never miss an important mention, as notifications for mentions outside the muted thread remain active.
244-
{{< /alert >}}
244+
{{< /alert >}}
245245

246246
{{< alert type="info" title="Missed Notifcations">}}
247247
Kanvas does not track the read or unread status of messages inside comment threads for each user. If a user is mentioned, but misses the notification, they might not become aware of the comment until they receive a new notification for another comment in that conversation.
248248
{{< /alert >}}
249249

250250
## Best Practices for Effective Design Reviews
251251

252+
### Using Comment Features Effectively
253+
254+
To make your reviews more structured, Kanvas offers a number of tools inside the comment system itself. Use them to streamline collaboration and clarify your feedback.
255+
256+
#### Use Color-Coded Comments
257+
258+
Use color to visually categorize your comments:
259+
260+
- 🔴 **Security** concerns
261+
- 🔵 **Scalability** or performance-related notes
262+
- 🟢 **UI/UX** feedback
263+
- 🟡 **Open questions** or suggestions
264+
265+
This makes it easy for team members to scan and prioritize feedback based on type.
266+
267+
#### Use Annotation Arrows
268+
269+
Link your comment to a specific part of the design using **annotation arrows**. This reduces ambiguity and ensures the context of your comment is crystal clear.
270+
271+
#### Lock Important Comments
272+
273+
Lock comments in place to keep them visible even as you continue working. This is helpful for feedback that should remain persistent throughout the review cycle.
274+
275+
#### Group Related Comments
276+
277+
Bundle multiple related comments using the **Group** feature. This keeps threads organized and easier to track, especially for complex designs with many parts.
278+
252279
### Resolving vs deleting comments
253280

254281
Resolving a comment hides it from the canvas but keeps its history, so you can always revisit or reopen it later. Deleting a comment removes it entirely — including all threads and history — and cannot be undone.
@@ -274,4 +301,4 @@ Highlight the most critical feedback first. This ensures that the designer focus
274301
**What if two people act at the same time?**
275302
276303
If someone resolves a comment while you're still typing in it, the comment will immediately close for both of you. You'll see a message letting you know that the thread was resolved.
277-
-->
304+
-->

0 commit comments

Comments
 (0)