Voice documentation

In addition to textual description for your model elements, you can record voice documentation, or embbed audio files.

Viewing and editing the documentation of model element

To read or edit the documentation of model element, right click on a model element and select Open Specification... from the pop-up menu to unfold Specification dialog box.

Open specification

Alternatively, click the Documentation pane after select a model element on the diagram.

Documentation pane

Recording voice

1. Right click on a model element and select Open Specification... from the pop-up menu.
2. In Specification dialog box, click Record... button on the bottom left corner of dialog box.
   

   Click Record... button

3. In the Record Voice dialog box, click the Record button to start recording.
   

   Start recording

   NOTE:

   Make sure your audio input device is active before operate voice documentation.

4. Click the Stop button when you want to end the recording.
   

   NOTE:

   Play the recorded voice by pressing the Play button; record again by pressing the Clear button, and rerun the previous steps.

5. Enter the name for recorded voice clip in the text field of Name.
   

   Name voice clip

6. Click OK button to confirm recording.

Linking voice to documentation

1. Right click on a model element and select Open Specification... from the pop-up menu.
2. In Specification dialog box, choose Manage... button on the bottom left corner of dialog box.

   Click Manage... button

3. In the Manage Voice dialog box, click the Add button, and choose either Embedded or Link to File.
   

   Click Add button

4. If you choose Embedded, record a voice clip when the Record Voice dialog box pops out; if you choose Link to File, select an audio file when the Open dialog box pops out.
5. The voice clip can be renamed in the text field of Name.
   

   Rename a voice clip

6. Click OK button to confirm.