Simulink Design Documenter

Version 2.1 (24.8 MB) by McSCert
The Simulink Design Documenter generates Software Design Descriptions of Simulink models.
0.0
(0)
603 Downloads
Updated 22 Jul 2020
View License on GitHub

The Simulink Design Documenter provides tool support for semi-automated generation of Software Design Description documents for embedded systems developed using model-based design with Simulink. The Software Design Description is a document that describes the design of a Simulink system. Although appropriate software documentation has been viewed by many as an important factor in effective development of large industrial systems, in industrial practice software documentation has been typically neglected due to cost/time pressures. The purpose of the Simulink Design Documenter is to highly automate the production of useful Software Design Description documents for Simulink models, therefore significantly reducing the documentation effort.

• For instructions on installation and how to use the tool, please see the included user guide: Simulink-Design-Documenter/doc/SimulinkDesignDocumenter_UserGuide.pdf.

• An in-depth guide is provided as Simulink-Design-Documenter/doc/SimulinkDesignDocumenter_FullGuide.pdf.

• This tool relies on our Simulink Utility. Please download it here: https://github.com/McSCert/Simulink-Utility.

• A short demo video of the tool can be found at https://youtu.be/WBmHbhPmgRs.

For more about the capabilities of the tool and how it can be used in model-based development with Simulink, see the two papers:
[1] Alexander Schaap, Gordon Marks, Vera Pantelic, Mark Lawford, Gehan Selim, Alan Wassyng, and Lucian Patcas. 2018. "Documenting Simulink Designs of Embedded Systems," In Proceedings of the 21st ACM/IEEE International Conference on Model Driven Engineering Languages and Systems (MODELS): Companion Proceedings, ACM, Copenhagen, Denmark, 47–51. DOI: https://doi.org/10.1145/3270112.3270115

[2] Vera Pantelic, Alexander Schaap, Alan Wassyng, Victor Bandur, and Mark Lawford. 2019. "Something is Rotten in the State of Documenting Simulink Models," In Proceedings of the 7th International Conference on Model-Driven Engineering and Software Development, SciTePress, 503–510. DOI: https://doi.org/10.5220/0007586005030510

Cite As

McSCert (2024). Simulink Design Documenter (https://github.com/McSCert/Simulink-Design-Documenter/releases/tag/v2.1), GitHub. Retrieved .

MATLAB Release Compatibility
Created with R2017a
Compatible with R2016b to R2018a
Platform Compatibility
Windows macOS Linux
Categories
Find more on Modeling in Help Center and MATLAB Answers

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!

Report_Specific_Files

example/sldemo_househeat_doc

src

src/Formatting

src/Formatting/Document_Structure

src/Internal_Content_Configurations

src/Internal_Content_Configurations/Tables

src/Library_Blocks

src/Other

src/Warning_Handling

example/sldemo_househeat_doc

src/Library_Blocks

Version Published Release Notes
2.1

See release notes for this release on GitHub: https://github.com/McSCert/Simulink-Design-Documenter/releases/tag/v2.1
2.0.1

Resubmitting the tool as Matlab Central did not upload the previous submission properly.
2.0

Made significant changes to the template.
1.2.0.0

- Fixed a bug in 2017a which cut off the Summary of Warnings text.
- Updated the example model.
1.1.0.0

Added support for Matlab/Simulink Report Generator R2017a.
1.0.1.0

Updated the Full Guide.
1.0.0.0

Updated tool description.
Added the Signature Tool under "Other Requirements".

Updated formatting of tool description.
To view or report issues in this GitHub add-on, visit the GitHub Repository.
To view or report issues in this GitHub add-on, visit the GitHub Repository.