Please note : This help page is for an older version of Enteprise Archtiect. The latest help can be found here.

Topic
Prev Next

Comment on a Document

You use the Team Review as a forum for discussion of items and issues within the project, so when you read a Document on a particular point (or a response to that Document) you might want to respond with your own Comment.

You can create a Comment directly from the Document you are responding to, from material that you want to use as your response, or from a predefined document template.

Access

Ribbon

Construct > Project > Team Review

Specification - Specify > Specification > Team Review > Open Team Review

Keyboard Shortcuts

Ctrl+Alt+U

Create a Comment in the Team Review

Step

Action

See also

1

Either:

  • Right-click on the required Document (or Comment) in the Team Review window and select the 'New Comment' option
  • Click on the Document name and on the 'New Comment' icon in the Team Review toolbar, or
  • Click on the Document name and press Ctrl+N

A Re:<Documentname> entry displays underneath the Document you are replying to, and the cursor becomes active in the 'Team Review' tab so that you can create and edit your response.

Work on Team Review Items

2

Type in, format and save the contents of the Comment.

Edit an Item

Create a Comment from external material

Step

Action

See also

1

Open a file browser (such as Windows Explorer) and locate a file containing the material you want to use in your response.

2

Click on the file name and drag it into the Team Review window, over the Document to which you are replying.

A prompt displays for you to specify whether to:

  • Create a new Comment containing the text of the file (the file name displays as the Comment name) or
  • Add the file to the original Document as a Model Link
Add Object Links

3

If necessary, edit, format and save the contents of the reply.

Edit an Item

Create a Comment based on a predefined template

Step

Action

See also

1

Right-click on the appropriate Document name in the Team Review window and select the 'New Comment from template' option.

A new 'Comment' icon displays in the hierarchy, and the 'New Document from Template' dialog displays.

Work on Team Review Items

2

Click on the drop-down arrow in the 'Template' field, and select a predefined template for the 'Comment' contents.

3

Click on the OK button.

The template structure is displayed in the 'Team Review' tab.

4

Type in or paste the text of the Document.

Edit an Item

When you have created the Comment

You can

Detail

See also

Create links from the Comment

To elements and diagrams from the:

  • Project Browser
  • Model Search
  • Model Views window, or
  • Package Browser
Package Browser The Project Browser Model Views Model Search Add Object Links

Create links from the Comment to Team Review objects

These links can be to related Team Review:

  • Categories
  • Topics and
  • Documents
Add Object Links

Create links from the Comment to external files

These links can be either in the text of the Comment or on the parent Category, Topic or Document in the Team Review window (the link is added to the Model Links folder for the Team Review item).

Add Object Links

Add resources to the Comment

It is simple and convenient to link to the resources that are the subject of discussion or that illustrate points in the discussion.

Team Review Resources

Receive replies to the Comment from other users

The objective of the Team Review is to discuss aspects of development, so you can expect to receive replies to the Comments that you have posted, and to create Comments on the material posted by your colleagues.

Learn More