Import and Update Requirements from a Microsoft Word Document

This example shows how to import and update requirements from a Microsoft® Word requirements document. The model demonstrates a simple two-button switch that passes through outputs when only one switch is pressed at a time.

Open the model. At the MATLAB® command prompt, enter:

mdl = 'rejectDoublePress';
open_system(fullfile(matlabroot,'examples','slrequirements',mdl))

The supporting requirements document is located at matlab/examples/slrequirements.

This example uses a Microsoft Word document, Reject_Double_Button_Press_Model_Requirements.docx. This document contains a set of functional requirements for the Reject_Double_Button_Press model. Open the document from matlab/examples/slrequirements. The requirements in the document appear in outline format with custom bookmarks for navigation. To get the best results while importing and updating requirements, set up your Microsoft Word documents with document outlines and custom bookmarks.

Save the requirements document to a local folder before importing requirements from it.

Import Requirements

  1. Open the Requirements Editor. In the Apps tab, click Requirements Manager. In the Requirements tab, click Requirements Editor.

  2. Open the Document Import dialog box. In the Requirements Editor, select File > Import.

  3. Select Microsoft Word document from the Document type drop-down list and select Reject_Double_Button_Press_Model_Requirements.docx as the Document location.

  4. Import requirements as plain text, read-only references to a destination requirement set. In the Requirement Identification option group, select the options to use bookmarks and to ignore outline numbers. For more information on import options, see Import Options for Microsoft Word Documents.

The requirements from the Microsoft Word document are imported into the destination requirements set under a top-level node, Import1.

Update Requirements

Requirements that you import as read-only references retain their references to the source requirements document. To change your imported requirements, you must make the changes in the source document first and update your requirements set from within Simulink® Requirements™. For more information on updating requirements, see Update Imported Requirements

  1. In the document, Reject_Double_Button_Press_Model_Requirements.docx, add a new requirement:

    2.1.5 The Red and Green Button outputs shall be 0 if no buttons are pressed.

  2. Create a bookmark called Red_and_Green_Button_Output_2_1_5 for the new requirement and save the Microsoft Word document.

  3. In the Requirements Editor, select the top-level node (Import1) of the destination requirements set. Update the requirements imported from the document by clicking Update in the Properties side bar on the right.

  4. When the update operation is finished, select Import1 and view the changes to the requirements set in the Comments side bar. The Revision number and the UpdatedOn values are updated for the requirements set.

See Also

Related Topics