Defining Default Documentation Template for Model Element

A template enables you to retrieve and display information about your model elements. You can use a documentation template to generate documentation on different model elements of the same type. By creating a documentation template, you can also customize the content and presentation of your documentation of specific model element type.

To create a default documentation template for use case, do as the following steps:

  1. Take the use case diagrambelow as an example:

    Use case diagram sample

    Use case diagram sample

  2. Right click on Create Shipment use case that you set its documentation as default template and select Open Specification…from the pop-up menu.

    Open specification dialog box

    Open specification dialog box

  3. In Use Case specification dialog box, enter documentation in Documentation.

    Specify documentation

    Specify documentation

  4. Save the documentation as template by selecting Template > Save as template…from the drop-down menu.

    Save the documentation as template

    Save the documentation as template

  5. In the pop-up Input dialog box, enter Usecase templateas the template name.

    Enter template name

    Enter template name

  6. Click OK button. The template is saved.
  7. To save the template as default documentation for all use cases, select Template > Manage Template…from the drop-down menu.

    Manage template

    Manage template

  8. In the Manage Template dialog box, click Usecase template and select Set as Default > for Use Casefrom the drop-down menu.

    Set the default template for use case

    Set the default template for use case

  9. Click OK button.
  10. When the Set as Default dialog box prompts out, click Yesbutton. The default documentation template is set.
    Confirm default template setting

    Confirm default template setting

    Try to create a use case and check its documentation. Its documentation should share the same documentation with the default template.

    Share the same documentation with default template

    Share the same documentation with default template

48 replies

Leave a Reply

Want to join the discussion?
Feel free to contribute!

Leave a Reply