Best way to document model design - Is it possible to incorporate everything in one model?

I'm looking at the best ways to document the design and description of a model through Simulink tools/apps. It seems like while there are many methods there is not one method that incorporates everything. How to incorporate canvas annotations, docblocks, Simulink notes etc within the Simulink report generated by Simulink Report Generator. I want to be able to report everthing in one document that will update automatically when I update the model. Is this possible?

Answer 1

[Aghamarsh Varanasi]

Hi Joshua,

The System Design Description is a standard report that can be generated with Simulink Report Generator. This includes all the system design details along with annotations, docblocks etc. System Design Description report can be created from the Design Section of the Modelling Tab of Simulink Toolstrip. More information about System Design Description Report can be found here.

The content of the System Design Description report can be customized. For more information about customizing System Design Description reports refer to this article.

The function genssd can be used to generate the System Design Description report from the MATALB command Line. This function can be used in Simulink Callbacks to automate the report generation.

[Joshua Ford]

Thank you for the information and help. That is exactly what I wanted and need. Do you have any tips for using the or creating the system design details/description.

Cheers,

Josh

[Joshua Ford]

Can Simulink Notes also be included in the report?

[Aghamarsh Varanasi]

To add Simulink Notes to the report, please check this documentation page.