Documentation Sub-Menu

In the Project Browser, right-click on a package and select the Documentation context menu option.

Option

Description

Shortcut

See also

Generate Documentation

 

Select this option to design and generate reports and documentation on the contents of the selected Package.

The Document Generation dialog displays.

 

F8

Document Reports

HTML Report

 

Select this option to design and generate web documentation on the contents of the selected Package.

The Publish as HTML dialog displays.

 

Shift+F8

Create a Web Page Report

Diagrams Only Report

 

Select this option to generate a Diagrams Only report, which describes the diagrams in the selected Package.

The Export Diagrams to RTF Document dialog displays.

 

Ctrl+Shift+F8

Diagrams Only Report

Testing Report

 

Select this option to generate a Testing report, which describes the software development tests defined for the selected Package.

The Generate Test Documentation dialog displays.

 

 

Test Documentation

Open in Relationship Matrix

Select this option to open the Relationship Matrix with the selected Package as the source or target Package for the Matrix.

 

 

Relationship Matrix

 

Generated Report Options

 

Select this option to exclude the selected Package from any reports generated from now onwards, or to include the excluded Package in reports again.

 

 

Exclude Package from Report

Copy Documentation Bookmark

 

When using the Legacy Report Generator, if you want to create a complex document that consists of sections of one or more document reports, rather than one complete report, you can create a master document in Microsoft WordTM and within it create links to the report sections using their bookmarks.

Select this menu option to copy the bookmark on the selected Package to the clipboard, to be pasted into a search or other reference to the bookmark.

 

 

Document Bookmarks

Package Metrics

 

Select this option to perform some calculations on the selected Package to establish Project Metrics for planning purposes.

The QA Reports view opens on the Use Case Metrics tab.

 

 

Estimating Project Size