Model Comment

Model comment is a handy yet powerful utility for adding notes to model elements and diagrams. You can attach comments to interested elements for review or discussion purpose, and they can be read by other team members as well. By accumulating and sharing the comments of the team, a better traceability of software/process modeling and a more effective communication can be easily achieved.

Model comment is teamwork-enabled, which means different team members can add his/her own comments at the same time, and the comments from each member will be automatically merged by the Teamwork Server.

1. Right-click on a model or a diagram and select Open Specification... from the popup menu.
   
   
   
2. Select the Comments page and click Add....
   
   
   
3. In the Comment Specification dialog box, enter Summary, Author and Content. Date time is automatically filled in with the current time, you may edit its value if needed. Content can be edited in rich text format with various styles and formatting available for selection.
   
   
   
4. Click OK when finished editing the comment.
5. Alternatively, you can open the comments page of a model/diagram by clicking on the ... button next to the Comments property in the Property Pane.
   
   
   

Animated Demo

1. To view comments of a model/diagram, open the specification dialog box using the popup menu or the Property Pane, and then select the Comments page. The comments are listed in descending order of date time.
   
   
   
2. To view the details of a comment, select it in the table and click the Open Specification... button. Or more conveniently, you can mouse over a comment to see its content.
   
   
   
3. Alternatively, you can view the most recent comment of a model/diagram in the Comments property in the Property Pane.
   
   
   

Animated Demo

Here shows a typical scenario that how model comment can work with the Teamwork Server.

1. After checked out a project, John adds a comment to the diagram.
   
2. Then he commits the project to the Teamwork Server.
   
3. At the same time, Peter adds a comment to the same diagram, and he commits the project to the Teamwork Server as well.
   
4. After Peter committed the project and open the specification of the diagram, he will see not only the comment he just added, but also the comment that is added by John.
   

Animated Demo