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

Add a New Document

Within the Team Review, you can create a new Document on a Topic as either:

  • A blank Document
  • A Document based on a predefined template, or
  • A Document from a file link

Access Project | Team Review (Ctrl+Alt+U)

Create a blank Document

Step

Action

See also

1

Either:

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

A new 'Document' icon displays underneath the Topic name.

Work on Team Review Items

2

Overtype the New Document text with the name of the Document, and click off the name.

The text editor displays in the 'Team Review' tab.

3

Type the text of the Document as required.

Edit an Item

Create a Document based on a predefined template

Step

Action

See also

1

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

A new 'Document' icon displays in the hierarchy.

Work on Team Review Items

2

Overtype the New Document text with the name of the Document, and click off the name.

The 'New Document from Template' dialog displays.

3

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

4

Click on the OK button.

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

5

Type in or paste the text of the Document.

Edit an Item

Create a Document based on a link to an external file

Step

Action

See also

1

Open a file browser (such as Windows Explorer) and locate the file.

2

Click on the file name and drag it onto the appropriate Topic name in the Team Review window.

A new 'Document' icon is created underneath the selected Topic, and the body of the Document is shown in the 'Team Review' tab.

A link to the source file is created at the start of the message.

3

Click twice on the New Document text in the Team Review window, and overtype the text with the name of the Document.

4

In the 'Team Review' tab, create and edit text around the file link, and add further links if required.

Edit an Item

When you have created the Document

You can

Detail

See also

Create links from the Document

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 Document to Team Review objects

Such as:

  • Categories
  • Topics, and
  • Documents

Add Object Links

Create links from the Document to external files

These links can be either in the text of the Document or on the 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 Document

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 Comments on the Document from other users

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

Comment on a Document