System Design Description
Predefined Standard Reports
From the Simulink® Toolstrip, you can generate two predefined, standard Simulink Report Generator™ reports called:
System Design Description
System Requirements Traceability
The System Design Description report provides summary or detailed information about a system design represented by a model. You can choose report options using the report dialog, or you can create a customized version using the Report Explorer. For details, see Generate a System Design Description Report.
You can use the System Design Description report setup file as a starting point for creating a setup file for your own report. For more information, see Print Model Reports.
The System Requirements Traceability report requires that you have Requirements Toolbox™ installed. The System Requirements Traceability report includes information about all the requirements associated with the model and its objects.
Follow these steps to generate the System Requirements Traceability report from the Simulink Toolstrip:
If the Requirements tab is not available, on the Apps tab, in the Model Verification, Validation, and Test section, click Requirements Manager.
On the Requirements tab, in the Share section, click Share > Generate Model Traceability Report.
What Is the System Design Description?
The System Design Description is a prebuilt Simulink Report Generator report that describes the system design represented by a Simulink model.
By default, the Simulink Report Generator generates the report for the model from which you invoke the System Design Description report option.
What You Can Do with the Report
You can use the System Design Description to
Review a system design without having the model open
Generate summary and detailed descriptions of the design
Assess compliance with design requirements
Archive the system design in a format independent of the modeling environment
Build a customized version of the report, using the Report Explorer
You can specify what kinds of information to include in the report, in terms of:
What elements of a model to include in the report (for example, whether to include subsystems from custom libraries)
Whether to generate a summary version or a detailed version of the System Design Description report.
For details, see Generate a System Design Description Report.
|System Design Variables||
The detailed version of the report includes all the information that is in the summary form of the report, as well as more information about the system components. The atomic subsystem information is more detailed than virtual subsystem information.
The same type of information as the information for the root system, as well as:
Report Captures Documentation Included in a Model
The System Design Description reports documentation included in a model, including:
The model description (from the model properties)
The block property
DocBlock model documentation blocks
To enrich the generated System Design Description, add corresponding information in the model.