【源码】Simulink设计文档生成器

Simulink Design Documenter为使用Simulink基于模型设计开发的嵌入式系统的软件设计描述文档的半自动生成提供工具支持。

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.

软件设计说明是描述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.

Simulink Design Documenter的目的是为Simulink模型生成有用的软件设计描述文档实现高度自动化，从而显著减少文档工作。

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

更多精彩文章请关注公众号：