System Design Documentation and Results Reporting
Types of Reports
Two common goals for creating reports are:
System Design Documentation — Capture information about the design decisions, structure, implementation, and operational details of a system.
Results reporting — Present results of running a system.
You use a similar workflow for creating and generating reports for both goals. However, some components are particularly useful for each use case.
System Design Documentation
System documentation helps you to:
Capture design decisions
Record implementation details
Communicate the system design and interfaces among groups
When you create a Simulink® Report Generator™ report to provide system design documentation, the report captures information about the system design from the model. Each time that you generate the report, you see up-to-date documentation for the design.
The table includes examples of components that are useful for system design documentation reports.
|System Information||Examples of Components to Use|
|Block parameter settings|
|System documentation included in a model|
Capturing results from simulating a model is useful for:
Model regression testing
Verifying and validating designs
Exploring design alternatives
The table includes examples of components that are useful in results reports.
|Results Information||Examples of Components to Use|
|Figures generated with MATLAB®|
You can use components such as the
component to control how the model simulates. Other components, such as the
Scope Snapshot, show the results of the