New Features
Enhanced Features
O/R Mapping
Tips and Tricks
UML Diagrams
VP Suite

Manage Documentation Templates

A documentation template is a set of pre-written documentation with content and formats on which models or diagrams can be based. After a model or diagram has been applied with a template for its documentation, you can customize the content in further. Documentation templates saves time from creating different yet similar documentation content for every model. The templates also allow information to be presented in standardized formats.

In this release, documentation templates can be rearranged and removed, which makes the templates more easy to use by prioritizing them and deleting those unused ones.

Using Documentation Template

Documentation can be written in both the documentation pane and the specification dialog box of models or diagrams. Both ways allow saving and applying documentation template. Let’s see how to reuse documentation template in documentation pane. To save a template:

  1. After editing the documentation, press on the Save as template... button on the documentation toolbar.


  2. Specify the template name and click OK to confirm.


    This saves the template.

To reuse a template:

  1. Open the specification dialog box of the model on which the template will be applied.
  2. Press on the template drop-down button on the documentation toolbar, and select a template to reuse.


Managing Saved Templates

  1. Open the specification dialog of any model or diagram.
  2. Press on the template drop-down button on the documentation toolbar and select Manage Template... in the pop-up menu.


    This shows the Manage Template dialog box.

To remove a template, select the template from the list and click Delete.


To rearrange templates, select the templates and press Up and Down.


Resources

 
 
Last modified: 2007/09/24 08:08
 
 
Home | Recent Topics | Highlights | UML Diagrams | Tips and Tricks | Object-Relational Mapping
visual-paradigm.com Home | Training Center | UML Center | VP Gallery | Discussion Forum | UML Open Directory