Link to Requirements in Microsoft Word Documents

Create Bookmarks in a Microsoft Word Requirements Document

You can create bookmarks in your Microsoft® Word requirements documents to identify the requirements that you want to link to. When you create the links, you specify that the RMI must link to an existing bookmark, rather than create a new bookmark.

This approach offers advantages to creating new bookmarks:

  • You can give the bookmarks meaningful names that represent the content of the requirement.

  • When the RMI creates the links, it does not modify your requirements document.

    Note:   When you link to an existing bookmark, navigating the link highlights the entire range of the existing bookmark. Therefore, when you create a bookmark for requirement linking, make sure to select only the document information relevant to your requirement.

If you have a requirements document containing bookmarks, follow these steps to create requirements links from your Simulink® model to the bookmarks:

  1. Open your model.

  2. Open your Microsoft Word requirements document that contains bookmarks that identify requirements.

  3. Right-click a block in the model that you want to link to a requirement and select Requirements Traceability > Open Link Editor

    The Requirements Traceability Link Editor opens.

  4. Click New.

  5. Click Browse and navigate to the Microsoft Word requirements document that has bookmarks.

  6. Open the document. The RMI populates the Document and Document type fields.

  7. Click the Document Index tab of the Link Editor.

    The Document Index tab lists all bookmarks in the requirements document, as well as all section headings (text that you have styled as Heading 1, Heading 2, and so on).

    The document index lists the bookmarks in alphabetical order, not in order of location within the document.

  8. Select the bookmark that you want to link the block to and click OK.

    The RMI creates a link from the block to the location of the bookmark in the requirements document without modifying the document itself.

Open the Example Model and Associated Requirements Document

This example describes how to create links from objects in a Simulink model to selected requirements text in a Microsoft Word document.

Navigate from the model to the requirements document:

  1. Open the example model:

    slvnvdemo_fuelsys_officereqslvnvdemo_fuelsys_officereq
  2. Open a requirements document associated with that model:

    rmi('view','slvnvdemo_fuelsys_officereq',1);rmi('view','slvnvdemo_fuelsys_officereq',1);

Keep the example model and the requirements document open.

Create a Link from a Model Object to a Microsoft Word Requirements Document

Create a link from the Airflow calculation subsystem in the slvnvdemo_fuelsys_officereq model to selected text in the requirements document:

  1. In slvnvdemo_FuelSys_DesignDescription.docx, find the section titled 2.2 Determination of pumping efficiency.

  2. Select the header text.

  3. Open the example model:

    slvnvdemo_fuelsys_officereq
  4. Select Analysis > Requirements Traceability > Settings. The Requirements Settings dialog box opens.

  5. On the Selection Linking tab of the Requirements Settings dialog box:

    • Set the Document file reference option to path relative to model folder.

    • Enable Modify destination for bi-directional linking.

      When you select this option, every time you create a selection-based link from a model object to a requirement, the RMI inserts navigation objects at the designated location.

    For more information about the settings, see Requirements Settings.

  6. Double-click the fuel rate controller subsystem to open it.

  7. Open the Airflow calculation subsystem.

  8. Right-click the Pumping Constant block and select Requirements Traceability > Link to Selection in Word.

    The RMI inserts a bookmark at that location in the requirements document and assigns it a generic name, in this case, Simulink_requirement_item_7.

  9. To verify that the link was created, select Analysis > Requirements Traceability > Highlight Model.

    The Pumping Constant block, and other blocks with requirements links, are highlighted.

  10. To navigate to the link, right-click the Pumping Constant block and select Requirements Traceability > 1. "Determination of pumping efficiency".

    The section 2.2 Determination of pumping efficiency is displayed, selected in the requirements document.

Keep the example model and the requirements document open.

View Link Details

To view the details of the link that you just created, right-click the Pumping Constant block and select Requirements Traceability > Open Link Editor.

The Requirements Traceability Link Editor opens.

This dialog box contains the following information for the link you just created:

  • Description of the link, which for selection-based links, matches the text of the selected requirements document, in this case Determination of pumping efficiency.

  • Name of the requirements document, in this case slvnvdemo_FuelSys_DesignDescription.docx.

  • Document type, in this case, Microsoft Word.

  • The type and identifier of the location in the requirements document. With selection-based linking for Microsoft Word requirements documents, the RMI creates a bookmark in the requirements document. For this link, the RMI created a bookmark named Simulink_requirement_item_7.

    If you do not want the RMI to modify the Microsoft Word requirements document when it creates links, create bookmarks in your Microsoft Word file, as described in Create Bookmarks in a Microsoft Word Requirements Document.

  • User tag, a user-defined keyword. This link does not have a user tag.

Was this topic helpful?